プラットフォーム組み込みコマンドの概要を説明します。
プラットフォーム組み込みコマンドについて、解説します。
プラットフォーム組み込みコマンドの概要を説明します。
プラットフォーム組み込みコマンドの名前空間URI参照は http://xmlns.xfytec.com/command です。 以下の説明で、プラットフォーム組み込みコマンドを記述するときは、command:という名前空間プレフィックスを使用します。
このほか、以下の説明中に出現する名前空間と、その名前空間に使用している名前空間プレフィックスは次のとおりです。
xvcd: を使用します。 詳細は、VC中核リファレンスをご覧ください。
instruction: を使用します。詳細は、プラットフォームコマンドインストラクションリファレンスをご覧ください。
プラットフォーム組み込みコマンドを、種類別に解説します。
ファイル系のコマンドは以下のとおりです。
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ユーザーエージェントのプロパティの設定によって決定されます。
パラメータはありません。
表示系のコマンドは以下のとおりです。
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 コマンド現在開いている文書のソーステキストを表示します。
パラメータはありません。
編集系のコマンドは以下のとおりです。
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が指定されたと見なされます。
ブックマーク系のコマンドは以下のとおりです。
command:add-bookmark コマンド現在開いている文書をブックマークに追加するコマンドです。
パラメータはありません。
command:remove-bookmark コマンド現在開いている文書をブックマークから削除するコマンドです。
パラメータはありません。
command:edit-bookmark コマンドブックマークを編集するコマンドです。
パラメータはありません。
ツール系のコマンドは以下のとおりです。
command:transformed-document-writer コマンド現在開いている文書がVCで変換されて表示されている場合、変換後の文書を保存するコマンドです。
このコマンドはxfy Developer's Toolkitを導入しているときに利用できます。
string command:save-url
変換後の文書の保存先をエンコード済みURLで設定します。
省略した場合、文書の保存先を選択するダイアログボックスが表示されます。
string command:document-type
保存形式を指定します。文字列で設定します。 htmlを設定した場合、保存形式はHTMLとなります。それ以外の文字列を設定した場合、保存形式はXMLとなります。
省略した場合、保存形式はXML形式となります。
その他のコマンドは以下のとおりです。
command:dialog-close コマンド