DocActionEventObject Interface
An event object that is used during a Microsoft InfoPath 2010 button click event.
Namespace: Microsoft.Office.Interop.InfoPath.SemiTrust
Assembly: Microsoft.Office.Interop.InfoPath.SemiTrust (in Microsoft.Office.Interop.InfoPath.SemiTrust.dll)
Syntax
'Declaration
<GuidAttribute("096cd63a-0786-11d1-95fa-0080c78ee3bb")> _
Public Interface DocActionEventObject _
Inherits DocActionEvent, DocReturnEvent, DocEvent
'Usage
Dim instance As DocActionEventObject
[GuidAttribute("096cd63a-0786-11d1-95fa-0080c78ee3bb")]
public interface DocActionEventObject : DocActionEvent,
DocReturnEvent, DocEvent
Remarks
This type is a wrapper for a coclass that is required by managed code for COM interoperability. Use this type to access the members of the COM interface implemented by this coclass. For information about the COM interface, including a link to descriptions of its members, seeDocActionEvent.
The DocActionEvent object provides a number of properties that can be used within a button click event to programmatically interact with the data in a form's underlying XML document and to control the success or failure of the event.
The DocActionEvent object is passed as a parameter to the OnClick event of a button that is contained in a view of an InfoPath form. Its properties are available only during the OnClick event.
Examples
In the following example, the Source property of the DocActionEvent object is used to display the source XML data of the inner-most XML Document Object Model (DOM) node of the form's underlying XML document, which contains the button:
[InfoPathEventHandler(MatchPath="ShowDocActionEventSource", EventType=InfoPathEventType.OnClick)]
public void ShowDocActionEventSource_OnClick(DocActionEvent e)
{
thisXDocument.UI.Alert("Source: " + e.Source.xml);
}