/
MergeEventObject.xml
45 lines (45 loc) · 3.86 KB
/
MergeEventObject.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
<Type Name="MergeEventObject" FullName="Microsoft.Office.Interop.InfoPath.SemiTrust.MergeEventObject">
<TypeSignature Language="C#" Value="public interface MergeEventObject : Microsoft.Office.Interop.InfoPath.SemiTrust.MergeEvent" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract MergeEventObject implements class Microsoft.Office.Interop.InfoPath.SemiTrust.DocEvent, class Microsoft.Office.Interop.InfoPath.SemiTrust.DocReturnEvent, class Microsoft.Office.Interop.InfoPath.SemiTrust.MergeEvent" />
<TypeSignature Language="DocId" Value="T:Microsoft.Office.Interop.InfoPath.SemiTrust.MergeEventObject" />
<TypeSignature Language="VB.NET" Value="Public Interface MergeEventObject
Implements MergeEvent" />
<TypeSignature Language="C++ CLI" Value="public interface class MergeEventObject : Microsoft::Office::Interop::InfoPath::SemiTrust::MergeEvent" />
<TypeSignature Language="F#" Value="type MergeEventObject = interface
 interface MergeEvent
 interface DocReturnEvent
 interface DocEvent" />
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.InfoPath.SemiTrust</AssemblyName>
<AssemblyVersion>11.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Office.Interop.InfoPath.SemiTrust.MergeEvent</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.CoClass(typeof(Microsoft.Office.Interop.InfoPath.SemiTrust.MergeEventObjectWrapper))</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.Guid("096cd67b-0786-11d1-95fa-0080c78ee3bb")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>An event object that is used during an <see cref="E:Microsoft.Office.Interop.InfoPath.SemiTrust._XDocumentEventSink2_Event.OnMergeRequest" /> event.</summary>
<remarks>
<para>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, see<see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.MergeEvent" />.</para>
<para>The <b>MergeEvent</b> object provides properties and methods that can be used during an <b>OnMergeRequest</b> event to programmatically interact with a form's underlying XML document and to determine merge properties such as the number of files being merged.</para>
<para>During a single merge forms operation, multiple <b>OnMergeRequest</b> events will occur. One <b>OnMergeRequest</b> event will occur for each file being merged.</para>
<para>The <b>MergeEvent</b> object is passed as a parameter to the <b>OnMergeRequest</b> event of an InfoPath form. The properties that it provides are available only during this event.</para>
<para />
</remarks>
<example>
<para>In the following example, the <see cref="P:Microsoft.Office.Interop.InfoPath.SemiTrust.MergeEvent.DOM" /> property and <see cref="P:Microsoft.Office.Interop.InfoPath.SemiTrust.MergeEvent.ReturnStatus" /> property of the <b>MergeEvent</b> object and the <see cref="M:Microsoft.Office.Interop.InfoPath.SemiTrust._XDocument2.ImportDOM(Microsoft.Office.Interop.InfoPath.SemiTrust.IXMLDOMDocument)" /> method of the <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.XDocument" /> object are used to import (merge) a form from the <see cref="E:Microsoft.Office.Interop.InfoPath.SemiTrust._XDocumentEventSink2_Event.OnMergeRequest" /> event handler:</para>
<code>[InfoPathEventHandler(EventType=InfoPathEventType.OnMergeRequest)]
public void OnMergeRequest(<span class="label">MergeEvent</span> e)
{
thisXDocument.ImportDOM(e.DOM);
e.ReturnStatus = true;
}</code>
</example>
</Docs>
<Members />
</Type>