VersionUpgradeEvent Object

Microsoft Office InfoPath

Show All Show All

VersionUpgradeEvent Object

VersionUpgradeEvent

An event object that is used during a Microsoft Office InfoPath 2003 version upgrade event. 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.

Remarks

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

Using the VersionUpgradeEvent object

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:

    function XDocument::OnVersionUpgrade(eventObj)
{
   XDocument.UI.Alert("The form version: " + eventObj.DocumentVersion +
      "\nThe form template version: " + eventObj.SolutionVersion);
   eventObj.ReturnStatus = true;
}
  

For more information about using the VersionUpgradeEvent object, see Responding to form events.