MsgCfmCancel Method

Ask the user for action confirmation (with cancel) before proceeding with an action.

Syntax

Visual Basic
C#

'Declaration
 
Public Shared Function MsgCfmCancel( _
   ByVal strMsg As String _
) As DialogResult

'Usage
 
Dim strMsg As String
Dim value As DialogResult
 
value = Messaging.MsgCfmCancel(strMsg)

public static DialogResult MsgCfmCancel( 
   string strMsg
)

Parameters

strMsg: The proposed action to perform posed as a question to the user.

Return Value

Greater-than-zero if Yes button pressed, Zero if No button pressed, Less-than-zero if Cancel button pressed.

Remarks

This static method provides a general utility function to display a proposed action message to the user and obtain the user's confirmation before proceeding with the action. If the user agrees, then it is assumed he will press the Ok button which will cause this method to return a value >0. If the user does not want the action to take place, it is assumed he will press the No button which will cause this method to return a zero value. If the user does not want to proceed with either alternative, then he will press the Cancel button which will cause this method to return a value <0. Use this function to provide a standard look-and-feel for the program.

Requirements

Target Platforms: Windows XP SP3 (32-bit and 64-bit), Windows 7 (32-bit and 64-bit)

Not all Operating Systems are supported on all products. Visit the ArcFM Solution Supported Versions page for full details.

Reference

Messaging Class
Messaging Members