[ヘルプTop]　[戻る]

スクリプトコマンドリファレンス

　使用可能なコマンドを簡単な説明とともに列挙します。
　このページは、こういった機能があるということを把握するためのページなので、使い方や詳細な動作は各コマンドの説明を参照してください。

コマンド実行系のコマンド

基本コマンド
コマンド概要
BootDirコマンド実行時の起動ディレクトリ指定
BootModeコマンド実行時の、アプリケーション起動動作の指定（終了を待つなど）
CommandLineOptionRunやShellコマンドのコマンドライン指定
ExRunアプリケーションの実行コマンド（拡張子判別実行）
FilterExRunコマンドでの対象フィルター
MultiCommandModeRunやShellコマンドで、リスト選択からコマンドラインへの連携の方法の指定
OpenMode指定されたコマンドをどのように処理するか（新しいウィンドウで開く、ジャンプなど）
Runアプリケーションの実行コマンド（シェル実行系、D&D連携）
RunWait複数の連携ファイルの実行時のウェイト実行時間の指定
SendInfoModeRunやShellコマンドで、リスト連携でのファイル名の渡し方
ShiftSilentModeコマンド実行時にShift押下でコマンドラインを無視するか否かの指定
ShowWindow起動コマンドの表示設定（非表示で実行するなど）
TimeOutアプリケーション実行時のタイムアウト値の指定
Var変数宣言

その他の実行コマンド

コマンド概要
Callコマンドライン型のコマンド実行（実行コマンドの終了待ち）
Execコマンドライン型のコマンド実行（実行コマンドの終了を待たない）
Shellシェル実行型のコマンド、Runとほぼ等価だがD&D連携などをしない

変数への代入

　代入できるものとして、整数値、文字列、変数、環境変数、置換マクロなどが存在しますが、特殊な用途を持つコマンドが存在しますので列挙します。

特殊な変数への代入コマンド

コマンド概要
Call/Exec後述の説明参照、コマンド実行のリターンコードを返す
Inputフリー入力ダイアログによる入力結果を返す
InputFileファイル入力ダイアログ（ファイル選択ボタン付き）による入力結果を返す
InputDirフォルダー入力ダイアログ（フォルダー選択ボタン付き）による入力結果を返す
MessageBox
MessageBoxOK
MessageBoxYN		後述の単独使用の場合の説明も参照。ポップアップメッセージで押したボタンのIDを返す
単独で使うMessageBoxYNとは違い、Noの場合にも処理を中断しないので注意すること
各種演算子四則演算や、文字列の連結などの計算結果を返す

特殊な変数への代入コマンド（ファイル情報取得）

Exist指定したファイルないしディレクトリが存在するか否かを返す
IsDirectory指定したパスがディレクトリか否かを返す
IsFile指定したパスがファイルか否かを返す

特殊な変数への代入コマンド（文字列操作）

GetPath渡された文字列をフルパスのファイル名とみなし、パスの部分を切り出す
GetName渡された文字列をフルパスのファイル名とみなし、ファイル名（拡張子を含まない）の部分を切り出して返す
GetExt渡された文字列をフルパスのファイル名とみなし、拡張子の部分を切り出して返す
RemoveLastSeparator渡された文字列の末尾に\が付いている場合、これを１つ取り除いた文字列を返す
SubString指定文字列を指定の位置から指定長の文字を切り出して返す
Left渡された文字列を左から指定文字だけ切り出す
Right渡された文字列を右から指定文字だけ切り出す
Length渡された文字列の長さを返す。
String渡された文字列が半角数値であっても文字列として返す
TrimRight渡された文字を、指定文字列の右側から除去する
TrimLeft渡された文字を、指定文字列の左側から除去する
Padding渡されたテキストをゼロ埋めして、指定文字列だけ切り出す
Find渡された文字列を指定文字列を探して、インデックスを返す
Replace渡された文字列に対して、指定文字列を置換した結果を返す
CSV渡された文字列をCSV分解して、指定した項番の文字列を返す
GetClipboardTextクリップボードにテキストが格納されている場合に内容を返す
SetClipboardText渡された文字列をクリップボードへコピーする

特殊な変数への代入コマンド（情報取得）

GetSystemMetricsシステムの様々な表示要素の幅と高さと、システムの現在の構成値を取得して返す
MainWindowPosition本体のウィンドウ座標を返す
Random任意のフォルダーを走査して、ランダムで1つを選択して返す

制御系コマンド

　スクリプトの流れを制御するコマンド類です。

繰り返し/条件分岐

continue/breakfor/Next、do/whileのループ中で以降を読み飛ばす、以降を中断する制御を行う。
do/while条件式が満たされるまでdoとwhileの間をループする。for/Nextよりも上級者向けの機能という扱い。
ExitLoopCountfor/Next、Gotoによるループの上限回数で無限ループをしないように設けられている。do/whileには効かないこと、未設定時は5にセットされているので注意すること。
Gotoラベル定義を参照して、処理行をジャンプする
for/Nextリストで選択されたアイテムの数だけforとNextの間をループする。
if/else/endif与えられた式により、処理を分岐する

スクリプト制御

