Export (0) Print
Expand All
Expand Minimize

MessageBox.Show Method (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, HelpNavigator, and Help topic.

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

'Declaration
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
Type: System.String

The text to display in the message box.

caption
Type: System.String

The text to display in the title bar of the message box.

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

One of the MessageBoxIcon values that specifies which icon to display in the message box.

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

One of the HelpNavigator values.

param
Type: System.Object

The numeric ID of the Help topic to display when the user clicks the Help button.

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.

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 Nothing. 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.

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.

Imports System
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. 
        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")

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft