CreateCommand (XSIApplication)

Description

Defines a new custom command in Softimage. A new Command object is returned and can be used to define the command. This definition includes the location of the implementation (Command.FileName), and the arguments that command takes (ArgumentCollection.Add). After the definition of the command has been completed the XSIApplication.AddCommand method must be called to actually register the command in Softimage.

Note: The recommended way to create custom commands is to define them as part of a self-installed plug-in. See PluginRegistrar.RegisterCommand.

Scripting Syntax

XSIApplication.CreateCommand( Name, [Category] )

C# Syntax

Command XSIApplication.CreateCommand( String in_name, siCommandCategory in_category );

Parameters

Parameter

Type

Description

Name

String

The unique name identifying the new command.

Note: The command is not created if one with this name already exists.

Category

siCommandCategory

Where (on which Softimage standard menu) the command will appear in the user interface. For more information, see the siCommandCategory enum documentation.

Return Value

Command

See Also

XSIApplication.AddCommand

Command

ArgumentCollection

Argument

Examples

• See XSIApplication.CreateCommand.1.js



Autodesk Softimage 2011