Export (0) Print
Expand All
Expand Minimize

MessageBox.Show Method (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 HelpNavigator.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public static DialogResult Show(
	IWin32Window owner,
	string text,
	string caption,
	MessageBoxButtons buttons,
	MessageBoxIcon icon,
	MessageBoxDefaultButton defaultButton,
	MessageBoxOptions options,
	string helpFilePath,
	HelpNavigator navigator
)

Parameters

owner
Type: System.Windows.Forms.IWin32Window
text
Type: System.String

The text to display in the message box.

caption
Type: System.String
buttons
Type: System.Windows.Forms.MessageBoxButtons

One of the MessageBoxButtons values that specifies which buttons to display in the message box.

icon
Type: System.Windows.Forms.MessageBoxIcon
defaultButton
Type: System.Windows.Forms.MessageBoxDefaultButton

One of the MessageBoxDefaultButton values that specifies the default button for the message box.

options
Type: System.Windows.Forms.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
Type: System.String

The path and name of the Help file to display when the user clicks the Help button.

navigator
Type: System.Windows.Forms.HelpNavigator

Return Value

Type: System.Windows.Forms.DialogResult
One of the DialogResult values.

ExceptionCondition
InvalidEnumArgumentException

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.

InvalidOperationException

An attempt was made to display the MessageBox in a process that is not running in User Interactive mode. This is specified by the SystemInformation.UserInteractive property.

ArgumentException

options specified both DefaultDesktopOnly and ServiceNotification.

-or-

buttons specified an invalid combination of MessageBoxButtons.

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.

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;
using System.Drawing;
using System.ComponentModel;
using 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.
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);

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft