DocReturnEventObject Interface
An event object that is used during a Microsoft InfoPath 2010 load or submission event.
Namespace: Microsoft.Office.Interop.InfoPath.SemiTrust
Assembly: Microsoft.Office.Interop.InfoPath.SemiTrust (in Microsoft.Office.Interop.InfoPath.SemiTrust.dll)
Syntax
'Declaration
<GuidAttribute("096cd676-0786-11d1-95fa-0080c78ee3bb")> _
Public Interface DocReturnEventObject _
Inherits DocReturnEvent, DocEvent
'Usage
Dim instance As DocReturnEventObject
[GuidAttribute("096cd676-0786-11d1-95fa-0080c78ee3bb")]
public interface DocReturnEventObject : 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, seeDocReturnEvent.
The DocReturnEvent object provides the XDocument property that can be used within a load or submission event to programmatically interact with the data in a form's underlying XML document. It also provides the ReturnStatus property that is used to specify whether the event is successful.
The DocReturnEvent object is passed as a parameter to the OnLoad event and the OnSubmitRequest event of an InfoPath form. The properties that it provides are available only during these events.
Examples
In the following example, the XDocument property of the DocReturnEvent object is used to display the source XML of a form's underlying XML document using the DOM property of the XDocument object:
[InfoPathEventHandler(EventType=InfoPathEventType.OnLoad)]
public void OnLoad(DocReturnEvent e)
{
thisXDocument.UI.Alert("The source XML: " + e.XDocument.DOM.xml);
e.ReturnStatus = true;
}