VersionUpgradeEventObject Interface

Definition

public interface class VersionUpgradeEventObject : Microsoft::Office::Interop::InfoPath::SemiTrust::VersionUpgradeEvent

[System.Runtime.InteropServices.Guid("096cd614-0786-11d1-95fa-0080c78ee3bb")]
public interface VersionUpgradeEventObject : Microsoft.Office.Interop.InfoPath.SemiTrust.VersionUpgradeEvent

type VersionUpgradeEventObject = interface
    interface VersionUpgradeEvent
    interface DocReturnEvent
    interface DocEvent

Public Interface VersionUpgradeEventObject
Implements VersionUpgradeEvent

Attributes

GuidAttribute

Implements

VersionUpgradeEvent

Examples

In the following example, the DocumentVersion and SolutionVersion properties of the VersionUpgradeEvent object are used to display the version numbers of the form and form template:

[InfoPathEventHandler(EventType=InfoPathEventType.OnVersionUpgrade)]
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;   
}

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

The VersionUpgradeEvent 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.

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

Properties

Applies to