プラットフォーム組み込みコマンドリファレンス

プラットフォーム組み込みコマンドについて、解説します。

1. 概要

プラットフォーム組み込みコマンドの概要を説明します。

1.1. 用途・役割

プラットフォーム組み込みコマンドは、VCを実行するプラットフォームが提供するコマンドです。

プラットフォーム上では、プラグインを提供することでコマンドを追加できます。そのため、コマンド実行時には、コマンドを提供しているモジュールを識別する必要があります。コマンドを提供するモジュールを識別するために、名前空間を使用します。

XVCDにコマンドを記述するときは、そのコマンドが所属する名前空間を明示する必要があります。そのため、プラットフォームやプラグインで提供されるコマンドのコマンド名は、必ずQNameで記述します。 名前空間プレフィックスなしのコマンド名は、文書ローカルのコマンドが使用します。

1.2. 名前空間URI参照

プラットフォーム組み込みコマンドの名前空間URI参照は http://xmlns.xfytec.com/command です。 以下の説明で、プラットフォーム組み込みコマンドを記述するときは、command:という名前空間プレフィックスを使用します。

このほか、以下の説明中に出現する名前空間と、その名前空間に使用している名前空間プレフィックスは次のとおりです。

2. プラットフォーム組み込みコマンド

プラットフォーム組み込みコマンドを、種類別に解説します。

2.1. ファイル系コマンド

ファイル系のコマンドは以下のとおりです。

command:open コマンド

新しいウィンドウで文書を開くコマンドです。

パラメータ:
string command:url

読み込むファイルをエンコード済みURLで指定します。

省略した場合、読み込むファイルを選択するためのファイル選択ダイアログが表示されます。

command:reload コマンド

現在開いている文書を再読込するコマンドです。

パラメータ:
string command:encoding

文書のエンコード方式を指定します。エンコード方式を表す文字列を設定します。 値にdefaultを設定した場合、ファイルのMIMEタイプや文書の内容からエンコード方式が推測されます。

省略した場合、現在のエンコード方式で再読込が行われます。

command:save コマンド

現在開いている文書を保存するコマンドです。

パラメータ:
string command:save-as

名前をつけて保存するかどうかを指定します。文字列を設定します。"true"を設定した場合、ファイル選択ダイアログボックスを表示します。保存するときには、ファイル選択ダイアログボックスで指定されたファイル名で保存します。"false"を設定した場合、上書き保存します。

省略した場合、"false"が設定されたと見なされます。

command:close コマンド

ウィンドウを閉じるコマンドです。 ウィンドウを閉じるときに編集中で未保存の文書がある場合の動作は、xfy technologyユーザーエージェントのプロパティの設定によって決定されます。

パラメータ:

パラメータはありません。

command:exit コマンド

xfy technologyユーザーエージェントが開いているすべてのウィンドウを閉じ、xfy technologyユーザーエージェントを終了するコマンドです。ウィンドウを閉じるときに編集中で未保存の文書がある場合の動作は、xfy technologyユーザーエージェントのプロパティの設定によって決定されます。

パラメータ:

パラメータはありません。

2.2. 表示系コマンド

表示系のコマンドは以下のとおりです。

command:change-vocabulary コマンド

ビューをパラメータで指定されたボキャブラリサービスに変更するコマンドです。

変更するボキャブラリサービスはQNameもしくは名前空間URIとローカル名で指定します。すべてのパラメータが省略された場合、XML文書を開いたときに最初に表示されるボキャブラリサービスに変更されます。

パラメータ:
string command:vocabulary-name

使用するボキャブラリサービスを、ボキャブラリサービスが対象とするボキャブラリ名で指定します。QNameで指定します。指定された値がQNameでない場合は、文字列でボキャブラリのローカル名が指定されたと仮定して、ボキャブラリサービスを検索します。

省略した場合、値が指定されていないと見なされます。

string command:vocabulary-name-ns

ボキャブラリサービスが対象とするボキャブラリの名前空間URI参照を、URI文字列で指定します。

省略した場合、値が指定されていないと見なされます。

string command:vocabulary-name-local

ボキャブラリサービスが対象とするボキャブラリのローカル名を、文字列で指定します。

