Share via

  • Article

SqlStudioMessageBox.Show Method (IWin32Window, Exception, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, String)

Displays a message box in front of the specified object with the exception that is thrown when an error occurs during application execution. The message box has the specified caption, buttons, icon, default button, and uses the specified Help link.

Namespace:  Microsoft.SqlServer.Management.Controls
Assembly:  Microsoft.SqlServer.Management.Controls (in Microsoft.SqlServer.Management.Controls.dll)

Syntax

'Declaration
Public Shared Function Show ( _
    owner As IWin32Window, _
    error As Exception, _
    caption As String, _
    buttons As MessageBoxButtons, _
    icon As MessageBoxIcon, _
    defaultButton As MessageBoxDefaultButton, _
    helpLink As String _
) As DialogResult
'Usage
Dim owner As IWin32Window
Dim error As Exception
Dim caption As String
Dim buttons As MessageBoxButtons
Dim icon As MessageBoxIcon
Dim defaultButton As MessageBoxDefaultButton
Dim helpLink As String
Dim returnValue As DialogResult

returnValue = SqlStudioMessageBox.Show(owner, error, _
    caption, buttons, icon, defaultButton, _
    helpLink)

public static DialogResult Show(
    IWin32Window owner,
    Exception error,
    string caption,
    MessageBoxButtons buttons,
    MessageBoxIcon icon,
    MessageBoxDefaultButton defaultButton,
    string helpLink
)

public:
static DialogResult Show(
    IWin32Window^ owner, 
    Exception^ error, 
    String^ caption, 
    MessageBoxButtons buttons, 
    MessageBoxIcon icon, 
    MessageBoxDefaultButton defaultButton, 
    String^ helpLink
)

static member Show : 
        owner:IWin32Window * 
        error:Exception * 
        caption:string * 
        buttons:MessageBoxButtons * 
        icon:MessageBoxIcon * 
        defaultButton:MessageBoxDefaultButton * 
        helpLink:string -> DialogResult 

public static function Show(
    owner : IWin32Window, 
    error : Exception, 
    caption : String, 
    buttons : MessageBoxButtons, 
    icon : MessageBoxIcon, 
    defaultButton : MessageBoxDefaultButton, 
    helpLink : String
) : DialogResult

Parameters

  • error
    Type: System.Exception
    Represents an error that occurs during application execution.
  • caption
    Type: System.String
    The text to display in the title bar of the message box.
  • helpLink
    Type: System.String
    The path and name of the Help file to display when the user clicks the Help button.

Return Value

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