gui-cs.Terminal.Gui/ecmadocs/en/Terminal.Gui/MessageBox.xml

<Type Name="MessageBox" FullName="Terminal.Gui.MessageBox">
  <TypeSignature Language="C#" Value="public static class MessageBox" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit MessageBox extends System.Object" />
  <AssemblyInfo>
    <AssemblyName>Terminal.Gui</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Message box displays a modal message to the user, with a title, a message and a series of options that the user can choose from.
            </summary>
    <remarks>To be added.</remarks>
    <para>
              The difference between the Query and ErrorQuery method is the default set of colors used for the message box.
            </para>
    <para>
            The following example pops up a Message Box with 50 columns, and 7 lines, with the specified title and text, plus two buttons.
            The value -1 is returned when the user cancels the dialog by pressing the ESC key.
            </para>
    <example>
      <code lang="c#">
            var n = MessageBox.Query (50, 7, "Quit Demo", "Are you sure you want to quit this demo?", "Yes", "No");
            if (n == 0)
               quit = true;
            else
               quit = false;
            
            </code>
    </example>
  </Docs>
  <Members>
    <Member MemberName="ErrorQuery">
      <MemberSignature Language="C#" Value="public static int ErrorQuery (int width, int height, string title, string message, string[] buttons);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 ErrorQuery(int32 width, int32 height, string title, string message, string[] buttons) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="width" Type="System.Int32" />
        <Parameter Name="height" Type="System.Int32" />
        <Parameter Name="title" Type="System.String" />
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="buttons" Type="System.String[]">
          <Attributes>
            <Attribute>
              <AttributeName>System.ParamArray</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
      </Parameters>
      <Docs>
        <param name="width">Width for the window.</param>
        <param name="height">Height for the window.</param>
        <param name="title">Title for the query.</param>
        <param name="message">Message to display, might contain multiple lines..</param>
        <param name="buttons">Array of buttons to add.</param>
        <summary>
            Presents an error message box with the specified title and message and a list of buttons to show to the user.
            </summary>
        <returns>The index of the selected button, or -1 if the user pressed ESC to close the dialog.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Query">
      <MemberSignature Language="C#" Value="public static int Query (int width, int height, string title, string message, string[] buttons);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 Query(int32 width, int32 height, string title, string message, string[] buttons) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="width" Type="System.Int32" />
        <Parameter Name="height" Type="System.Int32" />
        <Parameter Name="title" Type="System.String" />
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="buttons" Type="System.String[]">
          <Attributes>
            <Attribute>
              <AttributeName>System.ParamArray</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
      </Parameters>
      <Docs>
        <param name="width">Width for the window.</param>
        <param name="height">Height for the window.</param>
        <param name="title">Title for the query.</param>
        <param name="message">Message to display, might contain multiple lines..</param>
        <param name="buttons">Array of buttons to add.</param>
        <summary>
            Presents a message with the specified title and message and a list of buttons to show to the user.
            </summary>
        <returns>The index of the selected button, or -1 if the user pressed ESC to close the dialog.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>