Click or drag to resize

MacroCommandDescriptor Class

Descriptor object that holds the properties for an entry in the context menu of a plugin command
Inheritance Hierarchy

Namespace:  Articy.Api.Plugins
Assembly:  ArticyApp (in ArticyApp.dll) Version: 1.0.0
public class MacroCommandDescriptor

The MacroCommandDescriptor type exposes the following members.

Public propertyCanExecute
a callback to use to calculate the "enabled" state on a "live" basis
Public propertyCaptionLid
The Loca-Id or literal text of the caption text that appears in the context menu
Public propertyEnabled
The enabled state of the command, can be used if you prefer to show entries disabled rather than excluding the entry at all.
Public propertyExecute
The callback to use when the command is clicked
Public propertyIcon
The icon to be used for the entry if no icon is specified as part of the caption
Public propertyModifiesData
Should be set to true when the command modifies data
Public propertyRecordUndoRedo
Should be set to false if the command should (nor need) not to record undo-redo information
Public propertyTooltipLid
The Loca-Id or literal text of the ToolTip that is shown
Public propertyUserData
A user object to add custom data to the command, may be useful if several commands use the same Execute callback
See Also