SetCommandState Method

Description

Sets the command to be hidden, visible, enabled, or disabled. This method can have an effect on the context menu (and top pane), menu bar, task area, or all of them.

Syntax

Visual Basic
Public Sub SetCommandState( _ ByVal command As Long, _ ByVal location As CommandLocation, _ ByVal state As CommandState _ )

Parameters

command

The ID of the target command. The ID can represent a custom or a built-in command. The built-in commands are enumerated in BuiltinCommand.

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.

The location in the user interface. Use CommandLocation_All to to set the state in all locations.

state

Value	Description
CommandState_Active	The command is visible and it can be used.
CommandState_Hidden	The command is not visible.
CommandState_Inactive	The command is visible but it cannot be used.
CommandState_Undefined	Undefined value.

The state to set for the command.

Remarks

The application can limit the command availability but not extend it. For example, if the command is enabled by the M-Files platform, the application may hide or disable it. If the command is disabled by the platform, the application cannot enable it.
If the command is enabled in some locations, it can be invoked and the keyboard shortcuts are functional. If the command is disabled or hidden in all command locations, the keyboard shortcut also becomes inactive.
Supported in M-Files 9.0.3372.6 and newer.