Export (0) Print
Expand All

MessageBox.Show Method (IWin32Window, String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions)

.NET Framework 1.1

Displays a message box in front of the specified object and with the specified text, caption, buttons, icon, default button, and options.

[Visual Basic]
Overloads Public Shared Function Show( _
   ByVal owner As IWin32Window, _
   ByVal text As String, _
   ByVal caption As String, _
   ByVal buttons As MessageBoxButtons, _
   ByVal icon As MessageBoxIcon, _
   ByVal defaultButton As MessageBoxDefaultButton, _
   ByVal options As MessageBoxOptions _
) As DialogResult
[C#]
public static DialogResult Show(
 IWin32Window owner,
 string text,
 string caption,
 MessageBoxButtons buttons,
 MessageBoxIcon icon,
 MessageBoxDefaultButton defaultButton,
 MessageBoxOptions options
);
[C++]
public: static DialogResult Show(
 IWin32Window* owner,
 String* text,
 String* caption,
 MessageBoxButtons buttons,
 MessageBoxIcon icon,
 MessageBoxDefaultButton defaultButton,
 MessageBoxOptions options
);
[JScript]
public static function Show(
   owner : IWin32Window,
 text : String,
 caption : String,
 buttons : MessageBoxButtons,
 icon : MessageBoxIcon,
 defaultButton : MessageBoxDefaultButton,
 options : MessageBoxOptions
) : DialogResult;

Parameters

owner
The IWin32Window the message box will display in front of.
text
The text to display in the message box.
caption
The text to display in the title bar of the message box.
buttons
One of the MessageBoxButtons values that specifies which buttons to display in the message box.
icon
One of the MessageBoxIcon values that specifies which icon to display in the message box.
defaultButton
One of the MessageBoxDefaultButton values the specifies the default button for the message box.
options
One of the MessageBoxOptions values that specifies which display and association options will be used for the message box.

Return Value

One of the DialogResult values.

Exceptions

Exception Type Condition
InvalidEnumArgumentException buttons is not a member of MessageBoxButtons.

-or-

icon is not a member of MessageBoxIcon.

-or-

defaultButton is not a member of MessageBoxDefaultButton.

InvalidOperationException An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the SystemInformation.UserInteractive property.
ArgumentException options specified both DefaultDesktopOnly and ServiceNotification.

-or-

options specified DefaultDesktopOnly or ServiceNotification and specified a value in the owner parameter. These two options should be used only if you invoke the version of this method that does not take an owner parameter.

-or-

buttons specified an invalid combination of MessageBoxButtons.

Remarks

You can use the owner parameter to specify a particular object, which implements the IWin32Window interface, to place the message box in front of. A message box is a modal dialog, which means no input (keyboard or mouse click) can occur except to objects on the modal form. The program must hide or close a modal form (typically in response to some user action) before input to another form can occur.

You can have a maximum of three buttons on the message box.

Example

[Visual Basic, C#, C++] The following example demonstrates how to display a MessageBox with the options supported by this overload of Show. After verifying that a string variable, ServerName, is empty, the example displays a MessageBox, offering the user the option to cancel the operation. If the Show method's return value evaluates to Yes, the form that displayed the MessageBox is closed.

[Visual Basic] 
Private Sub ValidateUserEntry2()


    ' Checks the value of the text.

    If ServerName.Text.Length = 0 Then

        ' Initializes variables to pass to the MessageBox.Show method.

        Dim Message As String = "You did not enter a server name. Cancel this operation?"
        Dim Caption As String = "No Server Name Specified"
        Dim Buttons As Integer = MessageBoxButtons.YesNo

        Dim Result As DialogResult

        'Displays a MessageBox using the Question icon and specifying the No button as the default.

        Result = MessageBox.Show(Me, Message, Caption, MessageBoxButtons.YesNo, _
            MessageBoxIcon.Question, MessageBoxDefaultButton.Button1, MessageBoxOptions.RightAlign)


        ' Gets the result of the MessageBox display.

        If Result = DialogResult.Yes Then

            ' Closes the parent form.

            Me.Close()

        End If

    End If

End Sub

[C#] 

    private void validateUserEntry2()
    {

        // Checks the value of the text.

        if(serverName.Text.Length == 0)
        {

            // Initializes the variables to pass to the MessageBox.Show method.

            string message = "You did not enter a server name. Cancel this operation?";
            string caption = "No Server Name Specified";
            MessageBoxButtons buttons = MessageBoxButtons.YesNo;
            DialogResult result;

            // Displays the MessageBox.

            result = MessageBox.Show(this, message, caption, buttons,
                MessageBoxIcon.Question, MessageBoxDefaultButton.Button1, 
                MessageBoxOptions.RightAlign);

            if(result == DialogResult.Yes)
            {

                // Closes the parent form.

                this.Close();

            }

        }

    }


[C++] 
private:
    void validateUserEntry2() {
        // Checks the value of the text.
        if (serverName->Text->Length == 0) {

            // Initializes the variables to pass to the MessageBox::Show method.
            String* message = S"You did not enter a server name. Cancel this operation?";
            String* caption = S"No Server Name Specified";
            MessageBoxButtons buttons = MessageBoxButtons::YesNo;
            System::Windows::Forms::DialogResult result;

            // Displays the MessageBox.
            result = MessageBox::Show(this, message, caption, buttons,
                MessageBoxIcon::Question, MessageBoxDefaultButton::Button1, 
                MessageBoxOptions::RightAlign);

            if (result == DialogResult::Yes) {
                // Closes the parent form.
                this->Close();
            }
        }
    }

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

See Also

MessageBox Class | MessageBox Members | System.Windows.Forms Namespace | MessageBox.Show Overload List | MessageBoxButtons | MessageBoxIcon | MessageBoxDefaultButton | MessageBoxOptions

Show:
© 2014 Microsoft