Command.Description

Description

Returns or sets a descriptive String for the command. The description is typically used for describing a command in the Softimage user-interface such as the Customize Toolbar dialog.

C# Syntax

// get accessor

String rtn = Command.Description;

// set accessor

Command.Description = String;

Examples

VBScript Example

RemoveCommand "MyCommand" ' remove any instance of existing command

set cmd = Application.CreateCommand("MyCommand")

cmd.ScriptingName = "MyCommand"

cmd.Language = "VBScript"

cmd.Code = "LogMessage ""MyCommand invoked"""

cmd.description = "This is my very fine command"

Application.AddCommand cmd

LogMessage "Command description: " & cmd.description

' Result of the above script:

' INFO: "Command description: This is my very fine command"