MergeEventObject Interface

Reference

Definition

Namespace:: Microsoft.Office.Interop.InfoPath

Assembly:: Microsoft.Office.Interop.InfoPath.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

An event object that is used during an OnMergeRequest event.

public interface class MergeEventObject : Microsoft::Office::Interop::InfoPath::MergeEvent

[System.Runtime.InteropServices.Guid("096CD67B-0786-11D1-95FA-0080C78EE3BB")]
public interface MergeEventObject : Microsoft.Office.Interop.InfoPath.MergeEvent

type MergeEventObject = interface
    interface MergeEvent

Public Interface MergeEventObject
Implements MergeEvent

Derived: Microsoft.Office.Interop.InfoPath.MergeEventObjectClass

Attributes: GuidAttribute

Implements: MergeEvent

Examples

In the following example, the DOM property and ReturnStatus property of the MergeEvent object and the ImportDOM(IXMLDOMDocument) method of the XDocument object are used to import (merge) a form from the OnMergeRequest event handler:

public void OnMergeRequest(<span class="label">MergeEvent</span> e)
{ 
 thisXDocument.ImportDOM(e.DOM);
 e.ReturnStatus = true;
}

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, seeMergeEvent.

The MergeEvent object provides properties and methods that can be used during an OnMergeRequest event to programmatically interact with a form's underlying XML document and to determine merge properties such as the number of files being merged.

During a single merge forms operation, multiple OnMergeRequest events will occur. One OnMergeRequest event will occur for each file being merged.

The MergeEvent object is passed as a parameter to the OnMergeRequest event of an InfoPath form. The properties that it provides are available only during this event.

Properties

Count	Gets the count of the number of forms being merged in a merging operation. (Inherited from MergeEvent)
DOM	Gets a form's underlying XML document as an XML Document Object Model (DOM) construction for the current form involved in a merging operation. (Inherited from MergeEvent)
index	Gets the zero-based index of the form that is currently being merged. (Inherited from MergeEvent)
ReturnStatus	Gets or sets a value indicating the return status of the OnMergeRequest event. (Inherited from MergeEvent)
RollBack	Gets or sets a value that provides additional information to the OnMergeRequest event along with the ReturnStatus flag, allowing the entire merging operation to be cancelled (Inherited from MergeEvent)
XDocument	Gets a reference to the _XDocument2 object that is associated with the MergeEvent object in an OnMergeRequest event. (Inherited from MergeEvent)

Applies to

Share via