EditCommand

EditCommand

詳細

指定された Command をコマンドエディタで開きます。

コマンド エディタにはコマンド引数、コマンドが実装されているファイル名、バッチ モードで使用可能かどうかなどの有効な情報が表示されます。

コマンドエディタでは、XSIApplication.CreateCommand で作成したコマンドを編集できます。 ビルトイン コマンドや自己インストール コマンドは、エディタでは読み取り専用になります。 自己インストール コマンドを編集するには、コマンドのソース コード ファイルを開き、Init コールバックを編集する必要があります(「コマンドの定義コールバック」を参照)。

スクリプト構文

oReturn = EditCommand( CommandName );

戻り値

コマンドがキャンセルされた場合は True、それ以外の場合は False を戻します。

パラメータ

パラメータ タイプ 説明
CommandName 文字列 コマンドの SIObject.Name。 コマンド名とスクリプト名は異なります。 スクリプト名はスクリプトエディタでのコマンドの実行に使用される名前であり、コマンド名は XSIApplication.Commands コレクションのコマンドを識別する名前です。

JScript の例

// Look up the command by its scripting name.

// Tip: it is much faster to look up a command by its name.

var scriptingNameToFind = "RenderPass";

var oCommandCollection = Application.Commands;

var commandName = "";

for ( i = 0; i < oCommandCollection.Count ; i++ )

{

	var oCurrentCommand = oCommandCollection(i);

	if (scriptingNameToFind == oCurrentCommand.ScriptingName)

	{

		commandName = oCurrentCommand.Name;

	}

}

// if the command was found, open it in the command editor

if ("" != commandName)

{

	// This displays a dialog box with information

	// about the command

	EditCommand( commandName );

}

関連項目

Command Command.Update XSIApplication.CreateCommand