MessageBox.Show Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Displays a message box.
Overloads
Show(String) |
Displays a message box with specified text. |
Show(IWin32Window, String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, String, String) |
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file and Help keyword. |
Show(String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, String, HelpNavigator, Object) |
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file, |
Show(IWin32Window, String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, String) |
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file. |
Show(String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, String, HelpNavigator) |
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file and |
Show(String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, String, String) |
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file and Help keyword. |
Show(IWin32Window, String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions) |
Displays a message box in front of the specified object and with the specified text, caption, buttons, icon, default button, and options. |
Show(String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, String) |
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file. |
Show(String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, Boolean) |
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button. |
Show(IWin32Window, String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, String, HelpNavigator) |
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file and |
Show(IWin32Window, String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton) |
Displays a message box in front of the specified object and with the specified text, caption, buttons, icon, and default button. |
Show(IWin32Window, String, String, MessageBoxButtons, MessageBoxIcon) |
Displays a message box in front of the specified object and with the specified text, caption, buttons, and icon. |
Show(String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton) |
Displays a message box with the specified text, caption, buttons, icon, and default button. |
Show(IWin32Window, String, String, MessageBoxButtons) |
Displays a message box in front of the specified object and with the specified text, caption, and buttons. |
Show(String, String, MessageBoxButtons, MessageBoxIcon) |
Displays a message box with specified text, caption, buttons, and icon. |
Show(IWin32Window, String, String) |
Displays a message box in front of the specified object and with the specified text and caption. |
Show(String, String, MessageBoxButtons) |
Displays a message box with specified text, caption, and buttons. |
Show(IWin32Window, String) |
Displays a message box in front of the specified object and with the specified text. |
Show(String, String) |
Displays a message box with specified text and caption. |
Show(String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions) |
Displays a message box with the specified text, caption, buttons, icon, default button, and options. |
Show(IWin32Window, String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, String, HelpNavigator, Object) |
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file, |
Show(String)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box with specified text.
public:
static System::Windows::Forms::DialogResult Show(System::String ^ text);
public static System.Windows.Forms.DialogResult Show (string text);
public static System.Windows.Forms.DialogResult Show (string? text);
static member Show : string -> System.Windows.Forms.DialogResult
Public Shared Function Show (text As String) As DialogResult
Parameters
- text
- String
The text to display in the message box.
Returns
One of the DialogResult values.
Examples
The following code example displays a simple message box.
private void DisplayMessageBoxText()
{
MessageBox.Show("Hello, world.");
}
Private Sub DisplayMessageBoxText()
MessageBox.Show("Hello, world.")
End Sub
Remarks
By default, the message box displays an OK button. The message box does not contain a caption in the title.
Applies to
Show(IWin32Window, String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, String, String)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file and Help keyword.
public:
static System::Windows::Forms::DialogResult Show(System::Windows::Forms::IWin32Window ^ owner, System::String ^ text, System::String ^ caption, System::Windows::Forms::MessageBoxButtons buttons, System::Windows::Forms::MessageBoxIcon icon, System::Windows::Forms::MessageBoxDefaultButton defaultButton, System::Windows::Forms::MessageBoxOptions options, System::String ^ helpFilePath, System::String ^ keyword);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window owner, string text, string caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options, string helpFilePath, string keyword);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window? owner, string? text, string? caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options, string helpFilePath, string keyword);
static member Show : System.Windows.Forms.IWin32Window * string * string * System.Windows.Forms.MessageBoxButtons * System.Windows.Forms.MessageBoxIcon * System.Windows.Forms.MessageBoxDefaultButton * System.Windows.Forms.MessageBoxOptions * string * string -> System.Windows.Forms.DialogResult
Public Shared Function Show (owner As IWin32Window, text As String, caption As String, buttons As MessageBoxButtons, icon As MessageBoxIcon, defaultButton As MessageBoxDefaultButton, options As MessageBoxOptions, helpFilePath As String, keyword As String) As DialogResult
Parameters
- owner
- IWin32Window
An implementation of IWin32Window that will own the modal dialog box.
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
- buttons
- MessageBoxButtons
One of the MessageBoxButtons values that specifies which buttons to display in the message box.
- icon
- MessageBoxIcon
One of the MessageBoxIcon values that specifies which icon to display in the message box.
- defaultButton
- MessageBoxDefaultButton
One of the MessageBoxDefaultButton values that specifies the default button for the message box.
- options
- MessageBoxOptions
One of the MessageBoxOptions values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults.
- helpFilePath
- String
The path and name of the Help file to display when the user clicks the Help button.
- keyword
- String
The Help keyword to display when the user clicks the Help button.
Returns
One of the DialogResult values.
Exceptions
buttons
is not a member of MessageBoxButtons.
-or-
icon
is not a member of MessageBoxIcon.
-or-
The defaultButton
specified is not a member of MessageBoxDefaultButton.
An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the UserInteractive property.
options
specified both DefaultDesktopOnly and ServiceNotification.
-or-
buttons
specified an invalid combination of MessageBoxButtons.
Examples
The following code example demonstrates how to show a message box parented to the main window. The message box displays a Help button. When the user clicks the Help button, the Mspaint.chm
Help file is opened and the topic identified by the mspaint.chm::/paint_brush.htm
keyword is displayed. The example requires that the Mspaint.chm
Help file is installed.
#using <System.dll>
#using <System.Windows.Forms.dll>
#using <System.Drawing.dll>
using namespace System;
using namespace System::Drawing;
using namespace System::ComponentModel;
using namespace System::Windows::Forms;
using System;
using System.Drawing;
using System.ComponentModel;
using System.Windows.Forms;
Imports System.Drawing
Imports System.ComponentModel
Imports System.Windows.Forms
// Display message box parented to the main form.
// The Help button opens the Mspaint.chm Help file,
// and the "mspaint.chm::/paint_brush.htm" Help keyword shows the
// associated topic.
System::Windows::Forms::DialogResult r8 = MessageBox::Show( this, "Message with Help file and keyword.", "Help Caption", MessageBoxButtons::OK, MessageBoxIcon::Question, MessageBoxDefaultButton::Button1, (MessageBoxOptions)0, "mspaint.chm", "mspaint.chm::/paint_brush.htm" );
// Display message box parented to the main form.
// The Help button opens the Mspaint.chm Help file,
// and the "mspaint.chm::/paint_brush.htm" Help keyword shows the
// associated topic.
DialogResult r8 = MessageBox.Show (this, "Message with Help file and keyword.",
"Help Caption", MessageBoxButtons.OK,
MessageBoxIcon.Question,
MessageBoxDefaultButton.Button1, 0,
"mspaint.chm",
"mspaint.chm::/paint_brush.htm");
' Display message box parented to the main form.
' The Help button opens the Mspaint.chm Help file,
' and the "mspaint.chm::/paint_brush.htm" Help keyword shows the
' associated topic.
Dim r8 As DialogResult = MessageBox.Show(Me, "Message with Help file and keyword.", _
"Help Caption", MessageBoxButtons.OK, _
MessageBoxIcon.Question, _
MessageBoxDefaultButton.Button1, 0, _
"mspaint.chm", _
"mspaint.chm::/paint_brush.htm")
Remarks
A message box is a modal dialog box, 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 use the owner
parameter to specify a particular object, which implements the IWin32Window interface, that will serve as the dialog box's top-level owner.
When the user clicks the Help button, the Help file specified in the helpFilePath
parameter is opened and the Help keyword topic identified by the keyword
parameter is displayed. The form that owns the message box (or the active form) also receives the HelpRequested event.
See also
Applies to
Show(String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, String, HelpNavigator, Object)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file, HelpNavigator
, and Help topic.
public:
static System::Windows::Forms::DialogResult Show(System::String ^ text, System::String ^ caption, System::Windows::Forms::MessageBoxButtons buttons, System::Windows::Forms::MessageBoxIcon icon, System::Windows::Forms::MessageBoxDefaultButton defaultButton, System::Windows::Forms::MessageBoxOptions options, System::String ^ helpFilePath, System::Windows::Forms::HelpNavigator navigator, System::Object ^ param);
public static System.Windows.Forms.DialogResult Show (string text, string caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options, string helpFilePath, System.Windows.Forms.HelpNavigator navigator, object param);
public static System.Windows.Forms.DialogResult Show (string? text, string? caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options, string helpFilePath, System.Windows.Forms.HelpNavigator navigator, object? param);
static member Show : string * string * System.Windows.Forms.MessageBoxButtons * System.Windows.Forms.MessageBoxIcon * System.Windows.Forms.MessageBoxDefaultButton * System.Windows.Forms.MessageBoxOptions * string * System.Windows.Forms.HelpNavigator * obj -> System.Windows.Forms.DialogResult
Public Shared Function Show (text As String, caption As String, buttons As MessageBoxButtons, icon As MessageBoxIcon, defaultButton As MessageBoxDefaultButton, options As MessageBoxOptions, helpFilePath As String, navigator As HelpNavigator, param As Object) As DialogResult
Parameters
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
- buttons
- MessageBoxButtons
One of the MessageBoxButtons values that specifies which buttons to display in the message box.
- icon
- MessageBoxIcon
One of the MessageBoxIcon values that specifies which icon to display in the message box.
- defaultButton
- MessageBoxDefaultButton
One of the MessageBoxDefaultButton values that specifies the default button for the message box.
- options
- MessageBoxOptions
One of the MessageBoxOptions values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults.
- helpFilePath
- String
The path and name of the Help file to display when the user clicks the Help button.
- navigator
- HelpNavigator
One of the HelpNavigator values.
- param
- Object
The numeric ID of the Help topic to display when the user clicks the Help button.
Returns
One of the DialogResult values.
Exceptions
buttons
is not a member of MessageBoxButtons.
-or-
icon
is not a member of MessageBoxIcon.
-or-
The defaultButton
specified is not a member of MessageBoxDefaultButton.
An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the UserInteractive property.
options
specified both DefaultDesktopOnly and ServiceNotification.
-or-
buttons
specified an invalid combination of MessageBoxButtons.
Examples
The following code example demonstrates how to show a message box with a Help button. When the user clicks the Help button, the Mspaint.chm
Help file is opened and the Help index tab and the topic identified by the ovals
keyword are displayed. The example requires that the Mspaint.chm
Help file is installed.
#using <System.dll>
#using <System.Windows.Forms.dll>
#using <System.Drawing.dll>
using namespace System;
using namespace System::Drawing;
using namespace System::ComponentModel;
using namespace System::Windows::Forms;
using System;
using System.Drawing;
using System.ComponentModel;
using System.Windows.Forms;
Imports System.Drawing
Imports System.ComponentModel
Imports System.Windows.Forms
// Display a message box. The Help button opens the Mspaint.chm Help file,
// shows index with the "ovals" keyword selected, and displays the
// associated topic.
System::Windows::Forms::DialogResult r5 = MessageBox::Show( "Message with Help file and Help navigator with additional parameter.", "Help Caption", MessageBoxButtons::OK, MessageBoxIcon::Question, MessageBoxDefaultButton::Button1, (MessageBoxOptions)0, "mspaint.chm", HelpNavigator::KeywordIndex, "ovals" );
// Display a message box. The Help button opens the Mspaint.chm Help file,
// shows index with the "ovals" keyword selected, and displays the
// associated topic.
DialogResult r5 = MessageBox.Show ("Message with Help file and Help navigator with additional parameter.",
"Help Caption", MessageBoxButtons.OK,
MessageBoxIcon.Question,
MessageBoxDefaultButton.Button1,
0, "mspaint.chm",
HelpNavigator.KeywordIndex, "ovals");
' Display a message box. The Help button opens the Mspaint.chm Help file,
' shows index with the "ovals" keyword selected, and displays the
' associated topic.
Dim r5 As DialogResult = MessageBox.Show("Message with Help file and Help navigator with additional parameter.", _
"Help Caption", MessageBoxButtons.OK, _
MessageBoxIcon.Question, _
MessageBoxDefaultButton.Button1, _
0, "mspaint.chm", _
HelpNavigator.KeywordIndex, "ovals")
Remarks
A message box is a modal dialog box, 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.
When the user clicks the Help button, the Help file specified in the helpFilePath
parameter is opened and the Help content identified by the navigator
parameter is displayed. The form that owns the message box (or the active form) also receives the HelpRequested event.
Compiled help files provide table of contents, index, search, and keyword links in pages. You can use the following values for navigator
: TableOfContents, Find, Index, or Topic.
You can use param
to provide further refinement of the Topic command. If the value specified in the navigator
parameter is TableOfContents, Index, or Find, this value should be null
. If the navigator
parameter references Topic, this value should reference an object that contains the numeric value of the topic to display.
The helpFilePath
parameter can be of the form C:\path\sample.chm or /folder/file.htm.
See also
Applies to
Show(IWin32Window, String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, String)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file.
public:
static System::Windows::Forms::DialogResult Show(System::Windows::Forms::IWin32Window ^ owner, System::String ^ text, System::String ^ caption, System::Windows::Forms::MessageBoxButtons buttons, System::Windows::Forms::MessageBoxIcon icon, System::Windows::Forms::MessageBoxDefaultButton defaultButton, System::Windows::Forms::MessageBoxOptions options, System::String ^ helpFilePath);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window owner, string text, string caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options, string helpFilePath);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window? owner, string? text, string? caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options, string helpFilePath);
static member Show : System.Windows.Forms.IWin32Window * string * string * System.Windows.Forms.MessageBoxButtons * System.Windows.Forms.MessageBoxIcon * System.Windows.Forms.MessageBoxDefaultButton * System.Windows.Forms.MessageBoxOptions * string -> System.Windows.Forms.DialogResult
Public Shared Function Show (owner As IWin32Window, text As String, caption As String, buttons As MessageBoxButtons, icon As MessageBoxIcon, defaultButton As MessageBoxDefaultButton, options As MessageBoxOptions, helpFilePath As String) As DialogResult
Parameters
- owner
- IWin32Window
An implementation of IWin32Window that will own the modal dialog box.
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
- buttons
- MessageBoxButtons
One of the MessageBoxButtons values that specifies which buttons to display in the message box.
- icon
- MessageBoxIcon
One of the MessageBoxIcon values that specifies which icon to display in the message box.
- defaultButton
- MessageBoxDefaultButton
One of the MessageBoxDefaultButton values that specifies the default button for the message box.
- options
- MessageBoxOptions
One of the MessageBoxOptions values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults.
- helpFilePath
- String
The path and name of the Help file to display when the user clicks the Help button.
Returns
One of the DialogResult values.
Exceptions
buttons
is not a member of MessageBoxButtons.
-or-
icon
is not a member of MessageBoxIcon.
-or-
The defaultButton
specified is not a member of MessageBoxDefaultButton.
An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the UserInteractive property.
options
specified both DefaultDesktopOnly and ServiceNotification.
-or-
buttons
specified an invalid combination of MessageBoxButtons.
Examples
The following code example demonstrates how to show a message box that parented to the main form. The message box displays a Help button. When the user clicks the Help button, the Mspaint.chm
Help file is opened. The example requires that the Mspaint.chm
Help file is installed.
#using <System.dll>
#using <System.Windows.Forms.dll>
#using <System.Drawing.dll>
using namespace System;
using namespace System::Drawing;
using namespace System::ComponentModel;
using namespace System::Windows::Forms;
using System;
using System.Drawing;
using System.ComponentModel;
using System.Windows.Forms;
Imports System.Drawing
Imports System.ComponentModel
Imports System.Windows.Forms
// Display a message box parented to the main form.
// The Help button opens the Mspaint.chm Help file.
System::Windows::Forms::DialogResult r2 = MessageBox::Show( this, "Message with Help file.", "Help Caption", MessageBoxButtons::OK, MessageBoxIcon::Question, MessageBoxDefaultButton::Button1, (MessageBoxOptions)0, "mspaint.chm" );
// Display a message box parented to the main form.
// The Help button opens the Mspaint.chm Help file.
DialogResult r2 = MessageBox.Show (this, "Message with Help file.",
"Help Caption", MessageBoxButtons.OK,
MessageBoxIcon.Question,
MessageBoxDefaultButton.Button1,
0,
"mspaint.chm");
' Display a message box parented to the main form.
' The Help button opens the Mspaint.chm Help file.
Dim r2 As DialogResult = MessageBox.Show(Me, "Message with Help file.", _
"Help Caption", MessageBoxButtons.OK, _
MessageBoxIcon.Question, _
MessageBoxDefaultButton.Button1, _
0, _
"mspaint.chm")
Remarks
A message box is a modal dialog box, 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 use the owner
parameter to specify a particular object, which implements the IWin32Window interface, that will serve as the dialog box's top-level window and owner.
When the user clicks the Help button, the Help file specified in the helpFilePath
parameter is opened. The form that owns the message box (or the active form) also receives the HelpRequested event.
The helpFilePath
parameter can be of the form C:\path\sample.chm or /folder/file.htm.
See also
Applies to
Show(String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, String, HelpNavigator)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file and HelpNavigator
.
public:
static System::Windows::Forms::DialogResult Show(System::String ^ text, System::String ^ caption, System::Windows::Forms::MessageBoxButtons buttons, System::Windows::Forms::MessageBoxIcon icon, System::Windows::Forms::MessageBoxDefaultButton defaultButton, System::Windows::Forms::MessageBoxOptions options, System::String ^ helpFilePath, System::Windows::Forms::HelpNavigator navigator);
public static System.Windows.Forms.DialogResult Show (string text, string caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options, string helpFilePath, System.Windows.Forms.HelpNavigator navigator);
public static System.Windows.Forms.DialogResult Show (string? text, string? caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options, string helpFilePath, System.Windows.Forms.HelpNavigator navigator);
static member Show : string * string * System.Windows.Forms.MessageBoxButtons * System.Windows.Forms.MessageBoxIcon * System.Windows.Forms.MessageBoxDefaultButton * System.Windows.Forms.MessageBoxOptions * string * System.Windows.Forms.HelpNavigator -> System.Windows.Forms.DialogResult
Public Shared Function Show (text As String, caption As String, buttons As MessageBoxButtons, icon As MessageBoxIcon, defaultButton As MessageBoxDefaultButton, options As MessageBoxOptions, helpFilePath As String, navigator As HelpNavigator) As DialogResult
Parameters
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
- buttons
- MessageBoxButtons
One of the MessageBoxButtons values that specifies which buttons to display in the message box.
- icon
- MessageBoxIcon
One of the MessageBoxIcon values that specifies which icon to display in the message box.
- defaultButton
- MessageBoxDefaultButton
One of the MessageBoxDefaultButton values that specifies the default button for the message box.
- options
- MessageBoxOptions
One of the MessageBoxOptions values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults.
- helpFilePath
- String
The path and name of the Help file to display when the user clicks the Help button.
- navigator
- HelpNavigator
One of the HelpNavigator values.
Returns
One of the DialogResult values.
Exceptions
buttons
is not a member of MessageBoxButtons.
-or-
icon
is not a member of MessageBoxIcon.
-or-
The defaultButton
specified is not a member of MessageBoxDefaultButton.
An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the UserInteractive property.
options
specified both DefaultDesktopOnly and ServiceNotification.
-or-
buttons
specified an invalid combination of MessageBoxButtons.
Examples
The following code example demonstrates how to show a message box with a Help button. When the user clicks the Help button, the Mspaint.chm
Help file is opened and the Help index tab is displayed. The example requires that the Mspaint.chm
Help file is installed.
#using <System.dll>
#using <System.Windows.Forms.dll>
#using <System.Drawing.dll>
using namespace System;
using namespace System::Drawing;
using namespace System::ComponentModel;
using namespace System::Windows::Forms;
using System;
using System.Drawing;
using System.ComponentModel;
using System.Windows.Forms;
Imports System.Drawing
Imports System.ComponentModel
Imports System.Windows.Forms
// Display a message box. The Help button opens
// the Mspaint.chm Help file and shows the Help contents
// on the Index tab.
System::Windows::Forms::DialogResult r3 = MessageBox::Show( "Message with Help file and Help navigator.", "Help Caption", MessageBoxButtons::OK, MessageBoxIcon::Question, MessageBoxDefaultButton::Button1, (MessageBoxOptions)0, "mspaint.chm", HelpNavigator::Index );
// Display a message box. The Help button opens
// the Mspaint.chm Help file and shows the Help contents
// on the Index tab.
DialogResult r3 = MessageBox.Show ("Message with Help file and Help navigator.",
"Help Caption", MessageBoxButtons.OK,
MessageBoxIcon.Question,
MessageBoxDefaultButton.Button1,
0, "mspaint.chm",
HelpNavigator.Index);
' Display a message box. The Help button opens
' the Mspaint.chm Help file and shows the Help contents
' on the Index tab.
Dim r3 As DialogResult = MessageBox.Show("Message with Help file and Help navigator.", _
"Help Caption", MessageBoxButtons.OK, _
MessageBoxIcon.Question, _
MessageBoxDefaultButton.Button1, _
0, "mspaint.chm", _
HelpNavigator.Index)
Remarks
A message box is a modal dialog box, 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.
When the user clicks the Help button, the help file specified in the helpFilePath
parameter is opened and the Help content identified by the navigator
parameter is displayed. The form that owns the message box (or the active form) also receives the HelpRequested event.
Compiled Help files provide table of contents, index, search, and keyword links in pages. You can use the following values for navigator
: TableOfContents, Find, Index, or Topic.
The helpFilePath
parameter can be of the form C:\path\sample.chm or /folder/file.htm.
See also
Applies to
Show(String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, String, String)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file and Help keyword.
public:
static System::Windows::Forms::DialogResult Show(System::String ^ text, System::String ^ caption, System::Windows::Forms::MessageBoxButtons buttons, System::Windows::Forms::MessageBoxIcon icon, System::Windows::Forms::MessageBoxDefaultButton defaultButton, System::Windows::Forms::MessageBoxOptions options, System::String ^ helpFilePath, System::String ^ keyword);
public static System.Windows.Forms.DialogResult Show (string text, string caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options, string helpFilePath, string keyword);
public static System.Windows.Forms.DialogResult Show (string? text, string? caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options, string helpFilePath, string keyword);
static member Show : string * string * System.Windows.Forms.MessageBoxButtons * System.Windows.Forms.MessageBoxIcon * System.Windows.Forms.MessageBoxDefaultButton * System.Windows.Forms.MessageBoxOptions * string * string -> System.Windows.Forms.DialogResult
Public Shared Function Show (text As String, caption As String, buttons As MessageBoxButtons, icon As MessageBoxIcon, defaultButton As MessageBoxDefaultButton, options As MessageBoxOptions, helpFilePath As String, keyword As String) As DialogResult
Parameters
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
- buttons
- MessageBoxButtons
One of the MessageBoxButtons values that specifies which buttons to display in the message box.
- icon
- MessageBoxIcon
One of the MessageBoxIcon values that specifies which icon to display in the message box.
- defaultButton
- MessageBoxDefaultButton
One of the MessageBoxDefaultButton values that specifies the default button for the message box.
- options
- MessageBoxOptions
One of the MessageBoxOptions values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults.
- helpFilePath
- String
The path and name of the Help file to display when the user clicks the Help button.
- keyword
- String
The Help keyword to display when the user clicks the Help button.
Returns
One of the DialogResult values.
Exceptions
buttons
is not a member of MessageBoxButtons.
-or-
icon
is not a member of MessageBoxIcon.
-or-
The defaultButton
specified is not a member of MessageBoxDefaultButton.
An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the UserInteractive property.
options
specified both DefaultDesktopOnly and ServiceNotification.
-or-
buttons
specified an invalid combination of MessageBoxButtons.
Examples
The following code example demonstrates how to show a message box with a Help button. When the user clicks the Help button, the Mspaint.chm
Help file is opened and the topic identified by the mspaint.chm::/paint_brush.htm
keyword is displayed. The example requires that the Mspaint.chm
Help file is installed.
#using <System.dll>
#using <System.Windows.Forms.dll>
#using <System.Drawing.dll>
using namespace System;
using namespace System::Drawing;
using namespace System::ComponentModel;
using namespace System::Windows::Forms;
using System;
using System.Drawing;
using System.ComponentModel;
using System.Windows.Forms;
Imports System.Drawing
Imports System.ComponentModel
Imports System.Windows.Forms
// Display a message box. The Help button opens the Mspaint.chm Help file,
// and the "mspaint.chm::/paint_brush.htm" Help keyword shows the
// associated topic.
System::Windows::Forms::DialogResult r7 = MessageBox::Show( "Message with Help file and keyword.", "Help Caption", MessageBoxButtons::OK, MessageBoxIcon::Question, MessageBoxDefaultButton::Button1, (MessageBoxOptions)0, "mspaint.chm", "mspaint.chm::/paint_brush.htm" );
// Display a message box. The Help button opens the Mspaint.chm Help file,
// and the "mspaint.chm::/paint_brush.htm" Help keyword shows the
// associated topic.
DialogResult r7 = MessageBox.Show ("Message with Help file and keyword.",
"Help Caption", MessageBoxButtons.OK,
MessageBoxIcon.Question,
MessageBoxDefaultButton.Button1, 0,
"mspaint.chm",
"mspaint.chm::/paint_brush.htm");
' Display a message box. The Help button opens the Mspaint.chm Help file,
' and the "mspaint.chm::/paint_brush.htm" Help keyword shows the
' associated topic.
Dim r7 As DialogResult = MessageBox.Show("Message with Help file and keyword.", _
"Help Caption", MessageBoxButtons.OK, _
MessageBoxIcon.Question, _
MessageBoxDefaultButton.Button1, 0, _
"mspaint.chm", _
"mspaint.chm::/paint_brush.htm")
Remarks
A message box is a modal dialog box, 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.
When the user clicks the Help button, the Help file specified in the helpFilePath
parameter is opened and the Help keyword topic identified by the keyword
parameter is displayed. The form that owns the message box (or the active form) also receives the HelpRequested event.
See also
Applies to
Show(IWin32Window, String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box in front of the specified object and with the specified text, caption, buttons, icon, default button, and options.
public:
static System::Windows::Forms::DialogResult Show(System::Windows::Forms::IWin32Window ^ owner, System::String ^ text, System::String ^ caption, System::Windows::Forms::MessageBoxButtons buttons, System::Windows::Forms::MessageBoxIcon icon, System::Windows::Forms::MessageBoxDefaultButton defaultButton, System::Windows::Forms::MessageBoxOptions options);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window owner, string text, string caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window? owner, string? text, string? caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options);
static member Show : System.Windows.Forms.IWin32Window * string * string * System.Windows.Forms.MessageBoxButtons * System.Windows.Forms.MessageBoxIcon * System.Windows.Forms.MessageBoxDefaultButton * System.Windows.Forms.MessageBoxOptions -> System.Windows.Forms.DialogResult
Public Shared Function Show (owner As IWin32Window, text As String, caption As String, buttons As MessageBoxButtons, icon As MessageBoxIcon, defaultButton As MessageBoxDefaultButton, options As MessageBoxOptions) As DialogResult
Parameters
- owner
- IWin32Window
An implementation of IWin32Window that will own the modal dialog box.
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
- buttons
- MessageBoxButtons
One of the MessageBoxButtons values that specifies which buttons to display in the message box.
- icon
- MessageBoxIcon
One of the MessageBoxIcon values that specifies which icon to display in the message box.
- defaultButton
- MessageBoxDefaultButton
One of the MessageBoxDefaultButton values the specifies the default button for the message box.
- options
- MessageBoxOptions
One of the MessageBoxOptions values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults.
Returns
One of the DialogResult values.
Exceptions
buttons
is not a member of MessageBoxButtons.
-or-
icon
is not a member of MessageBoxIcon.
-or-
defaultButton
is not a member of MessageBoxDefaultButton.
An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the UserInteractive property.
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.
Examples
The following code 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.
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;
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();
}
}
}
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();
}
}
}
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 = System.Windows.Forms.DialogResult.Yes Then
' Closes the parent form.
Me.Close()
End If
End If
End Sub
Remarks
You can use the owner
parameter to specify a particular object, which implements the IWin32Window interface, that will serve as the dialog box's top-level window and owner. A message box is a modal dialog box, 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.
See also
Applies to
Show(String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, String)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file.
public:
static System::Windows::Forms::DialogResult Show(System::String ^ text, System::String ^ caption, System::Windows::Forms::MessageBoxButtons buttons, System::Windows::Forms::MessageBoxIcon icon, System::Windows::Forms::MessageBoxDefaultButton defaultButton, System::Windows::Forms::MessageBoxOptions options, System::String ^ helpFilePath);
public static System.Windows.Forms.DialogResult Show (string text, string caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options, string helpFilePath);
public static System.Windows.Forms.DialogResult Show (string? text, string? caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options, string helpFilePath);
static member Show : string * string * System.Windows.Forms.MessageBoxButtons * System.Windows.Forms.MessageBoxIcon * System.Windows.Forms.MessageBoxDefaultButton * System.Windows.Forms.MessageBoxOptions * string -> System.Windows.Forms.DialogResult
Public Shared Function Show (text As String, caption As String, buttons As MessageBoxButtons, icon As MessageBoxIcon, defaultButton As MessageBoxDefaultButton, options As MessageBoxOptions, helpFilePath As String) As DialogResult
Parameters
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
- buttons
- MessageBoxButtons
One of the MessageBoxButtons values that specifies which buttons to display in the message box.
- icon
- MessageBoxIcon
One of the MessageBoxIcon values that specifies which icon to display in the message box.
- defaultButton
- MessageBoxDefaultButton
One of the MessageBoxDefaultButton values that specifies the default button for the message box.
- options
- MessageBoxOptions
One of the MessageBoxOptions values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults.
- helpFilePath
- String
The path and name of the Help file to display when the user clicks the Help button.
Returns
One of the DialogResult values.
Exceptions
buttons
is not a member of MessageBoxButtons.
-or-
icon
is not a member of MessageBoxIcon.
-or-
The defaultButton
specified is not a member of MessageBoxDefaultButton.
An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the UserInteractive property.
options
specified both DefaultDesktopOnly and ServiceNotification.
-or-
buttons
specified an invalid combination of MessageBoxButtons.
Examples
The following code example demonstrates how to show a message box with a Help button. When the user clicks the Help button, the Mspaint.chm
Help file is opened. The example requires that the Mspaint.chm
Help file is installed.
#using <System.dll>
#using <System.Windows.Forms.dll>
#using <System.Drawing.dll>
using namespace System;
using namespace System::Drawing;
using namespace System::ComponentModel;
using namespace System::Windows::Forms;
using System;
using System.Drawing;
using System.ComponentModel;
using System.Windows.Forms;
Imports System.Drawing
Imports System.ComponentModel
Imports System.Windows.Forms
// Display a message box with a help button.
// The Help button opens the Mspaint.chm Help file.
System::Windows::Forms::DialogResult r1 = MessageBox::Show( "Message with Help file.", "Help Caption", MessageBoxButtons::OK, MessageBoxIcon::Question, MessageBoxDefaultButton::Button1, (MessageBoxOptions)0, "mspaint.chm" );
// Display a message box with a help button.
// The Help button opens the Mspaint.chm Help file.
DialogResult r1 = MessageBox.Show ("Message with Help file.",
"Help Caption", MessageBoxButtons.OK,
MessageBoxIcon.Question,
MessageBoxDefaultButton.Button1,
0,
"mspaint.chm");
' Display a message box with a help button.
' The Help button opens the Mspaint.chm Help file.
Dim r1 As DialogResult = MessageBox.Show("Message with Help file.", _
"Help Caption", MessageBoxButtons.OK, _
MessageBoxIcon.Question, _
MessageBoxDefaultButton.Button1, _
0, _
"mspaint.chm")
Remarks
A message box is a modal dialog box, 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.
When the user clicks Help button, the Help file specified in the helpFilePath
parameter is opened. The form that owns the message box (or the active form) also receives the HelpRequested event.
The helpFilePath
parameter can be of the form C:\path\sample.chm or /folder/file.htm.
See also
Applies to
Show(String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, Boolean)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button.
public:
static System::Windows::Forms::DialogResult Show(System::String ^ text, System::String ^ caption, System::Windows::Forms::MessageBoxButtons buttons, System::Windows::Forms::MessageBoxIcon icon, System::Windows::Forms::MessageBoxDefaultButton defaultButton, System::Windows::Forms::MessageBoxOptions options, bool displayHelpButton);
public static System.Windows.Forms.DialogResult Show (string text, string caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options, bool displayHelpButton);
public static System.Windows.Forms.DialogResult Show (string? text, string? caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options, bool displayHelpButton);
static member Show : string * string * System.Windows.Forms.MessageBoxButtons * System.Windows.Forms.MessageBoxIcon * System.Windows.Forms.MessageBoxDefaultButton * System.Windows.Forms.MessageBoxOptions * bool -> System.Windows.Forms.DialogResult
Public Shared Function Show (text As String, caption As String, buttons As MessageBoxButtons, icon As MessageBoxIcon, defaultButton As MessageBoxDefaultButton, options As MessageBoxOptions, displayHelpButton As Boolean) As DialogResult
Parameters
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
- buttons
- MessageBoxButtons
One of the MessageBoxButtons values that specifies which buttons to display in the message box.
- icon
- MessageBoxIcon
One of the MessageBoxIcon values that specifies which icon to display in the message box.
- defaultButton
- MessageBoxDefaultButton
One of the MessageBoxDefaultButton values that specifies the default button for the message box.
- options
- MessageBoxOptions
One of the MessageBoxOptions values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults.
- displayHelpButton
- Boolean
true
to show the Help button; otherwise, false
. The default is false
.
Returns
One of the DialogResult values.
Exceptions
buttons
is not a member of MessageBoxButtons.
-or-
icon
is not a member of MessageBoxIcon.
-or-
The defaultButton
specified is not a member of MessageBoxDefaultButton.
An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the UserInteractive property.
options
specified both DefaultDesktopOnly and ServiceNotification.
-or-
buttons
specified an invalid combination of MessageBoxButtons.
Examples
The following code example demonstrates how to show a message box with a Help button, handle the Control.HelpRequested event, and show a custom help window in response to the event.
#using <System.dll>
#using <System.Windows.Forms.dll>
#using <System.Drawing.dll>
using namespace System;
using namespace System::Drawing;
using namespace System::ComponentModel;
using namespace System::Windows::Forms;
using System;
using System.Drawing;
using System.ComponentModel;
using System.Windows.Forms;
Imports System.Drawing
Imports System.ComponentModel
Imports System.Windows.Forms
// Display a message box with a Help button. Show a custom Help window
// by handling the HelpRequested event.
System::Windows::Forms::DialogResult AlertMessageWithCustomHelpWindow()
{
// Handle the HelpRequested event for the following message.
this->HelpRequested += gcnew System::Windows::Forms::HelpEventHandler( this, &Form1::Form1_HelpRequested );
this->Tag = "Message with Help button.";
// Show a message box with OK and Help buttons.
System::Windows::Forms::DialogResult r = MessageBox::Show( "Message with Help button.", "Help Caption", MessageBoxButtons::OK, MessageBoxIcon::Question, MessageBoxDefaultButton::Button1, (MessageBoxOptions)0, true );
// Remove the HelpRequested event handler to keep the event
// from being handled for other message boxes.
this->HelpRequested -= gcnew System::Windows::Forms::HelpEventHandler( this, &Form1::Form1_HelpRequested );
// Return the dialog box result.
return r;
}
void Form1_HelpRequested( System::Object^ sender, System::Windows::Forms::HelpEventArgs^ hlpevent )
{
// Create a custom Help window in response to the HelpRequested event.
Form^ helpForm = gcnew Form;
// Set up the form position, size, and title caption.
helpForm->StartPosition = FormStartPosition::Manual;
helpForm->Size = System::Drawing::Size( 200, 400 );
helpForm->DesktopLocation = Point(this->DesktopBounds.X + this->Size.Width,this->DesktopBounds.Top);
helpForm->Text = "Help Form";
// Create a label to contain the Help text.
Label^ helpLabel = gcnew Label;
// Add the label to the form and set its text.
helpForm->Controls->Add( helpLabel );
helpLabel->Dock = DockStyle::Fill;
// Use the sender parameter to identify the context of the Help request.
// The parameter must be cast to the Control type to get the Tag property.
Control^ senderControl = dynamic_cast<Control^>(sender);
helpLabel->Text = String::Format( "Help information shown in response to user action on the '{0}' message.", dynamic_cast<String^>(senderControl->Tag) );
// Set the Help form to be owned by the main form. This helps
// to ensure that the Help form is disposed of.
this->AddOwnedForm( helpForm );
// Show the custom Help window.
helpForm->Show();
// Indicate that the HelpRequested event is handled.
hlpevent->Handled = true;
}
// Display a message box with a Help button. Show a custom Help window
// by handling the HelpRequested event.
private DialogResult AlertMessageWithCustomHelpWindow ()
{
// Handle the HelpRequested event for the following message.
this.HelpRequested += new System.Windows.Forms.HelpEventHandler (this.Form1_HelpRequested);
this.Tag = "Message with Help button.";
// Show a message box with OK and Help buttons.
DialogResult r = MessageBox.Show ("Message with Help button.",
"Help Caption", MessageBoxButtons.OK,
MessageBoxIcon.Question,
MessageBoxDefaultButton.Button1,
0, true);
// Remove the HelpRequested event handler to keep the event
// from being handled for other message boxes.
this.HelpRequested -= new System.Windows.Forms.HelpEventHandler (this.Form1_HelpRequested);
// Return the dialog box result.
return r;
}
private void Form1_HelpRequested (System.Object sender, System.Windows.Forms.HelpEventArgs hlpevent)
{
// Create a custom Help window in response to the HelpRequested event.
Form helpForm = new Form ();
// Set up the form position, size, and title caption.
helpForm.StartPosition = FormStartPosition.Manual;
helpForm.Size = new Size (200, 400);
helpForm.DesktopLocation = new Point (this.DesktopBounds.X +
this.Size.Width,
this.DesktopBounds.Top);
helpForm.Text = "Help Form";
// Create a label to contain the Help text.
Label helpLabel = new Label ();
// Add the label to the form and set its text.
helpForm.Controls.Add (helpLabel);
helpLabel.Dock = DockStyle.Fill;
// Use the sender parameter to identify the context of the Help request.
// The parameter must be cast to the Control type to get the Tag property.
Control senderControl = sender as Control;
helpLabel.Text = "Help information shown in response to user action on the '" +
(string)senderControl.Tag + "' message.";
// Set the Help form to be owned by the main form. This helps
// to ensure that the Help form is disposed of.
this.AddOwnedForm (helpForm);
// Show the custom Help window.
helpForm.Show ();
// Indicate that the HelpRequested event is handled.
hlpevent.Handled = true;
}
' Display a message box with a Help button. Show a custom Help window
' by handling the HelpRequested event.
Private Function AlertMessageWithCustomHelpWindow() As DialogResult
' Handle the HelpRequested event for the following message.
AddHandler Me.HelpRequested, AddressOf Me.Form1_HelpRequested
Me.Tag = "Message with Help button."
' Show a message box with OK and Help buttons.
Dim r As DialogResult = MessageBox.Show("Message with Help button.", _
"Help Caption", MessageBoxButtons.OK, _
MessageBoxIcon.Question, _
MessageBoxDefaultButton.Button1, _
0, True)
' Remove the HelpRequested event handler to keep the event
' from being handled for other message boxes.
RemoveHandler Me.HelpRequested, AddressOf Me.Form1_HelpRequested
' Return the dialog box result.
Return r
End Function
Private Sub Form1_HelpRequested(ByVal sender As System.Object, ByVal hlpevent As System.Windows.Forms.HelpEventArgs)
' Create a custom Help window in response to the HelpRequested event.
Dim helpForm As Form = New Form
' Set up the form position, size, and title caption.
With helpForm
.StartPosition = FormStartPosition.Manual
.Size = New Size(200, 400)
.DesktopLocation = New Point(Me.DesktopBounds.X + _
Me.Size.Width, Me.DesktopBounds.Top)
.Text = "Help Form"
End With
' Create a label to contain the Help text.
Dim helpLabel As Label = New Label
' Add the label to the form and set its text.
helpForm.Controls.Add(helpLabel)
helpLabel.Dock = DockStyle.Fill
' Use the sender parameter to identify the context of the Help request.
' The parameter must be cast to the Control type to get the Tag property.
Dim senderControl As Control = CType(sender, Control)
helpLabel.Text = "Help information shown in response to user action on the '" & _
CStr(senderControl.Tag) & "' message."
' Set the Help form to be owned by the main form. This helps
' to ensure that the Help form is disposed of.
Me.AddOwnedForm(helpForm)
' Show the custom Help window.
helpForm.Show()
' Indicate that the HelpRequested event is handled.
hlpevent.Handled = True
End Sub
Remarks
A message box is a modal dialog box, 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.
When the user clicks the Help button, the form that owns the message box (or the active form) receives the HelpRequested event. Handle the HelpRequested event to perform custom Help actions.
See also
Applies to
Show(IWin32Window, String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, String, HelpNavigator)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file and HelpNavigator
.
public:
static System::Windows::Forms::DialogResult Show(System::Windows::Forms::IWin32Window ^ owner, System::String ^ text, System::String ^ caption, System::Windows::Forms::MessageBoxButtons buttons, System::Windows::Forms::MessageBoxIcon icon, System::Windows::Forms::MessageBoxDefaultButton defaultButton, System::Windows::Forms::MessageBoxOptions options, System::String ^ helpFilePath, System::Windows::Forms::HelpNavigator navigator);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window owner, string text, string caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options, string helpFilePath, System.Windows.Forms.HelpNavigator navigator);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window? owner, string? text, string? caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options, string helpFilePath, System.Windows.Forms.HelpNavigator navigator);
static member Show : System.Windows.Forms.IWin32Window * string * string * System.Windows.Forms.MessageBoxButtons * System.Windows.Forms.MessageBoxIcon * System.Windows.Forms.MessageBoxDefaultButton * System.Windows.Forms.MessageBoxOptions * string * System.Windows.Forms.HelpNavigator -> System.Windows.Forms.DialogResult
Public Shared Function Show (owner As IWin32Window, text As String, caption As String, buttons As MessageBoxButtons, icon As MessageBoxIcon, defaultButton As MessageBoxDefaultButton, options As MessageBoxOptions, helpFilePath As String, navigator As HelpNavigator) As DialogResult
Parameters
- owner
- IWin32Window
An implementation of IWin32Window that will own the modal dialog box.
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
- buttons
- MessageBoxButtons
One of the MessageBoxButtons values that specifies which buttons to display in the message box.
- icon
- MessageBoxIcon
One of the MessageBoxIcon values that specifies which icon to display in the message box.
- defaultButton
- MessageBoxDefaultButton
One of the MessageBoxDefaultButton values that specifies the default button for the message box.
- options
- MessageBoxOptions
One of the MessageBoxOptions values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults.
- helpFilePath
- String
The path and name of the Help file to display when the user clicks the Help button.
- navigator
- HelpNavigator
One of the HelpNavigator values.
Returns
One of the DialogResult values.
Exceptions
buttons
is not a member of MessageBoxButtons.
-or-
icon
is not a member of MessageBoxIcon.
-or-
The defaultButton
specified is not a member of MessageBoxDefaultButton.
An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the UserInteractive property.
options
specified both DefaultDesktopOnly and ServiceNotification.
-or-
buttons
specified an invalid combination of MessageBoxButtons.
Examples
The following code example demonstrates how to show a message box parented to the main window. The message box displays a Help button. When the user clicks the Help button, the Mspaint.chm
Help file is opened and the Help index tab is displayed. The example requires that the Mspaint.chm
Help file is installed.
#using <System.dll>
#using <System.Windows.Forms.dll>
#using <System.Drawing.dll>
using namespace System;
using namespace System::Drawing;
using namespace System::ComponentModel;
using namespace System::Windows::Forms;
using System;
using System.Drawing;
using System.ComponentModel;
using System.Windows.Forms;
Imports System.Drawing
Imports System.ComponentModel
Imports System.Windows.Forms
// Display message box parented to the main form.
// The Help button opens the Mspaint.chm Help file
// and shows the Help contents on the Index tab.
System::Windows::Forms::DialogResult r4 = MessageBox::Show( this, "Message with Help file and Help navigator.", "Help Caption", MessageBoxButtons::OK, MessageBoxIcon::Question, MessageBoxDefaultButton::Button1, (MessageBoxOptions)0, "mspaint.chm", HelpNavigator::Index );
// Display message box parented to the main form.
// The Help button opens the Mspaint.chm Help file
// and shows the Help contents on the Index tab.
DialogResult r4 = MessageBox.Show (this,
"Message with Help file and Help navigator.",
"Help Caption", MessageBoxButtons.OK,
MessageBoxIcon.Question,
MessageBoxDefaultButton.Button1,
0, "mspaint.chm",
HelpNavigator.Index);
' Display message box parented to the main form.
' The Help button opens the Mspaint.chm Help file
' and shows the Help contents on the Index tab.
Dim r4 As DialogResult = MessageBox.Show(Me, _
"Message with Help file and Help navigator.", _
"Help Caption", MessageBoxButtons.OK, _
MessageBoxIcon.Question, _
MessageBoxDefaultButton.Button1, _
0, "mspaint.chm", _
HelpNavigator.Index)
Remarks
A message box is a modal dialog box, 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 use the owner
parameter to specify a particular object, which implements the IWin32Window interface, that will serve as the dialog box's top-level window and owner.
When the user clicks the Help button, the Help file specified in the helpFilePath
parameter is opened and the Help content identified by the navigator
parameter is displayed. The form that owns the message box (or the active form) also receives the HelpRequested event.
Compiled Help files provide table of contents, index, search, and keyword links in pages. You can use the following values for navigator
: TableOfContents, Find, Index, or Topic.
The helpFilePath
parameter can be of the form C:\path\sample.chm or /folder/file.htm.
See also
Applies to
Show(IWin32Window, String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box in front of the specified object and with the specified text, caption, buttons, icon, and default button.
public:
static System::Windows::Forms::DialogResult Show(System::Windows::Forms::IWin32Window ^ owner, System::String ^ text, System::String ^ caption, System::Windows::Forms::MessageBoxButtons buttons, System::Windows::Forms::MessageBoxIcon icon, System::Windows::Forms::MessageBoxDefaultButton defaultButton);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window owner, string text, string caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window? owner, string? text, string? caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton);
static member Show : System.Windows.Forms.IWin32Window * string * string * System.Windows.Forms.MessageBoxButtons * System.Windows.Forms.MessageBoxIcon * System.Windows.Forms.MessageBoxDefaultButton -> System.Windows.Forms.DialogResult
Public Shared Function Show (owner As IWin32Window, text As String, caption As String, buttons As MessageBoxButtons, icon As MessageBoxIcon, defaultButton As MessageBoxDefaultButton) As DialogResult
Parameters
- owner
- IWin32Window
An implementation of IWin32Window that will own the modal dialog box.
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
- buttons
- MessageBoxButtons
One of the MessageBoxButtons values that specifies which buttons to display in the message box.
- icon
- MessageBoxIcon
One of the MessageBoxIcon values that specifies which icon to display in the message box.
- defaultButton
- MessageBoxDefaultButton
One of the MessageBoxDefaultButton values that specifies the default button for the message box.
Returns
One of the DialogResult values.
Exceptions
buttons
is not a member of MessageBoxButtons.
-or-
icon
is not a member of MessageBoxIcon.
-or-
defaultButton
is not a member of MessageBoxDefaultButton.
An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the UserInteractive property.
Examples
The following code 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.
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;
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();
}
}
}
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();
}
}
}
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 = System.Windows.Forms.DialogResult.Yes Then
' Closes the parent form.
Me.Close()
End If
End If
End Sub
Remarks
You can use the owner
parameter to specify a particular object, which implements the IWin32Window interface, that will serve as the dialog box's top-level window and owner. A message box is a modal dialog box, 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.
See also
Applies to
Show(IWin32Window, String, String, MessageBoxButtons, MessageBoxIcon)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box in front of the specified object and with the specified text, caption, buttons, and icon.
public:
static System::Windows::Forms::DialogResult Show(System::Windows::Forms::IWin32Window ^ owner, System::String ^ text, System::String ^ caption, System::Windows::Forms::MessageBoxButtons buttons, System::Windows::Forms::MessageBoxIcon icon);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window owner, string text, string caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window? owner, string? text, string? caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon);
static member Show : System.Windows.Forms.IWin32Window * string * string * System.Windows.Forms.MessageBoxButtons * System.Windows.Forms.MessageBoxIcon -> System.Windows.Forms.DialogResult
Public Shared Function Show (owner As IWin32Window, text As String, caption As String, buttons As MessageBoxButtons, icon As MessageBoxIcon) As DialogResult
Parameters
- owner
- IWin32Window
An implementation of IWin32Window that will own the modal dialog box.
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
- buttons
- MessageBoxButtons
One of the MessageBoxButtons values that specifies which buttons to display in the message box.
- icon
- MessageBoxIcon
One of the MessageBoxIcon values that specifies which icon to display in the message box.
Returns
One of the DialogResult values.
Exceptions
An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the UserInteractive property.
Examples
The following code 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.
private:
void validateUserEntry4()
{
// 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;
System::Windows::Forms::DialogResult result;
// Displays the MessageBox.
result = MessageBox::Show( this, message, caption, buttons, MessageBoxIcon::Question );
if ( result == ::DialogResult::Yes )
{
// Closes the parent form.
this->Close();
}
}
}
private void validateUserEntry4()
{
// 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);
if(result == DialogResult.Yes)
{
// Closes the parent form.
this.Close();
}
}
}
Private Sub ValidateUserEntry4()
' 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)
' Gets the result of the MessageBox display.
If Result = System.Windows.Forms.DialogResult.Yes Then
' Closes the parent form.
Me.Close()
End If
End If
End Sub
Remarks
You can use the owner
parameter to specify a particular object, which implements the IWin32Window interface, that will serve as the dialog box's top-level window and owner. A message box is a modal dialog box, 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.
See also
Applies to
Show(String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box with the specified text, caption, buttons, icon, and default button.
public:
static System::Windows::Forms::DialogResult Show(System::String ^ text, System::String ^ caption, System::Windows::Forms::MessageBoxButtons buttons, System::Windows::Forms::MessageBoxIcon icon, System::Windows::Forms::MessageBoxDefaultButton defaultButton);
public static System.Windows.Forms.DialogResult Show (string text, string caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton);
public static System.Windows.Forms.DialogResult Show (string? text, string? caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton);
static member Show : string * string * System.Windows.Forms.MessageBoxButtons * System.Windows.Forms.MessageBoxIcon * System.Windows.Forms.MessageBoxDefaultButton -> System.Windows.Forms.DialogResult
Public Shared Function Show (text As String, caption As String, buttons As MessageBoxButtons, icon As MessageBoxIcon, defaultButton As MessageBoxDefaultButton) As DialogResult
Parameters
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
- buttons
- MessageBoxButtons
One of the MessageBoxButtons values that specifies which buttons to display in the message box.
- icon
- MessageBoxIcon
One of the MessageBoxIcon values that specifies which icon to display in the message box.
- defaultButton
- MessageBoxDefaultButton
One of the MessageBoxDefaultButton values that specifies the default button for the message box.
Returns
One of the DialogResult values.
Exceptions
buttons
is not a member of MessageBoxButtons.
-or-
icon
is not a member of MessageBoxIcon.
-or-
defaultButton
is not a member of MessageBoxDefaultButton.
An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the UserInteractive property.
Examples
The following code 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 with a question box icon, 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.
private:
void validateUserEntry3()
{
// 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;
System::Windows::Forms::DialogResult result;
// Displays the MessageBox.
result = MessageBox::Show( this, message, caption, buttons, MessageBoxIcon::Question, MessageBoxDefaultButton::Button1 );
if ( result == ::DialogResult::Yes )
{
// Closes the parent form.
this->Close();
}
}
}
private void validateUserEntry3()
{
// 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);
if(result == DialogResult.Yes)
{
// Closes the parent form.
this.Close();
}
}
}
Private Sub ValidateUserEntry3()
' 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)
' Gets the result of the MessageBox display.
If Result = System.Windows.Forms.DialogResult.Yes Then
' Closes the parent form.
Me.Close()
End If
End If
End Sub
Remarks
You can have a maximum of three buttons on the message box.
See also
Applies to
Show(IWin32Window, String, String, MessageBoxButtons)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box in front of the specified object and with the specified text, caption, and buttons.
public:
static System::Windows::Forms::DialogResult Show(System::Windows::Forms::IWin32Window ^ owner, System::String ^ text, System::String ^ caption, System::Windows::Forms::MessageBoxButtons buttons);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window owner, string text, string caption, System.Windows.Forms.MessageBoxButtons buttons);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window? owner, string? text, string? caption, System.Windows.Forms.MessageBoxButtons buttons);
static member Show : System.Windows.Forms.IWin32Window * string * string * System.Windows.Forms.MessageBoxButtons -> System.Windows.Forms.DialogResult
Public Shared Function Show (owner As IWin32Window, text As String, caption As String, buttons As MessageBoxButtons) As DialogResult
Parameters
- owner
- IWin32Window
An implementation of IWin32Window that will own the modal dialog box.
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
- buttons
- MessageBoxButtons
One of the MessageBoxButtons values that specifies which buttons to display in the message box.
Returns
One of the DialogResult values.
Exceptions
buttons
is not a member of MessageBoxButtons.
An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the UserInteractive property.
Examples
The following code 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.
private:
void validateUserEntry5()
{
// 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;
System::Windows::Forms::DialogResult result;
// Displays the MessageBox.
result = MessageBox::Show( this, message, caption, buttons );
if ( result == ::DialogResult::Yes )
{
// Closes the parent form.
this->Close();
}
}
}
private void validateUserEntry5()
{
// 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);
if(result == DialogResult.Yes)
{
// Closes the parent form.
this.Close();
}
}
}
Private Sub ValidateUserEntry5()
' 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)
' Gets the result of the MessageBox display.
If Result = System.Windows.Forms.DialogResult.Yes Then
' Closes the parent form.
Me.Close()
End If
End If
End Sub
Remarks
You can use the owner
parameter to specify a particular object, which implements the IWin32Window interface, that will serve as the dialog box's top-level window and owner. A message box is a modal dialog box, 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.
See also
Applies to
Show(String, String, MessageBoxButtons, MessageBoxIcon)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box with specified text, caption, buttons, and icon.
public:
static System::Windows::Forms::DialogResult Show(System::String ^ text, System::String ^ caption, System::Windows::Forms::MessageBoxButtons buttons, System::Windows::Forms::MessageBoxIcon icon);
public static System.Windows.Forms.DialogResult Show (string text, string caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon);
public static System.Windows.Forms.DialogResult Show (string? text, string? caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon);
static member Show : string * string * System.Windows.Forms.MessageBoxButtons * System.Windows.Forms.MessageBoxIcon -> System.Windows.Forms.DialogResult
Public Shared Function Show (text As String, caption As String, buttons As MessageBoxButtons, icon As MessageBoxIcon) As DialogResult
Parameters
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
- buttons
- MessageBoxButtons
One of the MessageBoxButtons values that specifies which buttons to display in the message box.
- icon
- MessageBoxIcon
One of the MessageBoxIcon values that specifies which icon to display in the message box.
Returns
One of the DialogResult values.
Exceptions
The buttons
parameter specified is not a member of MessageBoxButtons.
-or-
The icon
parameter specified is not a member of MessageBoxIcon.
An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the UserInteractive property.
Examples
The following code example demonstrates one of the Show methods when handling the ComboBox.DropDown event. To run the example, paste the following code in a form and call the InitializeComboBox
method from the form's constructor or Load
method.
internal:
// Declare ComboBox1
System::Windows::Forms::ComboBox^ ComboBox1;
private:
// Initialize ComboBox1.
void InitializeComboBox()
{
this->ComboBox1 = gcnew ComboBox;
this->ComboBox1->Location = System::Drawing::Point( 128, 48 );
this->ComboBox1->Name = "ComboBox1";
this->ComboBox1->Size = System::Drawing::Size( 100, 21 );
this->ComboBox1->TabIndex = 0;
this->ComboBox1->Text = "Typical";
array<String^>^ installs = {"Typical","Compact","Custom"};
ComboBox1->Items->AddRange( installs );
this->Controls->Add( this->ComboBox1 );
// Hook up the event handler.
this->ComboBox1->DropDown += gcnew System::EventHandler(
this, &Form1::ComboBox1_DropDown );
}
// Handles the ComboBox1 DropDown event. If the user expands the
// drop-down box, a message box will appear, recommending the
// typical installation.
void ComboBox1_DropDown( Object^ sender, System::EventArgs^ e )
{
MessageBox::Show( "Typical installation is strongly recommended.",
"Install information", MessageBoxButtons::OK,
MessageBoxIcon::Information );
}
// Declare ComboBox1.
internal System.Windows.Forms.ComboBox ComboBox1;
// Initialize ComboBox1.
private void InitializeComboBox()
{
this.ComboBox1 = new ComboBox();
this.ComboBox1.Location = new System.Drawing.Point(128, 48);
this.ComboBox1.Name = "ComboBox1";
this.ComboBox1.Size = new System.Drawing.Size(100, 21);
this.ComboBox1.TabIndex = 0;
this.ComboBox1.Text = "Typical";
string[] installs = new string[]{"Typical", "Compact", "Custom"};
ComboBox1.Items.AddRange(installs);
this.Controls.Add(this.ComboBox1);
// Hook up the event handler.
this.ComboBox1.DropDown +=
new System.EventHandler(ComboBox1_DropDown);
}
// Handles the ComboBox1 DropDown event. If the user expands the
// drop-down box, a message box will appear, recommending the
// typical installation.
private void ComboBox1_DropDown(object sender, System.EventArgs e)
{
MessageBox.Show("Typical installation is strongly recommended.",
"Install information", MessageBoxButtons.OK,
MessageBoxIcon.Information);
}
' Declare ComboBox1.
Friend WithEvents ComboBox1 As System.Windows.Forms.ComboBox
' Initialize ComboBox1.
Private Sub InitializeComboBox()
Me.ComboBox1 = New ComboBox
Me.ComboBox1.Location = New System.Drawing.Point(128, 48)
Me.ComboBox1.Name = "ComboBox1"
Me.ComboBox1.Size = New System.Drawing.Size(100, 21)
Me.ComboBox1.TabIndex = 0
Me.ComboBox1.Text = "Typical"
Dim installs() As String = New String() _
{"Typical", "Compact", "Custom"}
ComboBox1.Items.AddRange(installs)
Me.Controls.Add(Me.ComboBox1)
End Sub
' Handles the ComboBox1 DropDown event. If the user expands the
' drop-down box, a message box will appear, recommending the
' typical installation.
Private Sub ComboBox1_DropDown _
(ByVal sender As Object, ByVal e As System.EventArgs) _
Handles ComboBox1.DropDown
MessageBox.Show("Typical installation is strongly recommended.", _
"Install information", MessageBoxButtons.OK, MessageBoxIcon.Information)
End Sub
Remarks
You can have a maximum of three buttons on the message box.
See also
Applies to
Show(IWin32Window, String, String)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box in front of the specified object and with the specified text and caption.
public:
static System::Windows::Forms::DialogResult Show(System::Windows::Forms::IWin32Window ^ owner, System::String ^ text, System::String ^ caption);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window owner, string text, string caption);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window? owner, string? text, string? caption);
static member Show : System.Windows.Forms.IWin32Window * string * string -> System.Windows.Forms.DialogResult
Public Shared Function Show (owner As IWin32Window, text As String, caption As String) As DialogResult
Parameters
- owner
- IWin32Window
An implementation of IWin32Window that will own the modal dialog box.
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
Returns
One of the DialogResult values.
Remarks
You can use the owner
parameter to specify a particular object, which implements the IWin32Window interface, that will serve as the dialog box's top-level window and owner. A message box is a modal dialog box, 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.
By default, the message box displays an OK button.
Applies to
Show(String, String, MessageBoxButtons)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box with specified text, caption, and buttons.
public:
static System::Windows::Forms::DialogResult Show(System::String ^ text, System::String ^ caption, System::Windows::Forms::MessageBoxButtons buttons);
public static System.Windows.Forms.DialogResult Show (string text, string caption, System.Windows.Forms.MessageBoxButtons buttons);
public static System.Windows.Forms.DialogResult Show (string? text, string? caption, System.Windows.Forms.MessageBoxButtons buttons);
static member Show : string * string * System.Windows.Forms.MessageBoxButtons -> System.Windows.Forms.DialogResult
Public Shared Function Show (text As String, caption As String, buttons As MessageBoxButtons) As DialogResult
Parameters
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
- buttons
- MessageBoxButtons
One of the MessageBoxButtons values that specifies which buttons to display in the message box.
Returns
One of the DialogResult values.
Exceptions
The buttons
parameter specified is not a member of MessageBoxButtons.
An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the UserInteractive property.
Examples
The following code 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.
private:
void validateUserEntry()
{
// 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;
System::Windows::Forms::DialogResult result;
// Displays the MessageBox.
result = MessageBox::Show( this, message, caption, buttons );
if ( result == ::DialogResult::Yes )
{
// Closes the parent form.
this->Close();
}
}
}
private void validateUserEntry()
{
// 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 = "Error Detected in Input";
MessageBoxButtons buttons = MessageBoxButtons.YesNo;
DialogResult result;
// Displays the MessageBox.
result = MessageBox.Show(message, caption, buttons);
if (result == System.Windows.Forms.DialogResult.Yes)
{
// Closes the parent form.
this.Close();
}
}
}
Private Sub ValidateUserEntry()
' 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 = "Error Detected in Input"
Dim Buttons As MessageBoxButtons = MessageBoxButtons.YesNo
Dim Result As DialogResult
'Displays the MessageBox
Result = MessageBox.Show(Message, Caption, Buttons)
' Gets the result of the MessageBox display.
If Result = System.Windows.Forms.DialogResult.Yes Then
' Closes the parent form.
Me.Close()
End If
End If
End Sub
Remarks
You can have a maximum of three buttons on the message box.
See also
Applies to
Show(IWin32Window, String)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box in front of the specified object and with the specified text.
public:
static System::Windows::Forms::DialogResult Show(System::Windows::Forms::IWin32Window ^ owner, System::String ^ text);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window owner, string text);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window? owner, string? text);
static member Show : System.Windows.Forms.IWin32Window * string -> System.Windows.Forms.DialogResult
Public Shared Function Show (owner As IWin32Window, text As String) As DialogResult
Parameters
- owner
- IWin32Window
An implementation of IWin32Window that will own the modal dialog box.
- text
- String
The text to display in the message box.
Returns
One of the DialogResult values.
Remarks
You can use the owner
parameter to specify a particular object, which implements the IWin32Window interface, that will serve as the dialog box's top-level window and owner. A message box is a modal dialog box, 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.
By default, the message box displays an OK button. The message box does not contain a caption in the title.
Applies to
Show(String, String)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box with specified text and caption.
public:
static System::Windows::Forms::DialogResult Show(System::String ^ text, System::String ^ caption);
public static System.Windows.Forms.DialogResult Show (string text, string caption);
public static System.Windows.Forms.DialogResult Show (string? text, string? caption);
static member Show : string * string -> System.Windows.Forms.DialogResult
Public Shared Function Show (text As String, caption As String) As DialogResult
Parameters
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
Returns
One of the DialogResult values.
Remarks
By default, the message box displays an OK button.
Applies to
Show(String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box with the specified text, caption, buttons, icon, default button, and options.
public:
static System::Windows::Forms::DialogResult Show(System::String ^ text, System::String ^ caption, System::Windows::Forms::MessageBoxButtons buttons, System::Windows::Forms::MessageBoxIcon icon, System::Windows::Forms::MessageBoxDefaultButton defaultButton, System::Windows::Forms::MessageBoxOptions options);
public static System.Windows.Forms.DialogResult Show (string text, string caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options);
public static System.Windows.Forms.DialogResult Show (string? text, string? caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options);
static member Show : string * string * System.Windows.Forms.MessageBoxButtons * System.Windows.Forms.MessageBoxIcon * System.Windows.Forms.MessageBoxDefaultButton * System.Windows.Forms.MessageBoxOptions -> System.Windows.Forms.DialogResult
Public Shared Function Show (text As String, caption As String, buttons As MessageBoxButtons, icon As MessageBoxIcon, defaultButton As MessageBoxDefaultButton, options As MessageBoxOptions) As DialogResult
Parameters
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
- buttons
- MessageBoxButtons
One of the MessageBoxButtons values that specifies which buttons to display in the message box.
- icon
- MessageBoxIcon
One of the MessageBoxIcon values that specifies which icon to display in the message box.
- defaultButton
- MessageBoxDefaultButton
One of the MessageBoxDefaultButton values that specifies the default button for the message box.
- options
- MessageBoxOptions
One of the MessageBoxOptions values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults.
Returns
One of the DialogResult values.
Exceptions
buttons
is not a member of MessageBoxButtons.
-or-
icon
is not a member of MessageBoxIcon.
-or-
The defaultButton
specified is not a member of MessageBoxDefaultButton.
An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the UserInteractive property.
options
specified both DefaultDesktopOnly and ServiceNotification.
-or-
buttons
specified an invalid combination of MessageBoxButtons.
Examples
The following code 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 with a question box icon, offering the user the option to cancel the operation. The example uses the RightAlign member of the MessageBoxOptions enumeration to align the text to the right edge of the dialog box. If the Show method's return value evaluates to Yes, the form that displayed the MessageBox is closed.
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;
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();
}
}
}
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();
}
}
}
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 = System.Windows.Forms.DialogResult.Yes Then
' Closes the parent form.
Me.Close()
End If
End If
End Sub
Remarks
You can have a maximum of three buttons on the message box.
See also
Applies to
Show(IWin32Window, String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, String, HelpNavigator, Object)
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
- Source:
- MessageBox.cs
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file, HelpNavigator
, and Help topic.
public:
static System::Windows::Forms::DialogResult Show(System::Windows::Forms::IWin32Window ^ owner, System::String ^ text, System::String ^ caption, System::Windows::Forms::MessageBoxButtons buttons, System::Windows::Forms::MessageBoxIcon icon, System::Windows::Forms::MessageBoxDefaultButton defaultButton, System::Windows::Forms::MessageBoxOptions options, System::String ^ helpFilePath, System::Windows::Forms::HelpNavigator navigator, System::Object ^ param);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window owner, string text, string caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options, string helpFilePath, System.Windows.Forms.HelpNavigator navigator, object param);
public static System.Windows.Forms.DialogResult Show (System.Windows.Forms.IWin32Window? owner, string? text, string? caption, System.Windows.Forms.MessageBoxButtons buttons, System.Windows.Forms.MessageBoxIcon icon, System.Windows.Forms.MessageBoxDefaultButton defaultButton, System.Windows.Forms.MessageBoxOptions options, string helpFilePath, System.Windows.Forms.HelpNavigator navigator, object? param);
static member Show : System.Windows.Forms.IWin32Window * string * string * System.Windows.Forms.MessageBoxButtons * System.Windows.Forms.MessageBoxIcon * System.Windows.Forms.MessageBoxDefaultButton * System.Windows.Forms.MessageBoxOptions * string * System.Windows.Forms.HelpNavigator * obj -> System.Windows.Forms.DialogResult
Public Shared Function Show (owner As IWin32Window, text As String, caption As String, buttons As MessageBoxButtons, icon As MessageBoxIcon, defaultButton As MessageBoxDefaultButton, options As MessageBoxOptions, helpFilePath As String, navigator As HelpNavigator, param As Object) As DialogResult
Parameters
- owner
- IWin32Window
An implementation of IWin32Window that will own the modal dialog box.
- text
- String
The text to display in the message box.
- caption
- String
The text to display in the title bar of the message box.
- buttons
- MessageBoxButtons
One of the MessageBoxButtons values that specifies which buttons to display in the message box.
- icon
- MessageBoxIcon
One of the MessageBoxIcon values that specifies which icon to display in the message box.
- defaultButton
- MessageBoxDefaultButton
One of the MessageBoxDefaultButton values that specifies the default button for the message box.
- options
- MessageBoxOptions
One of the MessageBoxOptions values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults.
- helpFilePath
- String
The path and name of the Help file to display when the user clicks the Help button.
- navigator
- HelpNavigator
One of the HelpNavigator values.
- param
- Object
The numeric ID of the Help topic to display when the user clicks the Help button.
Returns
One of the DialogResult values.
Exceptions
buttons
is not a member of MessageBoxButtons.
-or-
icon
is not a member of MessageBoxIcon.
-or-
The defaultButton
specified is not a member of MessageBoxDefaultButton.
An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the UserInteractive property.
options
specified both DefaultDesktopOnly and ServiceNotification.
-or-
buttons
specified an invalid combination of MessageBoxButtons.
Examples
The following code example demonstrates how to show a message box parented to the main window. The message box displays a Help button. When the user clicks the Help button, the Mspaint.chm
Help file is opened and the Help index tab and the topic identified by the ovals
keyword are displayed. The example requires that the Mspaint.chm
Help file is installed.
#using <System.dll>
#using <System.Windows.Forms.dll>
#using <System.Drawing.dll>
using namespace System;
using namespace System::Drawing;
using namespace System::ComponentModel;
using namespace System::Windows::Forms;
using System;
using System.Drawing;
using System.ComponentModel;
using System.Windows.Forms;
Imports System.Drawing
Imports System.ComponentModel
Imports System.Windows.Forms
// Display message box parented to the main form.
// The Help button opens the Mspaint.chm Help file,
// shows index with the "ovals" keyword selected, and displays the
// associated topic.
System::Windows::Forms::DialogResult r6 = MessageBox::Show( this, "Message with Help file and Help navigator with additional parameter.", "Help Caption", MessageBoxButtons::OK, MessageBoxIcon::Question, MessageBoxDefaultButton::Button1, (MessageBoxOptions)0, "mspaint.chm", HelpNavigator::KeywordIndex, "ovals" );
// Display message box parented to the main form.
// The Help button opens the Mspaint.chm Help file,
// shows index with the "ovals" keyword selected, and displays the
// associated topic.
DialogResult r6 = MessageBox.Show (this,
"Message with Help file and Help navigator with additional parameter.",
"Help Caption", MessageBoxButtons.OK,
MessageBoxIcon.Question,
MessageBoxDefaultButton.Button1,
0, "mspaint.chm",
HelpNavigator.KeywordIndex, "ovals");
' Display message box parented to the main form.
' The Help button opens the Mspaint.chm Help file,
' shows index with the "ovals" keyword selected, and displays the
' associated topic.
Dim r6 As DialogResult = MessageBox.Show(Me, _
"Message with Help file and Help navigator with additional parameter.", _
"Help Caption", MessageBoxButtons.OK, _
MessageBoxIcon.Question, _
MessageBoxDefaultButton.Button1, _
0, "mspaint.chm", _
HelpNavigator.KeywordIndex, "ovals")
Remarks
A message box is a modal dialog box, 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 use the owner
parameter to specify a particular object, which implements the IWin32Window interface, that will serve as the dialog box's top-level window and owner.
When the user clicks the Help button, the Help file specified in the helpFilePath
parameter is opened and the Help content identified by the navigator
parameter is displayed. The form that owns the message box (or the active form) also receives the HelpRequested event.
Compiled help files provide table of contents, index, search, and keyword links in pages. You can use the following values for navigator
: TableOfContents, Find, Index, or Topic.
You can use param
to provide further refinement of the Topic command. If the value specified in the navigator
parameter is TableOfContents, Index, or Find, this value should be null
. If the navigator
parameter references Topic, this value should reference an object that contains the numeric value of the topic to display.
The helpFilePath
parameter can be of the form C:\path\sample.chm or /folder/file.htm.