GetCommandState Method

Description

Gets the command state for builtin or custom command in specified location.

Syntax

Visual Basic
Public Function GetCommandState( _ ByVal command As Long, _ ByVal location As CommandLocation, _ ByVal includeBuiltInState As Boolean, _ ByVal includeScriptSpecifiedState As Boolean _ ) As CommandState

Visual Basic

Public Function GetCommandState( _
   ByVal command As Long, _
   ByVal location As CommandLocation, _
   ByVal includeBuiltInState As Boolean, _
   ByVal includeScriptSpecifiedState As Boolean _
) As CommandState

Parameters

command

The command id. Can be a builtin command enumerated value or custom command id.

location

Value	Description
CommandLocation_All	Refers to all locations.
CommandLocation_ContextMenu	Refers to the context menu and the Create button in the top pane.
CommandLocation_MainMenu	Refers to the menu bar. Press Alt to show the menu bar in M-Files Desktop.
CommandLocation_TaskPane	Refers to the task area.
CommandLocation_Undefined	Undefined value.

Detailed command location to examine. Possible locations are enumerated.

includeBuiltInState

If true, takes the built-in state of the command into account.

includeScriptSpecifiedState

If true, takes the script-specified state of the command into account.

Return Type

The command state.

Remarks

Supported in M-Files 10.0.3911.3 and newer.