省略した場合、値が指定されていないと見なされます。

command:backward コマンド

リンクジャンプ前の文書に戻るコマンドです。

パラメータ:

パラメータはありません。

command:forward コマンド

リンクジャンプ前の文書に戻る前の文書に進むコマンドです。

パラメータ:

パラメータはありません。

command:upward コマンド

1階層上のディレクトリへ移動するコマンドです。

パラメータ:

パラメータはありません。

command:home コマンド

ホームページとして設定されている文書を表示するコマンドです。

パラメータ:

パラメータはありません。

command:source コマンド

現在開いている文書のソーステキストを表示します。

パラメータ:

パラメータはありません。

2.3. 編集系コマンド

編集系のコマンドは以下のとおりです。

command:undo コマンド

直前に行った編集操作を元に戻すコマンドです。

パラメータ:

パラメータはありません。

command:redo コマンド

直前の元に戻した編集操作を再実行するコマンドです。

パラメータ:

パラメータはありません。

command:move-point コマンド

パラメータで指定されたスクリーン座標へキャレットを移動するコマンドです。

パラメータ:
number command:screen-x

キャレットの移動先のx座標を指定します。 座標は、キャンバスの左上を(0,0)として指定します。

number command:screen-y

キャレットの移動先のy座標を指定します。 座標は、キャンバスの左上を(0,0)として指定します。

boolean command:selecting

範囲選択しながらキャレットを移動するか、範囲選択せずにキャレットを移動するかを指定します。真偽値を設定します。

true
範囲選択しながらキャレットを移動します。
false
範囲選択せずにキャレットを移動します。

省略した場合、falseが指定されたと見なされます。

command:move-right コマンド

キャレットを右方向へ移動するコマンドです。

パラメータ:
string command:unit

キャレットを移動する単位を指定します。次の文字列で指定します。

character
文字単位でキャレットを移動します。
word
単語単位でキャレットを移動します。
node
ノード単位でキャレットを移動します。

省略した場合、characterが指定されたと見なされます。

boolean command:selecting

範囲選択しながらキャレットを移動するか、範囲選択せずにキャレットを移動するかを指定します。真偽値を設定します。

true
範囲選択しながらキャレットを移動します。
false
範囲選択せずにキャレットを移動します。

省略した場合、falseが指定されたと見なされます。

command:move-left コマンド

キャレットを左方向へ移動するコマンドです。

パラメータ:
string command:unit

キャレットを移動する単位を指定します。次の文字列で指定します。

character
文字単位でキャレットを移動します。
word
単語単位でキャレットを移動します。
node
ノード単位でキャレットを移動します。

省略した場合、characterが指定されたと見なされます。

boolean command:selecting

範囲選択しながらキャレットを移動するか、範囲選択せずにキャレットを移動するかを指定します。真偽値を設定します。

true
範囲選択しながらキャレットを移動します。
false
範囲選択せずにキャレットを移動します。

省略した場合、falseが指定されたと見なされます。

command:move-up コマンド

キャレットを上方向へ移動するコマンドです。

パラメータ:
boolean command:selecting

範囲選択しながらキャレットを移動するか、範囲選択せずにキャレットを移動するかを指定します。真偽値を設定します。

true
範囲選択しながらキャレットを移動します。
false
範囲選択せずにキャレットを移動します。

省略した場合、falseが指定されたと見なされます。

command:move-down コマンド

キャレットを下方向へ移動するコマンドです。

パラメータ:
boolean command:selecting

範囲選択しながらキャレットを移動するか、範囲選択せずにキャレットを移動するかを指定します。真偽値を設定します。

true
範囲選択しながらキャレットを移動します。
false
範囲選択せずにキャレットを移動します。

省略した場合、falseが指定されたと見なされます。

command:move-home コマンド

キャレットを移動単位の先頭へ移動するコマンドです。

パラメータ:
string command:unit

キャレットを移動する単位を指定します。次の文字列で指定します。

character
文字単位でキャレットを移動します。
word
単語単位でキャレットを移動します。
node
ノード単位でキャレットを移動します。
line
行単位でキャレットを移動します。

省略した場合、characterが指定されたと見なされます。

boolean command:stop-home-end

