McCommand Class |
|
An instance of a command to bind with ribbon controls.
Inheritance HierarchyNamespace: MediaCy.IQL.Application
Assembly: MediaCy.IQL.Application (in MediaCy.IQL.Application.dll) Version: 3.1.0.0
SyntaxVB
Public Class McCommand Implements ISerializable, IMessageFilter
The McCommand type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | McCommand | Initializes a new instance of the McCommand class |
| McCommand(String) | Initializes a new instance of the McCommand class |
| McCommand(String, Assembly, String) | Initializes a new instance of the McCommand class |
| McCommand(String, String, String) | Initializes a new instance of the McCommand class |
Properties| Name | Description | |
|---|---|---|
 | Active |
Whether the command is active or not as part of a script.
|
| Application | |
| AssemblyName |
The name of the assembly containing the implementation of this command class.
|
| Checked | |
| CheckState |
Gets or sets the state of a command with 3 checked states.
|
| ClassName |
The actual class name for this command.
|
| Commands |
This is a list of all sub-commands that this compound command is made of.
|
| CommandVisible | |
| Comment |
Enter comments here.
|
| ConfigFiles |
Returns an array of configuration files paths that will be added to a project when this command is used in a macro.
|
| DefaultNameSpaces |
The name space, which will be omitted using macro recording
|
| Description |
The command description.
|
| EmailResultsTo |
Email address to notify when the command finishes.
|
| Enabled | |
| Engine |
The engine where to run the command if EngineAffinity is to run in one engine, the last engine used otherwise.
|
| EngineAffinity |
Allows to specify some engine affinity.
|
| Exception |
The execption property is set when an error occurs during command processing.
|
| HasInteractiveParameters | |
| Image | |
| ImageSmall | |
| Imports |
Returns the list of "Imports" statements needed in order to use this command in a macro.
|
| InteractionButtons | |
| InteractionLocation | |
| InteractionPanel |
The key of the panel used for interactions if any.
|
| InteractionType |
Whether to interact before or after the command executes.
|
| Interactive |
This command will prompt the user before running.
|
| IsAsynchronous | |
| IsAuditable | |
| IsBackgroundBatchable | |
| IsBackgroundTask | |
| IsBatchable | |
| IsCompound |
Returns True if this command is made of multiple child commands.
|
| IsExecuting |
This property is true while the command is running (i.e. is in the executing the Run method).
|
| IsForegroundTask | |
| IsHidden | |
| IsInteracting |
True while a command is interacting.
|
| IsInteractive | |
| IsLicensed | |
| IsLoading | |
| IsPartiallyLoaded |
Returns True for commands that have their own implementation class and that are not fully loaded yet.
|
| IsReady |
A command is ready to be processed when all its inputs are ready, that is none is locked or unavailable.
|
| IsRecordable | |
| IsScheduling |
This property is true while the command is scheduling (i.e. is executing the Schedule method).
|
| IsScriptable | |
| LastThreadUsed |
Returns the thread used in the last call to Execute.
|
| LineNumber |
The source line number of the command when it is part of a script.
|
| ManualStatus | |
| Me |
Self reference
|
| Name |
The name of the command which is defined by its id in the ribbon file definition.
|
| Parameters |
A comma/space separated list of the base class properties that should be considered as parameters and therefore recorded.
|
| Parent |
Either Nothing or a compound command that contains this sub-command.
|
| Priority |
Defines the priority of running this command when scheduled.
|
| Prompt |
The string used as a prompt during interactions.
|
| RecordName |
Enables delegation of command recording to a different command.
|
| References |
Returns the list of assembly references needed in order to use this command in a macro.
|
| Root |
Returns the root of the command tree.
|
| Script |
Returns the parent script if any.
|
| SearchCategory |
The search category.
|
| SearchCommand |
The command to run when activated from the search menu if not this one.
|
| Searching |
True when the command runs from a past search item.
|
| SearchLast |
Time when the item was last loaded, defaults to Date.MinValue.
|
| SearchParameter |
The property needing to be set prior to running the command, such as Filename.
|
| Settings | |
| Status | |
| StatusChanging |
Is true while the command status is in the process of changing and the new value is being broadcast to event listeners.
|
| Tag |
Some user defined object associated to the command.
|
| Target |
The name of a category of objects targeted by the command
|
| Text | |
| TextNoFormat | |
| ThreadingBehavior |
Defines the runtime thread affinity of this command.
|
 | UserCode |
User code in macros.
|
| VariableName |
The variable holding the command if any when it is part of a script.
|
Methods| Name | Description | |
|---|---|---|
| Cancel |
Cancel this command and its sub-commands.
|
| ClearVariables |
Dispose of all references in script variables.
|
| Clone |
Create a copy of this command, and connect the Executed handler.
|
| Clone(McCommand) |
Create a copy of this command, and connect the Executed handler.
|
| Dispose |
Releases object references hold by inputs, outputs and children.
|
| EmailResults |
Email the result of this task to the address specified.
|
| Execute | |
| Execute(ICommandSource) | |
| Execute(Object) | |
 | FromName |
Returns the command registered with that name.
|
| Instantiate |
Instantiate commands that have an implementation class.
|
| IsAncestor |
Rertuns true if the parameter is the command or one of its ancestors.
|
| OnProcessMessages | |
| OnProgressChanged | |
| OnStatusChanged | |
| Post |
Post this command to run out of sequence, possibly in a different thead.
|
| Post(ThreadAffinity, TaskPriority) |
Post this command to run out of sequence, possibly in a differnt thead.
|
| Run |
Run the command in the same mode as its parent script if any.
|
| Schedule |
Schedule using my ThreadingBehavior and Priority.
|
| Schedule(ThreadAffinity, TaskPriority) |
Depending on its threading behavior and priority, Run will either display and execute immediately
simply display for potential later processing, or queue the command for background processing.
|
| ScheduleAndWait |
Run or queue the command and wait for it to finish.
|
| ScheduleAndWait(ThreadAffinity, TaskPriority) |
Run or queue the command and wait for it to finish.
|
| ValidateName |
Make sure the passed string uses the proper syntax and addresses potential issues
like the use of keywords in command names.
|
| WaitForCommandToFinish |
Sleeps until the command stops processing.
|
Events| Name | Description | |
|---|---|---|
 | Disposed | |
| Error |
This event is fired when an error occurs during command execution.
|
| Executed | |
| PreviewExecuted | |
| ProcessMessages |
Event sent when a background command checks for cancellation.
|
| ProgressChanged |
Event sent when a background command reports its progress.
|
| PropertyChanged | |
| Recording |
This event is fired before a command is recorded after its execution.
|
| SaveUndoState | |
| Scheduling | |
| StatusChanged |
Event sent in the main thread each time the command status changes.
|
Fields| Name | Description | |
|---|---|---|
 | Cloning |
True while a command is being cloned from its parent.
|
| LastFinished | |
| ProgressPercentage |
RemarksSee Also