コマンド概要
CheckGrammar文法チェックのレベルと動作を指定する
EOFスクリプトの読み込み終端を指定する。ラベル定義などの以降の全て無視する
Exit呼ばれた時点でスクリプトを終了する。Includeで呼ばれた子スクリプトであれば親に制御が戻る
ExitAll出現時点でスクリプトを終了する。Includeで呼ばれた子スクリプトで発生すると親も終了する
Iconスクリプトのアイコン画像と指定するファイル名を指定する
Include外部ファイルをスクリプトファイルとして読み込み実行する。呼ばれたスクリプトとは親子関係が発生し、変数定義なども継承す る
Wait任意の秒数のウェイトを指定する

その他コマンド

分類が難しいコマンドを列挙します。

メッセージボックス

コマンド概要
MessageBoxポップアップメッセージの表示（汎用型）
MessageBoxOKポップアップメッセージの表示（OKボタンのみ）
MessageBoxYNポップアップメッセージの表示（Yes/Noボタンのみ、Noの場合処理中断可能）

ジャンプ/開く

コマンド概要
FavoriteJump任意の「お気入りタブ」を指定してフォルダーを開く
FileJump任意のファイルのパスへジャンプしたり開いたりする
FolderJump任意のフォルダーパスへジャンプしたり開いたりする
UBJump任意のユーザー定義バーで指定のディレクトリを開く

状態管理

コマンド概要
FullStateOpenウィンドウ制御文字列を指定することで、任意の表示モードでウィンドウを開く。システム用につき置換マクロは受け付けない
FullStateOpenExウィンドウ制御文字列を指定することで、任意の表示モードでウィンドウを開く。置換マクロが使用可能
ListInnerParamリストの内部パラメータをセットする
MoveWindow本体ウィンドウを指定座標へ移動する
UpdateState本体の状態系の置換マクロを最新の情報に更新する
Selectリスト上に表示されているファイルを選択する

As/RのコマンドID指定実行

コマンド概要
PostMessage本体へ機能コマンドを非同期で発行する。コマンドIDはAllCommand.txtを参照
PostMessageAll全部のタブに対して本体へ機能コマンドを非同期で発行する。コマンドIDはAllCommand.txtを参照
SendMessage本体へ機能コマンドを同期して発行する。使用は推奨しない
SendMessageAll全部のタブに対して本体へ機能コマンドを同期して発行する。使用は推奨しない
PostMessage1画面分割時用。アクティブリストへコマンドを非同期で発行する
PostMessage2画面分割時用。非アクティブリストへコマンドを非同期で発行する
PostMessageBar各種のドッキングバーに対してコマンドを発行する。コマンドIDは各バーのメニュー定義ファイルを参照
PostMessageTabタブ番号を指定してコマンドを非同期で実行する。タブ情報系のコマンドと組み合わせて使用する

ファイル作成/書き込み

コマンド概要
FileOpen書き込み目的で任意のファイルを開きます。開いたファイルは排他ロックされる
FileOpenModeファイルを開く際に、新規作成モードか追記モードかを指定する
FileWriteA指定文字列をASCIIコードで出力する。日本語環境の場合はSJISになる。
FileWriteW指定文字列をUNICODEで出力する。
BomOut直後のFileWriteWに対して作用し、BOMを出力するか否かを指定する
FileCloseFileOpenで開いたファイルをクローズする
FileRead指定したUNICODEテキストファイルから1行読み出す。
FileAllRead指定したUNICODEテキストファイルから、全ての行を読み出す。

本体リストから渡される連携ファイルリストの操作

コマンド概要
AppendSelectItemリストから渡されるリストに、任意のファイルパスを追加する
GetSelectItems指定されたディレクトリ以下を走査して、リストから渡されるリストに追加する
RemoveSelectItemsリストから渡される連携用のファイルリストを破棄する
AppendCSVSelectItemリストから渡されるリストに、任意のテキストをCSVで分解して追加する

レジストリ操作系

コマンド概要
WriteRegNumレジストリに数値を書き込む
WriteRegStringレジストリに文字列を書き込む
ReadRegNumレジストリの指定キーの数値を読み込む
ReadRegStringレジストリの指定キーの文字列を読み込む
LoadSettingAs/Rの設定を再読み込みし、画面を更新する

タブ情報系

コマンド概要
GetTabPath開いているタブの番号を指定して、現在のパスを返す
GetTabIndex指定されたワイルドカード文字列に合致するタブ番号を返す
PostMessageTab上記「As/RのコマンドID指定実行」を参照。タブ番号を指定してコマンドを実行する

マルチメディア系

コマンド概要
BackgroundImageリストに背景画像をセットする
PlayWavWavファイルを再生する

音声合成

コマンド概要
Speech任意のテキストを喋らせる
SpeechFlag読み上げモードの設定
SpeechVolume読み上げ音量の設定
SpeechRateSpeed読み上げスピードの設定
※Ver.13.0.6.0より前のバージョンではスペルミスでSpeachになっています。
　Ver.14から使えなくなりますのでご注意ください。
関連項目
・基本的なスクリプトコマンド
・その他のスクリプトコマンド
・スクリプトコマンドリファレンス
・スクリプトの制御構文

・置換マクロリファレンス
・置換マクロ対応表
・実行コマンドの違い一覧
・定義系コマンド一覧
・ウィンドウ制御文字列の書式
・復元スクリプト詳細