UIObject.xml

<Type Name="UIObject" FullName="Microsoft.Office.Interop.InfoPath.UIObject">
  <TypeSignature Language="C#" Value="public interface UIObject : Microsoft.Office.Interop.InfoPath.UI2" />
  <TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract UIObject implements class Microsoft.Office.Interop.InfoPath.UI2" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Office.Interop.InfoPath.UIObject" />
  <TypeSignature Language="VB.NET" Value="Public Interface UIObject&#xA;Implements UI2" />
  <TypeSignature Language="C++ CLI" Value="public interface class UIObject : Microsoft::Office::Interop::InfoPath::UI2" />
  <TypeSignature Language="F#" Value="type UIObject = interface&#xA;    interface UI2" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Office.Interop.InfoPath</AssemblyName>
    <AssemblyVersion>15.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Interfaces>
    <Interface>
      <InterfaceName>Microsoft.Office.Interop.InfoPath.UI2</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes>
    <Attribute>
      <AttributeName>System.Runtime.InteropServices.CoClass(typeof(Microsoft.Office.Interop.InfoPath.UIObjectClass))</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName>System.Runtime.InteropServices.Guid("096CD549-0786-11D1-95FA-0080C78EE3BB")</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Represents various user interface components that can be used in a Microsoft Office InfoPath form.</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.UI2" />.</para>
      <para>The <b>UIObject</b> (user interface) object provides a number of methods for displaying custom and built-in dialog boxes. </para>
      <para>The <b>UIObject</b> 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.</para>
      <para>The <b>UIObject</b> object is accessed through the <see cref="P:Microsoft.Office.Interop.InfoPath._XDocument2.UI" /> property of the <see cref="T:Microsoft.Office.Interop.InfoPath.XDocument" /> object.</para>
      <para>The <b>UIObject</b> object provides the <see cref="M:Microsoft.Office.Interop.InfoPath.UI.Alert(System.String)" /> method, which is used to display a simple message box with some custom text, as shown in the following example:</para>
      <code>thisXDocument.UI.Alert("Custom message text goes here.");
</code>
      <para>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 <see cref="M:Microsoft.Office.Interop.InfoPath.UI.ShowSignatureDialog" /> method, as follows:</para>
      <code>thisXDocument.UI.ShowSignatureDialog();
</code>
      <para>
        <b>Note</b>: The <b>ShowSignatureDialog</b> 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.</para>
      <para>For more information about using the <b>UIObject</b> object, see How to: Display Alerts and Dialog Boxes.</para>
      <para />
    </remarks>
  </Docs>
  <Members />
</Type>