CreateAndEditCommand
 
 
 

CreateAndEditCommand

Description

Opens the command editor so a user can interactively create a command.

Note: Use XSIApplication.CreateCommand to programmatically create a command without displaying any user interface.

Scripting Syntax

oReturn = CreateAndEditCommand();

Return Value

Returns true if the edit session was canceled, and false otherwise.

Examples

JScript Example

/*
        This example shows how to display the Command Editor to allow the
        user to create a command through the UI. If the user presses
        Cancel (fails to commit the changes), a warning message is logged:
        //WARNING : "Command creation aborted."
*/
var editCanceled = CreateAndEditCommand();
if (true == editCanceled)
{
        LogMessage( "Command creation aborted.", siWarning );
}

See Also

Command Command.Update XSIApplication.CreateCommand