現在のキャレット位置を含む移動単位の先頭で、キャレットを停止するかしないかを指定します。真偽値を設定します trueを指定すると、現在キャレットがある移動単位の先頭で停止します。

省略した場合、現在キャレットがある移動単位の1つ前の移動単位の先頭へ移動します。

boolean command:selecting

範囲選択しながらキャレットを移動するか、範囲選択せずにキャレットを移動するかを指定します。真偽値を設定します。

true
範囲選択しながらキャレットを移動します。
false
範囲選択せずにキャレットを移動します。

省略した場合、falseが指定されたと見なされます。

command:move-end コマンド

キャレットを移動単位の末尾へ移動するコマンドです。

パラメータ:
string command:unit

キャレットを移動する単位を指定します。次の文字列で指定します。

character
文字単位でキャレットを移動します。
word
単語単位でキャレットを移動します。
node
ノード単位でキャレットを移動します。
line
行単位でキャレットを移動します。

省略した場合、characterが指定されたと見なされます。

boolean command:stop-home-end

現在のキャレット位置を含む移動単位の末尾で、キャレットを停止するかしないかを指定します。真偽値を設定します trueを指定すると、現在キャレットがある移動単位の末尾で停止します。

省略した場合、現在キャレットがある移動単位の1つ先の移動単位の末尾へ移動します。

boolean command:selecting

範囲選択しながらキャレットを移動するか、範囲選択せずにキャレットを移動するかを指定します。真偽値を設定します。

true
範囲選択しながらキャレットを移動します。
false
範囲選択せずにキャレットを移動します。

省略した場合、falseが指定されたと見なされます。

command:select コマンド

キャレット位置のオブジェクトを選択するコマンドです。

パラメータ:
string command:unit

オブジェクトを選択する単位を指定します。次の文字列で指定します。

character
文字単位で選択します。
word
単語単位で選択します。
node
ノード単位で選択します。
line
行単位で選択します。

省略した場合、characterが指定されたと見なされます。

2.4. ブックマーク系コマンド

ブックマーク系のコマンドは以下のとおりです。

command:add-bookmark コマンド

現在開いている文書をブックマークに追加するコマンドです。

パラメータ:

パラメータはありません。

command:remove-bookmark コマンド

現在開いている文書をブックマークから削除するコマンドです。

パラメータ:

パラメータはありません。

command:edit-bookmark コマンド

ブックマークを編集するコマンドです。

パラメータ:

パラメータはありません。

2.5. ツール系コマンド

ツール系のコマンドは以下のとおりです。

command:transformed-document-writer コマンド

現在開いている文書がVCで変換されて表示されている場合、変換後の文書を保存するコマンドです。

このコマンドはxfy Developer's Toolkitを導入しているときに利用できます。

パラメータ:
string command:save-url

変換後の文書の保存先をエンコード済みURLで設定します。

省略した場合、文書の保存先を選択するダイアログボックスが表示されます。

string command:document-type

保存形式を指定します。文字列で設定します。 htmlを設定した場合、保存形式はHTMLとなります。それ以外の文字列を設定した場合、保存形式はXMLとなります。

省略した場合、保存形式はXML形式となります。

2.6. その他

その他のコマンドは以下のとおりです。

command:dialog-close コマンド

instruction:dialog で表示したダイアログボックスを閉じるコマンドです。ダイアログボックス以外では使用できません。

パラメータ:

パラメータはありません。

command:show-context-menu コマンド

文書の表示エリアの左上を(0,0)とした値で指定された座標へ、コンテキストメニューを表示するコマンドです。

ユーザーが文書の表示エリア上で右クリックなどのポップアップメニューを表示する操作をすると、このコマンドが呼び出されます。このコマンドを instruction:show-popupインストラクションを使用して上書き定義すると、動的なコンテキストメニューを実現できます。

パラメータ:
number command:x

コンテキストメニューを表示する位置を、コンテキストメニューの左上のx座標で指定します。 座標は、文書表示領域の左上からの相対位置で指定します。

number command:y

コンテキストメニューを表示する位置を、コンテキストメニューの左上のy座標で指定します。 座標は、文書表示領域の左上からの相対位置で指定します。