Autodesk Vault ProfessionalVault API

ShowMessage(String,String,String,Action,Boolean) Method

Autodesk.DataManagement.Client.Framework.Forms›Library

Displays a message or error dialog box with the specified message and optionally, a link to launch help.

Syntax

public static System.Windows.Forms.DialogResult ShowMessage(
   System.string message,
   System.string title,
   System.string helpTopic,
   System.Action helpAction,
   System.bool isError
)
Public Overloads Shared Function ShowMessage( _
   ByVal message As System.String, _
   ByVal title As System.String, _
   ByVal helpTopic As System.String, _
   ByVal helpAction As System.Action, _
   ByVal isError As System.Boolean _
) As System.Windows.Forms.DialogResult

Parameters

NameDescription
messageThe message text to display in the dialog box.
titleThe Caption of the dialog box.
helpTopicHelp topic to be displayed as link text
helpActionA delegate that takes care of launching help
isErrorBool value indecating which dialog type to display, Error or Info

Return Value

The windows DialogResult which describes the button that was selected. The following chart shows the possible return codes for each button. Button Return Code "Abort", "Skip All" DialogResult.Abort "Cancel" DialogResult.Cancel "No" DialogResult.No "OK" DialogResult.OK "Retry" DialogResult.Retry "Skip" DialogResult.Ignore "Yes" DialogResult.Yes

See Also