UI Object

  • Article
InfoPath Developer Reference

Represents various user interface components that can be used in a Microsoft Office InfoPath 2007 form.

Version Information
 Version Added:  InfoPath 2003

Remarks

The UI (user interface) object provides a number of methods for displaying custom and built-in dialog boxes.

The UI object is used to programmatically display various types of dialog boxes to users as they fill out a form. It is not used for modifying the InfoPath user interface.

The UI object is accessed through the UI property of the XDocument object.

Bb229871.vs_note(en-us,office.12).gif  Note
The ShowSignatureDialog method can be used only in forms that have been enabled for digital signing. The method will return an error if used in a form that is not enabled for digital signing.

For more information about using the UI object, see Displaying alerts and dialog boxes.

Example

The UI object provides the Alert method, which is used to display a simple message box with some custom text, as shown in the following example:

JScript 
  XDocument.UI.Alert("Custom message text goes here.");

One of the built-in InfoPath dialog boxes that the UI object can display is the Digital Signatures dialog box; this dialog box can be displayed to the user by using the ShowSignatureDialog method, as follows:

JScript 
  XDocument.UI.ShowSignatureDialog();

See Also