Click or drag to resize

McBrushToolClassCommandFlags Property

Tool-specific flags to control and/or reflect the operation of the tool

Namespace:  MediaCy.IQL.Display.Overlays
Assembly:  MediaCy.IQL.Display.Overlays (in MediaCy.IQL.Display.Overlays.dll) Version: 10.0.6912.0
Syntax
VB
Copy
Public Overridable Property CommandFlags ( 
	Optional Mask As Integer = -1
) As Integer
	Get
	Set

Parameters

Mask (Optional)
Type: SystemInt32

Property Value

Type: Int32

Implements

IMcGraphToolServerCommandFlagsInt32
Remarks
The flag values, their interpretation and any action(s) that may be taken when new value(s) are assigned are almost completely tool-dependent. The Mask parameter on the property allows you to get or assign only selected bits of the 32-bit flags. When getting the value, the Mask is 0xffffffff (-1, mcctcfAll) by default, so all stored flag bits are returned unless you supply a different Mask argument. When setting the value, the Mask is 0 (mcctcfNone) by default, so that no flag bits are stored or changed during assignment unless you supply a different Mask. Storing no flags on assignment does not necessarily mean that no action is associated with the assignment. The tool is free to associate certain assigned values with calls for an action rather than calls for storing a flag value. Several flags are predefined. For example, 0x80000000 (mcctcfShutdown) is a standard "Action" flag that is alwasy sent to a tool before it is deselected or fully released. When received, the tool should abort any tool action, remove any graphic overlays and/or special cursors being displayed and shut down the tool. But it should not call SelectTool(NULL), as this will be done for it. Other standard action flags are used in conjunction with CommandData to set tool help information (see mcCommonToolCommandFlags). All of the standard CommandFlags are high bit positions. Custom tools should only use bits from 0x80000 on down to 0x00001.
See Also