v2.34
 
IAction Interface Reference

Represents a user interface command. More...

Inheritance diagram for IAction:

Properties

VARIANT_BOOL Checkable [get, set]
 The action checkable state.
 
VARIANT_BOOL Checked [get, set]
 The action checked state.
 
BSTR DisplayName [get, set]
 The localized text to display for the action.
 
VARIANT_BOOL Enabled [get, set]
 The action enable state.
 
IImage Icon [set]
 The action icon.
 
GUID Id [get]
 The unique identifier of the action.
 
BSTR ToolTip [get, set]
 The localized tooltip for the action.
 
VARIANT_BOOL Visible [get, set]
 The action visible state.
 

Detailed Description

Represents a user interface command.

Actions can be assigned to menu items, added to Tool Panels, Split Buttons or Drop-down Buttons to handle corresponding user interface control commands. They contain a display name, an icon, a tooltip and handlers for the trigger and toggle events.

See _IActionEvents for a list of supported events.

See also
IUI

Property Documentation

◆ Checkable

VARIANT_BOOL Checkable
getset

The action checkable state.

By default, the action is not checkable.

◆ Checked

VARIANT_BOOL Checked
getset

The action checked state.

By default, the action is not checked.

◆ Enabled

VARIANT_BOOL Enabled
getset

The action enable state.

By default, the action is enabled. Disabled actions cannot be triggered by the user. They still appear in menus and tool panels, but displayed in a way which indicates that they are unavailable.

◆ Visible

VARIANT_BOOL Visible
getset

The action visible state.

By default, the action is visible.