Command_GetBooleanProperty()

Examples


The Command_GetBooleanProperty() function retrieves a specified boolean property for a command.

Syntax

Command_GetBooleanProperty(command_tag, property)

Parameters

command_tag – The integer tag value for the command whose property is being retrieved.

property – An integer constant indicating the property to retrieve. The value corresponds to one of the following constants:

[spacer]

Constant

Description

COMMAND_PROP_CHECKED

True if the command is checked in a menu. False if it is not.

COMMAND_PROP_DISABLED

True if the command is disabled. False if it is not.

COMMAND_PROP_HIDDEN

True if the command is hidden. False if it is not.

COMMAND_PROP_MENU_SHOW_IMAGE

True if the command is showing an image in the menu. False if it is not.

COMMAND_PROP_TOOLBAR_SHOW_IMAGE

True if the command is showing an image in a toolbar. False if it is not.

COMMAND_PROP_TOOLBAR_SHOW_TEXT

True if the command is showing text in the toolbar. False if it is not.


Return value

A boolean indicating how the property is set.


Documentation Feedback