/
VersionUpgradeEventObject.xml
44 lines (44 loc) · 3.36 KB
/
VersionUpgradeEventObject.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
<Type Name="VersionUpgradeEventObject" FullName="Microsoft.Office.Interop.InfoPath.VersionUpgradeEventObject">
<TypeSignature Language="C#" Value="public interface VersionUpgradeEventObject : Microsoft.Office.Interop.InfoPath.VersionUpgradeEvent" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract VersionUpgradeEventObject implements class Microsoft.Office.Interop.InfoPath.VersionUpgradeEvent" />
<TypeSignature Language="DocId" Value="T:Microsoft.Office.Interop.InfoPath.VersionUpgradeEventObject" />
<TypeSignature Language="VB.NET" Value="Public Interface VersionUpgradeEventObject
Implements VersionUpgradeEvent" />
<TypeSignature Language="C++ CLI" Value="public interface class VersionUpgradeEventObject : Microsoft::Office::Interop::InfoPath::VersionUpgradeEvent" />
<TypeSignature Language="F#" Value="type VersionUpgradeEventObject = interface
 interface VersionUpgradeEvent" />
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.InfoPath</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Office.Interop.InfoPath.VersionUpgradeEvent</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.CoClass(typeof(Microsoft.Office.Interop.InfoPath.VersionUpgradeEventObjectClass))</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.Guid("096CD614-0786-11D1-95FA-0080C78EE3BB")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>An event object that is used during a Microsoft Office InfoPath 2003 version upgrade 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.VersionUpgradeEvent" />.</para>
<para>The <b>VersionUpgradeEvent</b> object provides a number of properties that can be used within a version upgrade event to programmatically interact with a form's underlying XML document, determine the version numbers of the form and form template, and provide a response indicating the success of the version upgrade process.</para>
<para>The <b>VersionUpgradeEvent</b> object is passed as a parameter to <see cref="E:Microsoft.Office.Interop.InfoPath._XDocumentEventSink2_Event.OnVersionUpgrade" /> 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.VersionUpgradeEvent.DocumentVersion" /> and <see cref="P:Microsoft.Office.Interop.InfoPath.VersionUpgradeEvent.SolutionVersion" /> properties of the <b>VersionUpgradeEvent</b> object are used to display the version numbers of the form and form template:</para>
<code>public void OnVersionUpgrade(<span class="label">VersionUpgradeEvent</span> e)
{
thisXDocument.UI.Alert("The form version: " + e.DocumentVersion +
"\nThe form template version: " + e.SolutionVersion);
e.ReturnStatus = true;
}</code>
</example>
</Docs>
<Members />
</Type>