Click or drag to resize

McCommand Properties

The McCommand type exposes the following members.

Properties
  NameDescription
Public propertyActive
Whether the command is active or not as part of a script.
Public propertyApplication
Public propertyAssemblyName
The name of the assembly containing the implementation of this command class.
Public propertyChecked
Public propertyCheckState
Gets or sets the state of a command with 3 checked states.
Public propertyClassName
The actual class name for this command.
Public propertyCommands
This is a list of all sub-commands that this compound command is made of.
Public propertyCommandVisible
Public propertyComment
Enter comments here.
Public propertyConfigFiles
Returns an array of configuration files paths that will be added to a project when this command is used in a macro.
Public propertyDefaultNameSpaces
The name space, which will be omitted using macro recording
Public propertyDescription
The command description.
Public propertyEmailResultsTo
Email address to notify when the command finishes.
Public propertyEnabled
Public propertyEngine
The engine where to run the command if EngineAffinity is to run in one engine, the last engine used otherwise.
Public propertyEngineAffinity
Allows to specify some engine affinity.
Public propertyException
The execption property is set when an error occurs during command processing.
Public propertyHasInteractiveParameters
Public propertyImage
Public propertyImageSmall
Public propertyImports
Returns the list of "Imports" statements needed in order to use this command in a macro.
Public propertyInteractionButtons
Public propertyInteractionLocation
Public propertyInteractionPanel
The key of the panel used for interactions if any.
Public propertyInteractionType
Whether to interact before or after the command executes.
Public propertyInteractive
This command will prompt the user before running.
Public propertyIsAsynchronous
Public propertyIsAuditable
Public propertyIsBackgroundBatchable
Public propertyIsBackgroundTask
Public propertyIsBatchable
Public propertyIsCompound
Returns True if this command is made of multiple child commands.
Public propertyIsExecuting
This property is true while the command is running (i.e. is in the executing the Run method).
Public propertyIsForegroundTask
Public propertyIsHidden
Public propertyIsInteracting
True while a command is interacting.
Public propertyIsInteractive
Public propertyIsLicensed
Public propertyIsLoading
Public propertyIsPartiallyLoaded
Returns True for commands that have their own implementation class and that are not fully loaded yet.
Public propertyIsReady
A command is ready to be processed when all its inputs are ready, that is none is locked or unavailable.
Public propertyIsRecordable
Public propertyIsScheduling
This property is true while the command is scheduling (i.e. is executing the Schedule method).
Public propertyIsScriptable
Public propertyLastThreadUsed
Returns the thread used in the last call to Execute.
Public propertyLineNumber
The source line number of the command when it is part of a script.
Public propertyManualStatus
Public propertyMe
Self reference
Public propertyName
The name of the command which is defined by its id in the ribbon file definition.
Public propertyParameters
A comma/space separated list of the base class properties that should be considered as parameters and therefore recorded.
Public propertyParent
Either Nothing or a compound command that contains this sub-command.
Public propertyPriority
Defines the priority of running this command when scheduled.
Public propertyPrompt
The string used as a prompt during interactions.
Public propertyRecordName
Enables delegation of command recording to a different command.
Public propertyReferences
Returns the list of assembly references needed in order to use this command in a macro.
Public propertyRoot
Returns the root of the command tree.
Public propertyScript
Returns the parent script if any.
Public propertySearchCategory
The search category.
Public propertySearchCommand
The command to run when activated from the search menu if not this one.
Public propertySearching
True when the command runs from a past search item.
Public propertySearchLast
Time when the item was last loaded, defaults to Date.MinValue.
Public propertySearchParameter
The property needing to be set prior to running the command, such as Filename.
Public propertySettings
Public propertyStatus
Public propertyStatusChanging
Is true while the command status is in the process of changing and the new value is being broadcast to event listeners.
Public propertyTag
Some user defined object associated to the command.
Public propertyTarget
The name of a category of objects targeted by the command
Public propertyText
Public propertyTextNoFormat
Public propertyThreadingBehavior
Defines the runtime thread affinity of this command.
Public propertyCode exampleUserCode
User code in macros.
Public propertyVariableName
The variable holding the command if any when it is part of a script.
Top
See Also