組み込み関数のシグネチャ

ContextGetBoundingBoxWidth

ContextGetBoundingBoxWidth() → Integer

描いたジェスチャ全体を囲む四角形の幅をピクセル単位で返します。ジェスチャ以外では 0 を返します。

パラメーター

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

戻り値

幅 (ピクセル単位)。ジェスチャ以外では 0。

ContextGetBoundingBoxX

ContextGetBoundingBoxX() → Integer

描いたジェスチャ全体を囲む四角形の左端を、仮想画面のピクセル単位で返します。ジェスチャ以外では 0 を返します。

パラメーター

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

戻り値

左端 (仮想画面のピクセル単位)。ジェスチャ以外では 0。

ContextGetBoundingBoxY

ContextGetBoundingBoxY() → Integer

描いたジェスチャ全体を囲む四角形の上端を、仮想画面のピクセル単位で返します。ジェスチャ以外では 0 を返します。

パラメーター

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

戻り値

上端 (仮想画面のピクセル単位)。ジェスチャ以外では 0。

3 個の例: ジェスチャのストロークの長さ, トリガーのコンテキストで取得できるすべての情報, ストロークはどの方向に描かれたか

ContextGetButtonState

ContextGetButtonState() → Text

グローバルなマウスボタンイベントが、ボタンを押したときと離したときのどちらで発生したかを返します。値を取得できるのは、グローバルなマウスボタンイベントのスクリプトだけです。

パラメーター

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

戻り値

押したときは 'down'、離したときは 'up'。ジェスチャを含むその他のトリガーでは空のテキスト。

ContextGetControl

ContextGetControl() → Window

トリガーの対象となった正確なコントロールを返します。たとえば、ジェスチャやマウスの下にあるエディットボックス、またはホットキーやテキスト展開の場合はフォーカスのあるウィンドウです。そのアプリケーションウィンドウを取得するには ContextGetWindow を使用してください。

パラメーター

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

戻り値

Window としてのコントロール。タイマー、フォルダー監視、シリアルモニター、Load スクリプトのように、トリガーにウィンドウがない場合は null ウィンドウ。

ContextGetGestureName

ContextGetGestureName() → Text

このアクションを実行するために描かれたジェスチャの名前を返します。これはアクションの名前ではなく、ジェスチャ自体の名前です。ContextGetActionName を参照してください。

パラメーター

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

戻り値

ジェスチャの名前。ジェスチャ以外では空のテキスト。

2 個の例: トリガーのコンテキストで取得できるすべての情報, ログファイルに追記する

ContextGetPointCount

ContextGetPointCount() → Integer

描いたジェスチャに沿って記録されたカーソル位置の数を返します。各位置は ContextGetPointX と ContextGetPointY で読み取ります。

パラメーター

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

戻り値

点の数。ジェスチャ以外では 0。

ContextGetPointX

ContextGetPointX(index: Integer) → Integer

描いたジェスチャの記録済みの 1 点について、画面上の水平位置を仮想画面のピクセル単位で返します。

パラメーター

index: Integer — 0 から始まる点の番号。0 から ContextGetPointCount() - 1 まで。点 0 はジェスチャの開始位置です。

戻り値

x 座標。index が範囲外の場合、またはアクションがジェスチャによってトリガーされていない場合は 0。

2 個の例: ジェスチャのストロークの長さ, ストロークはどの方向に描かれたか

ContextGetPointY

ContextGetPointY(index: Integer) → Integer

描いたジェスチャの記録済みの 1 点について、画面上の垂直位置を仮想画面のピクセル単位で返します。

パラメーター

index: Integer — 0 から始まる点の番号。0 から ContextGetPointCount() - 1 まで。点 0 はジェスチャの開始位置です。

戻り値

y 座標。index が範囲外の場合、またはアクションがジェスチャによってトリガーされていない場合は 0。

2 個の例: ジェスチャのストロークの長さ, ストロークはどの方向に描かれたか

ContextGetSerialMonitorName

ContextGetSerialMonitorName() → Text

受信した行によってこのスクリプトを開始したシリアルモニターの名前を、SerialMonitorCreate に渡されたとおりに返します。値を取得できるのは、シリアルモニターのスクリプトだけです。

パラメーター

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

戻り値

モニターの名前。その他のトリガーでは空のテキスト。

ContextGetSerialPortName

ContextGetSerialPortName() → Text

受信した行が届いた COM ポート (COM3 など) を返します。値を取得できるのは、シリアルモニターのスクリプトだけです。

パラメーター

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

戻り値

ポート名。その他のトリガーでは空のテキスト。

ContextGetSerialTextLine

ContextGetSerialTextLine() → Text

シリアルポートに届いてこのスクリプトを開始したテキスト行を返します。たとえば、Arduino が Serial.println で送信したセンサーの読み取り値です。行末は取り除かれます。

パラメーター

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

戻り値

終端文字を除いた受信行。その他のトリガーでは空のテキスト。

2 個の例: シリアルデバイスのボタンをメディアキーに割り当てる, Arduino のノブを音量調節に使う

ContextGetStrokeButton

ContextGetStrokeButton() → Integer

ジェスチャを描いたマウスボタン、またはグローバルなマウスボタンイベントを発生させたマウスボタンを、MouseButton 定数として返します。Windows が左クリックと右クリックとして扱うボタンは、主ボタンと副ボタンの入れ替えを反映した後の MouseButton.Primary または MouseButton.Secondary、それ以外のボタンは MouseButton.Middle、MouseButton.X1、MouseButton.X2 のいずれかです。MouseClick や MouseButtonDown に渡すと、同じボタンを押せます。

パラメーター

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

戻り値

MouseButton.Secondary などの MouseButton の値。その他のトリガーでは -1。

2 個の例: トリガーのコンテキストで取得できるすべての情報, ストロークのボタンで分岐する

ContextGetWatchAction

ContextGetWatchAction() → Text

監視対象フォルダーで発生し、このスクリプトを開始した変更を返します: 'created'、'deleted'、'modified'、'renamed-old-name'、'renamed-new-name'、'overflow' のいずれか。

パラメーター

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

戻り値

変更の種類。その他のトリガーでは空のテキスト。'overflow' は一度に多数の変更が届いたことを意味し、フォルダーをもう一度確認する必要があります。

1 個の例: フォルダーを監視する

ContextGetWatchName

ContextGetWatchName() → Text

このスクリプトを開始したフォルダー監視の名前を、FolderWatchCreate に渡されたとおりに返します。値を取得できるのは、フォルダー監視のスクリプトだけです。

パラメーター

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

戻り値

監視の名前。その他のトリガーでは空のテキスト。

ContextGetWatchPath

ContextGetWatchPath() → Text

変更されてこのフォルダー監視スクリプトを開始したファイルまたはフォルダーのパスを、監視対象フォルダーからの相対パスで返します。

パラメーター

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

戻り値

変更された項目の、監視対象フォルダーからの相対パス。'overflow' の変更やその他のトリガーでは空のテキスト。

1 個の例: フォルダーを監視する

ContextGetWindow

ContextGetWindow() → Window

トリガーの対象となったアプリケーションウィンドウを返します。ジェスチャやマウスの下にあるコントロールを含むトップレベルウィンドウ、またはホットキーやテキスト展開の場合はフォーカスのあるコントロールを含むトップレベルウィンドウです。

パラメーター

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

戻り値

ウィンドウ。タイマー、フォルダー監視、シリアルモニター、Load スクリプトのように、トリガーにウィンドウがない場合は null ウィンドウ。

16 個の例: 1 つのジェスチャで複数の選択肢, ジェスチャのウィンドウの最大化を切り替える, ウィンドウを最前面に固定する, ウィンドウの透明度を順に切り替える, カーソルの下にある 3×2 グリッドのセルにウィンドウをスナップする, ウィンドウを次のモニターに移動する, ウィンドウの位置を記憶して復元する, ウィンドウの子コントロールを調べる, ウィンドウを通知領域に隠す, トリガーのコンテキストで取得できるすべての情報, ストロークのボタンで分岐する, カーソルを 5 秒間ウィンドウ内に制限する, Ctrl キーを押している間は動作を変える, ストレージに保持するリスト, ウィンドウを特定のモニターに送る, 再利用可能な関数としてのスニペット

ContextRelayGesture

ContextRelayGesture() → Bool

描いたジェスチャを、同じボタンで同じ経路をたどる実際のマウスドラッグとして再生し、下にあるアプリケーションが受け取れるようにします (テキストの選択など)。ドラッグ中は実際の入力が保留されます。

パラメーター

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

戻り値

ドラッグ全体が送信された場合は true。ジェスチャ以外の場合、または Windows が入力の一部を拒否した場合は false。

1 個の例: 認識されなかった描画をそのまま通す

DateTime

DateTimeFormat

DateTimeFormat(iso: Text, style: Integer) → Text · シンプル

日時を、ユーザーの地域の形式による読みやすいテキスト、または並べ替え可能な FileStamp として書式設定します。Z または UTC オフセット付きの時刻は、先にローカル時刻に変換されます。

パラメーター

iso: Text — DateTimeGetNow が返す形式の ISO 8601 の日時 (2026-10-05T14:05:09-04:00)。日付のみの場合は午前 0 時を意味します。Z やオフセットがない場合はローカル時刻と見なされます。年は 1601 から 9999 まで。
style: Integer — DateTimeStyle.ShortDate、DateTimeStyle.LongDateTime、DateTimeStyle.FileStamp などの DateTimeStyle 定数。それ以外の値の場合は、エラーでアクションが停止します。

戻り値

書式設定されたテキスト (DateTimeStyle.FileStamp の場合は 20261005-140509 など)。iso が空の場合は空のテキスト。ISO 8601 ではないテキストの場合は、エラーでアクションが停止します。

1 個の例: 今日の日付とタイムスタンプ付きのファイル名

DateTimeGetNow

DateTimeGetNow() → Text · シンプル

現在のローカル日時を、秒単位まで UTC オフセット付きの ISO 8601 テキストとして返します。DateTimeFormat または DateTimeGetPart に渡して使用します。

パラメーター

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

戻り値

2026-10-05T14:05:09-04:00 のようなテキスト。Windows がタイムゾーンを取得できない場合は空のテキスト。

1 個の例: 今日の日付とタイムスタンプ付きのファイル名

DateTimeGetPart

DateTimeGetPart(iso: Text, part: Integer) → Integer

日時の一部 (年、月、日、時、分、秒、曜日) を、ローカル時刻の数値として返します。

パラメーター

iso: Text — DateTimeGetNow が返す形式の ISO 8601 の日時。Z または UTC オフセット付きの時刻はローカル時刻に変換されます。ない場合はローカル時刻と見なされます。
part: Integer — DateTimePart.Hour や DateTimePart.Weekday などの DateTimePart 定数。それ以外の値の場合は、エラーでアクションが停止します。

戻り値

その部分の値: 月は 1 から 12、時は 0 から 23、曜日は 1 (月曜日) から 7 (日曜日)。iso が空の場合は -1。ISO 8601 ではないテキストの場合は、エラーでアクションが停止します。

1 個の例: 今日の日付とタイムスタンプ付きのファイル名

Display

DisplayGetMonitorDpiFromPoint

DisplayGetMonitorDpiFromPoint(x: Integer, y: Integer) → Integer

画面上の点を含むモニターに Windows が現在使用している DPI を返します。どのモニター上にもない点の場合は、最も近いモニターが使用されます。

パラメーター

x: Integer — 画面上の水平位置 (ピクセル単位)。
y: Integer — 画面上の垂直位置 (ピクセル単位)。

戻り値

DPI (100 パーセントのスケーリングでは 96、150 パーセントでは 144 など)。Windows が取得できない場合はシステムの DPI。

DisplayGetPixelColorFromPoint

DisplayGetPixelColorFromPoint(x: Integer, y: Integer) → Integer

画面上の点にあるピクセルの、現在モニターに表示されている色を返します。

パラメーター

x: Integer — ピクセルの画面上の水平位置 (ピクセル単位)。
y: Integer — ピクセルの画面上の垂直位置 (ピクセル単位)。

戻り値

0xRRGGBB としてパックされた Integer の色 (最上位バイトが赤、最下位バイトが青)。点がどのモニター上にもない場合、または画面を読み取れない場合は -1。

1 個の例: カーソルの下のピクセルの色を読み取る

DisplayMonitorEnumeratedAll

DisplayMonitorEnumeratedAll() → Integer

接続されているすべてのモニターのスナップショットを、左から右、次に上から下の順で作成し、DisplayMonitorGetEnumerated 系の組み込み関数がインデックスで読み取れるようにします。モニター構成が変わった後は、もう一度呼び出してください。

パラメーター

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

戻り値

スナップショット内のモニターの数。有効なインデックスは 0 からこの数 - 1 までです。

2 個の例: モニターを一覧表示する, ウィンドウを特定のモニターに送る

DisplayMonitorExistsByName

DisplayMonitorExistsByName(name: Text) → Bool

名前で保存したモニターが現在接続されているかどうかを確認します。FromName 系の四角形の組み込み関数は、モニターが存在しない場合と実際の座標が 0 の場合の両方で 0 を返すため、その前に使用してください。

パラメーター

name: Text — モニターのデバイスパス (確実な方法。DisplayMonitorGetDevicePathFromPoint で取得) または DELL U2720Q などのモデル名。大文字と小文字は区別されません。デバイスパスの完全一致はモデル名より優先されます。

戻り値

接続されているモニターが名前に一致する場合は true。一致するものがない場合、または name が空の場合は false。

DisplayMonitorGetDevicePathFromPoint

DisplayMonitorGetDevicePathFromPoint(x: Integer, y: Integer) → Text

画面上の点を含むモニターのデバイスパスを返します。これは保存しておき、後で FromName 系の組み込み関数に渡すための一意の名前です。モニターを別のビデオポートに接続し直すと変わります。

パラメーター

x: Integer — 画面上の水平位置 (ピクセル単位)。
y: Integer — 画面上の垂直位置 (ピクセル単位)。

戻り値

デバイスパス。Windows がモニターを識別できない場合は空のテキスト。どのモニター上にもない点の場合は、最も近いモニターが使用されます。

DisplayMonitorGetEnumeratedDevicePathAt

DisplayMonitorGetEnumeratedDevicePathAt(index: Integer) → Text

最後の DisplayMonitorEnumeratedAll スナップショット内のモニターについて、保存用の一意の名前であるデバイスパスを返します。

パラメーター

index: Integer — 最後の DisplayMonitorEnumeratedAll スナップショット内でのモニターの 0 から始まる位置 (左から右、次に上から下の順)。

戻り値

デバイスパス。index が範囲外の場合、またはスナップショットの後にモニター構成が変わった場合は空のテキスト。

DisplayMonitorGetEnumeratedDpiAt

DisplayMonitorGetEnumeratedDpiAt(index: Integer) → Integer

最後の DisplayMonitorEnumeratedAll スナップショット内のモニターの DPI を、スナップショット作成時の値で返します。

パラメーター

index: Integer — 最後の DisplayMonitorEnumeratedAll スナップショット内でのモニターの 0 から始まる位置 (左から右、次に上から下の順)。

戻り値

DPI (100 パーセントのスケーリングでは 96、150 パーセントでは 144 など)。index が範囲外の場合は 0。

DisplayMonitorGetEnumeratedFriendlyNameAt

DisplayMonitorGetEnumeratedFriendlyNameAt(index: Integer) → Text

最後の DisplayMonitorEnumeratedAll スナップショット内のモニターについて、モニターが報告するモデル名 (DELL U2720Q など) を返します。同一のモニター 2 台は同じ名前を報告します。

パラメーター

index: Integer — 最後の DisplayMonitorEnumeratedAll スナップショット内でのモニターの 0 から始まる位置 (左から右、次に上から下の順)。

戻り値

モデル名。index が範囲外の場合、モニターが名前を報告しない場合 (ノート PC の内蔵画面によくあります)、またはスナップショットの後にモニター構成が変わった場合は空のテキスト。

DisplayMonitorGetEnumeratedHeightAt

DisplayMonitorGetEnumeratedHeightAt(index: Integer, workArea: Bool) → Integer

最後の DisplayMonitorEnumeratedAll スナップショット内のモニターの高さを、領域全体または作業領域について、スナップショット作成時の値で返します。

パラメーター

index: Integer — 最後の DisplayMonitorEnumeratedAll スナップショット内でのモニターの 0 から始まる位置 (左から右、次に上から下の順)。
workArea: Bool — true の場合は作業領域 (タスクバーとドッキングされたツールバーを除く領域)。false の場合はモニター全体。

戻り値

高さ (ピクセル単位)。index が範囲外の場合は 0。

DisplayMonitorGetEnumeratedWidthAt

DisplayMonitorGetEnumeratedWidthAt(index: Integer, workArea: Bool) → Integer

最後の DisplayMonitorEnumeratedAll スナップショット内のモニターの幅を、領域全体または作業領域について、スナップショット作成時の値で返します。

パラメーター

index: Integer — 最後の DisplayMonitorEnumeratedAll スナップショット内でのモニターの 0 から始まる位置 (左から右、次に上から下の順)。
workArea: Bool — true の場合は作業領域 (タスクバーとドッキングされたツールバーを除く領域)。false の場合はモニター全体。

戻り値

幅 (ピクセル単位)。index が範囲外の場合は 0。

2 個の例: アクティブウィンドウをモニターの左半分にスナップする, カーソルの下にある 3×2 グリッドのセルにウィンドウをスナップする

DisplayMonitorGetEnumeratedXAt

DisplayMonitorGetEnumeratedXAt(index: Integer, workArea: Bool) → Integer

最後の DisplayMonitorEnumeratedAll スナップショット内のモニターの左端を、領域全体または作業領域について、スナップショット作成時の値で返します。

パラメーター

index: Integer — 最後の DisplayMonitorEnumeratedAll スナップショット内でのモニターの 0 から始まる位置 (左から右、次に上から下の順)。
workArea: Bool — true の場合は作業領域 (タスクバーとドッキングされたツールバーを除く領域)。false の場合はモニター全体。

戻り値

左端 (画面のピクセル単位。プライマリモニターより左にあるモニターでは負の値)。index が範囲外の場合は 0。0 は実際の端の値でもあるため、index をモニターの数と照らし合わせて確認してください。

DisplayMonitorGetEnumeratedYAt

DisplayMonitorGetEnumeratedYAt(index: Integer, workArea: Bool) → Integer

最後の DisplayMonitorEnumeratedAll スナップショット内のモニターの上端を、領域全体または作業領域について、スナップショット作成時の値で返します。

パラメーター

index: Integer — 最後の DisplayMonitorEnumeratedAll スナップショット内でのモニターの 0 から始まる位置 (左から右、次に上から下の順)。
workArea: Bool — true の場合は作業領域 (タスクバーとドッキングされたツールバーを除く領域)。false の場合はモニター全体。

戻り値

上端 (画面のピクセル単位。プライマリモニターより上にあるモニターでは負の値)。index が範囲外の場合は 0。0 は実際の端の値でもあるため、index をモニターの数と照らし合わせて確認してください。

DisplayMonitorGetFriendlyNameFromPoint

DisplayMonitorGetFriendlyNameFromPoint(x: Integer, y: Integer) → Text

画面上の点を含むモニターのモデル名 (DELL U2720Q など) を返します。読みやすい名前ですが一意ではなく、同一のモニター 2 台は同じ名前を報告します。

パラメーター

x: Integer — 画面上の水平位置 (ピクセル単位)。
y: Integer — 画面上の垂直位置 (ピクセル単位)。

戻り値

モデル名。モニターが名前を報告しない場合 (ノート PC の内蔵画面によくあります) は空のテキスト。どのモニター上にもない点の場合は、最も近いモニターが使用されます。

DisplayMonitorGetRectHeightFromName

DisplayMonitorGetRectHeightFromName(name: Text, workArea: Bool) → Integer

保存済みのデバイスパスまたはモデル名で見つけた接続中のモニターの高さを、領域全体または作業領域について返します。

パラメーター

name: Text — モニターのデバイスパス (確実な方法) または DELL U2720Q などのモデル名。大文字と小文字は区別されません。デバイスパスの完全一致はモデル名より優先されます。
workArea: Bool — true の場合は作業領域 (タスクバーとドッキングされたツールバーを除く領域)。false の場合はモニター全体。

戻り値

高さ (ピクセル単位)。接続されているモニターで名前に一致するものがない場合は 0。

DisplayMonitorGetRectHeightFromPoint

DisplayMonitorGetRectHeightFromPoint(x: Integer, y: Integer, workArea: Bool) → Integer

画面上の点を含むモニターの高さを、領域全体または作業領域について返します。どのモニター上にもない点の場合は、最も近いモニターが使用されます。

パラメーター

x: Integer — 画面上の水平位置 (ピクセル単位)。
y: Integer — 画面上の垂直位置 (ピクセル単位)。
workArea: Bool — true の場合は作業領域 (タスクバーとドッキングされたツールバーを除く領域)。false の場合はモニター全体。

戻り値

高さ (ピクセル単位)。

DisplayMonitorGetRectWidthFromName

DisplayMonitorGetRectWidthFromName(name: Text, workArea: Bool) → Integer

保存済みのデバイスパスまたはモデル名で見つけた接続中のモニターの幅を、領域全体または作業領域について返します。

パラメーター

name: Text — モニターのデバイスパス (確実な方法) または DELL U2720Q などのモデル名。大文字と小文字は区別されません。デバイスパスの完全一致はモデル名より優先されます。
workArea: Bool — true の場合は作業領域 (タスクバーとドッキングされたツールバーを除く領域)。false の場合はモニター全体。

戻り値

幅 (ピクセル単位)。接続されているモニターで名前に一致するものがない場合は 0。

DisplayMonitorGetRectWidthFromPoint

DisplayMonitorGetRectWidthFromPoint(x: Integer, y: Integer, workArea: Bool) → Integer

画面上の点を含むモニターの幅を、領域全体または作業領域について返します。どのモニター上にもない点の場合は、最も近いモニターが使用されます。

パラメーター

x: Integer — 画面上の水平位置 (ピクセル単位)。
y: Integer — 画面上の垂直位置 (ピクセル単位)。
workArea: Bool — true の場合は作業領域 (タスクバーとドッキングされたツールバーを除く領域)。false の場合はモニター全体。

戻り値

幅 (ピクセル単位)。

3 個の例: else-if の連鎖, アクティブウィンドウをモニターの左半分にスナップする, カーソルの下にある 3×2 グリッドのセルにウィンドウをスナップする

DisplayMonitorGetRectXFromName

DisplayMonitorGetRectXFromName(name: Text, workArea: Bool) → Integer

保存済みのデバイスパスまたはモデル名で見つけた接続中のモニターの左端を、領域全体または作業領域について返します。

パラメーター

name: Text — モニターのデバイスパス (確実な方法) または DELL U2720Q などのモデル名。大文字と小文字は区別されません。デバイスパスの完全一致はモデル名より優先されます。
workArea: Bool — true の場合は作業領域 (タスクバーとドッキングされたツールバーを除く領域)。false の場合はモニター全体。

戻り値

左端 (画面のピクセル単位)。接続されているモニターで名前に一致するものがない場合は 0。0 は実際の端の値でもあるため、先に DisplayMonitorExistsByName で確認してください。

DisplayMonitorGetRectXFromPoint

DisplayMonitorGetRectXFromPoint(x: Integer, y: Integer, workArea: Bool) → Integer

画面上の点を含むモニターの左端を、領域全体または作業領域について返します。どのモニター上にもない点の場合は、最も近いモニターが使用されます。

パラメーター

x: Integer — 画面上の水平位置 (ピクセル単位)。
y: Integer — 画面上の垂直位置 (ピクセル単位)。
workArea: Bool — true の場合は作業領域 (タスクバーとドッキングされたツールバーを除く領域)。false の場合はモニター全体。

戻り値

左端 (画面のピクセル単位)。プライマリモニターより左にあるモニターでは負の値。

DisplayMonitorGetRectYFromName

DisplayMonitorGetRectYFromName(name: Text, workArea: Bool) → Integer

保存済みのデバイスパスまたはモデル名で見つけた接続中のモニターの上端を、領域全体または作業領域について返します。

パラメーター

name: Text — モニターのデバイスパス (確実な方法) または DELL U2720Q などのモデル名。大文字と小文字は区別されません。デバイスパスの完全一致はモデル名より優先されます。
workArea: Bool — true の場合は作業領域 (タスクバーとドッキングされたツールバーを除く領域)。false の場合はモニター全体。

戻り値

上端 (画面のピクセル単位)。接続されているモニターで名前に一致するものがない場合は 0。0 は実際の端の値でもあるため、先に DisplayMonitorExistsByName で確認してください。

DisplayMonitorGetRectYFromPoint

DisplayMonitorGetRectYFromPoint(x: Integer, y: Integer, workArea: Bool) → Integer

画面上の点を含むモニターの上端を、領域全体または作業領域について返します。どのモニター上にもない点の場合は、最も近いモニターが使用されます。

パラメーター

x: Integer — 画面上の水平位置 (ピクセル単位)。
y: Integer — 画面上の垂直位置 (ピクセル単位)。
workArea: Bool — true の場合は作業領域 (タスクバーとドッキングされたツールバーを除く領域)。false の場合はモニター全体。

戻り値

上端 (画面のピクセル単位)。プライマリモニターより上にあるモニターでは負の値。

2 個の例: アクティブウィンドウをモニターの左半分にスナップする, カーソルの下にある 3×2 グリッドのセルにウィンドウをスナップする

Engine

EngineConsumePhysicalInput

EngineConsumePhysicalInput(enable: Bool, timeoutSeconds: Integer) → Bool

ユーザーの実際のマウスとキーボードの入力がどのウィンドウにも届かないようにするか、そのブロックを終了します。スクリプトが送信する入力は引き続き機能し、ブロックはタイムアウト後に自動的に終了します。

パラメーター

enable: Bool — true の場合は実際の入力のブロックを開始または再開始します。false の場合は、どのスクリプトが開始したかにかかわらずブロックを終了します。
timeoutSeconds: Integer — ブロックが続く最大時間 (秒)。enable が true の場合は 1 以上。これより長い値は [スクリプト] 設定ページの上限 (既定は 120 秒) に短縮されます。enable が false の場合は無視されます。

戻り値

常に true。enable が true の場合、timeoutSeconds が 0 以下だとエラーでスクリプトが停止します。

EngineDisable

EngineDisable() → Bool · シンプル

通知領域のアイコンから無効にした場合と同様に、EngineEnable または通知領域から再度有効にするまでエンジンを無効にします。変更は呼び出しから戻った直後に行われます。セーフモードでは何も行いません。

パラメーター

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

戻り値

要求が送信された場合は true。エンジンの起動が完了していない場合は false。

1 個の例: エンジンの状態

EngineDisableNextGesture

EngineDisableNextGesture() → Bool · シンプル

次に描画ボタンを押したときに、ジェスチャを開始せずにそのままアプリケーションに渡します。1 回だけ有効です。エンジンが無効になっている間は効果がありません。

パラメーター

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

戻り値

常に true。

1 個の例: 次の右ドラッグをそのまま通す

EngineEnable

EngineEnable() → Bool · シンプル

EngineDisable または通知領域のアイコンから無効にした後に、エンジンを再び有効にします。変更は呼び出しから戻った直後に行われます。セーフモードでは何も行いません。

パラメーター

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

戻り値

要求が送信された場合は true。エンジンの起動が完了していない場合は false。

EngineExit

EngineExit() → Bool · シンプル

通知領域のメニューの [終了] と同様に、通常のシャットダウンでエンジンを閉じます。通知領域に隠したウィンドウは元に戻され、構成 UI は閉じます。シャットダウンは呼び出しから戻った直後に開始されます。

パラメーター

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

戻り値

シャットダウン要求が送信された場合は true。エンジンの起動が完了していない場合は false。

EngineIsDisabled

EngineIsDisabled() → Bool

エンジンが現在無効になっているかどうかを返します。EngineDisable や通知領域のアイコンによる無効化と、フォーカスのあるアプリケーションに対する自動的な無効化の両方が対象です。

パラメーター

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

戻り値

エンジンが無効の場合は true。有効な場合は false。

1 個の例: エンジンの状態

EngineIsSafeMode

EngineIsSafeMode() → Bool

エンジンがセーフモードで起動されたかどうかを返します。セーフモードでは、診断コンソールから実行したスクリプトだけが実行できます。

パラメーター

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

戻り値

セーフモードの場合は true。それ以外の場合は false。

1 個の例: エンジンの状態

EngineReload

EngineReload() → Bool · シンプル

通知領域のメニューの [構成の再読み込み] と同様に、再起動せずにディスクから構成を再読み込みします。最大 3 秒待機します。実行中の他のスクリプトはすべて停止されますが、このスクリプトは続行します。

パラメーター

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

戻り値

新しい構成が使用され始めた時点で true。構成を読み込めなかった場合、または再読み込みに 3 秒より長くかかった場合は false。

EngineStopAllActions

EngineStopAllActions() → Bool · シンプル

呼び出し元を含む、実行中のすべてのアクションとスクリプトに停止を要求します。強制終了は行われず、各スクリプトは次のステップで停止するため、呼び出し元は少し先まで実行される場合があります。

パラメーター

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

戻り値

常に true。

File

FileAppendText

FileAppendText(path: Text, text: Text) → Bool

テキストファイルの末尾にテキストを追加します。ファイルが存在しない場合は作成します。ログに便利です。テキストは UTF-8 で書き込まれ、改行は自動では追加されません。

パラメーター

path: Text — ファイルの完全パス。そのフォルダーは既に存在している必要があります。
text: Text — 追加するテキスト。1 行に 1 エントリにするには、末尾に '\n' を付けてください。

戻り値

テキストが書き込まれた場合は true。フォルダーが存在しない場合、ファイルがロックされている場合、または既存のファイルの先頭がバイナリデータと思われる場合は false。

1 個の例: ログファイルに追記する

FileCopy

FileCopy(source: Text, destination: Text, overwrite: Bool) → Bool

任意の種類のファイルを新しいパスにコピーします。コピー先のフォルダーは既に存在している必要があります。

パラメーター

source: Text — コピーするファイルの完全パス。
destination: Text — 新しいコピーの完全パス (ファイル名を含む)。
overwrite: Bool — true の場合は destination にある既存のファイルを置き換えます。false の場合はそのままにして false を返します。

戻り値

ファイルがコピーされた場合は true。コピー元が存在しない場合、コピー先が存在し overwrite が false の場合、またはコピーに失敗した場合は false。

1 個の例: 編集前にファイルをバックアップする

FileCreate

FileCreate(path: Text, text: Text) → Bool

指定した内容で新しいテキストファイルを UTF-8 で作成します。そのパスに既に何かが存在する場合は作成しません。既存のファイルの内容を置き換えるには FileEditText を使用してください。

パラメーター

path: Text — 新しいファイルの完全パス。そのフォルダーは既に存在している必要があります。
text: Text — ファイルの内容。空のテキストの場合は空のファイルが作成されます。

戻り値

ファイルが作成された場合は true。そこに既にファイルまたはフォルダーが存在する場合、またはファイルを書き込めなかった場合は false。

2 個の例: 今日の日付とタイムスタンプ付きのファイル名, ログファイルに追記する

FileDelete

FileDelete(path: Text) → Bool

ファイルを完全に削除します。ごみ箱には移動されません。既に存在しないファイルは成功と見なされます。フォルダーは削除されません。フォルダーには FolderDelete を使用してください。

パラメーター

path: Text — 削除するファイルの完全パス。

戻り値

ファイルが存在しなくなった場合 (元から存在しなかった場合を含む) は true。パスがフォルダーの場合、ファイルがロックされている場合、またはアクセスが拒否された場合は false。

FileEditText

FileEditText(path: Text, text: Text) → Bool

既存のテキストファイルの内容全体を UTF-8 で置き換えます。バイナリデータと思われるファイルは対象外です。新しいファイルには FileCreate を使用してください。

パラメーター

path: Text — 既存のテキストファイルの完全パス。
text: Text — ファイル内のすべてを置き換える新しい内容。

戻り値

ファイルが書き換えられた場合は true。ファイルが存在しない場合、ファイルの先頭がバイナリデータと思われる場合、または書き込めなかった場合は false。

1 個の例: 編集前にファイルをバックアップする

FileExists

FileExists(path: Text) → Bool

パスにファイルが存在するかどうかを確認します。そのパスにあるのがフォルダーの場合は対象外です。フォルダーには FolderExists を使用してください。

パラメーター

path: Text — 確認するファイルの完全パス。

戻り値

そこにファイルが存在する場合は true。何も存在しない場合、またはフォルダーの場合は false。

2 個の例: ログファイルに追記する, 編集前にファイルをバックアップする

FileGetCreationDate

FileGetCreationDate(path: Text) → Text

ファイルが作成された日時を、DateTimeFormat などの DateTime 系の組み込み関数で読み取れる UTC の ISO 8601 日時として返します。

パラメーター

path: Text — ファイルの完全パス。

戻り値

作成日時 (2026-10-01T18:05:09Z など)。ファイルが存在しない場合、またはパスがフォルダーの場合は空のテキスト。

FileGetModifiedDate

FileGetModifiedDate(path: Text) → Text

ファイルの内容が最後に変更された日時を、DateTimeFormat などの DateTime 系の組み込み関数で読み取れる UTC の ISO 8601 日時として返します。

パラメーター

path: Text — ファイルの完全パス。

戻り値

最終更新日時 (2026-10-01T18:05:09Z など)。ファイルが存在しない場合、またはパスがフォルダーの場合は空のテキスト。

1 個の例: ファイルを読み取って行数を数える

FileGetProductVersion

FileGetProductVersion(path: Text) → Text

プログラムファイルまたはライブラリファイル (.exe や .dll など) に格納されている製品バージョンを返します。これはそのファイルを含む製品のバージョンで、FileGetVersion とは異なる場合があります。

パラメーター

path: Text — .exe、.dll、またはバージョン情報を持つその他のファイルの完全パス。

戻り値

4 つの数値で表されるバージョン (10.0.22621.1 など)。ファイルにバージョン情報がない場合、またはファイルが存在しない場合は空のテキスト。

FileGetSize

FileGetSize(path: Text) → Integer

ファイルを開いたり読み取ったりせずに、ファイルのサイズをバイト単位で返します。

パラメーター

path: Text — ファイルの完全パス。

戻り値

サイズ (バイト単位)。ファイルが存在しない場合、またはパスがフォルダーの場合は -1。

1 個の例: ファイルを読み取って行数を数える

FileGetVersion

FileGetVersion(path: Text) → Text

プログラムファイルまたはライブラリファイル (.exe や .dll など) に格納されているファイルバージョンを、[プロパティ] の [詳細] タブに表示されるとおりに返します。

パラメーター

path: Text — .exe、.dll、またはバージョン情報を持つその他のファイルの完全パス。

戻り値

4 つの数値で表されるバージョン (10.0.22621.1 など)。ファイルにバージョン情報がない場合、またはファイルが存在しない場合は空のテキスト。

FileMove

FileMove(source: Text, destination: Text, overwrite: Bool) → Bool

任意の種類のファイルを新しいパスに移動します。新しい名前を付けることもでき、大文字と小文字だけの変更も可能です。移動先のフォルダーは既に存在している必要があります。

パラメーター

source: Text — 移動するファイルの完全パス。
destination: Text — ファイルの新しい場所の完全パス (ファイル名を含む)。
overwrite: Bool — true の場合は destination にある既存のファイルを 1 回の操作で置き換えます。false の場合はそのままにして false を返します。移動元と大文字と小文字だけが異なる移動先は、既存のファイルとは見なされません。

戻り値

ファイルが移動された場合は true。移動元が存在しない場合、移動先が存在し overwrite が false の場合、または移動に失敗した場合は false。

FileReadText

FileReadText(path: Text) → Text

テキストファイル全体を読み取り、その内容を返します。UTF-8、バイトオーダーマーク付きの UTF-16、およびシステムの従来のコードページのファイルに対応しています。バイナリファイルは対象外です。

パラメーター

path: Text — テキストファイルの完全パス。

戻り値

ファイルの内容。ファイルが存在しない場合、読み取れない場合、またはバイナリデータと思われる場合は空のテキスト。

2 個の例: ファイルを読み取って行数を数える, 編集前にファイルをバックアップする

FileRename

FileRename(path: Text, newName: Text) → Bool

ファイルの名前を変更し、現在のフォルダーにそのまま置きます。report.txt から Report.txt のように、大文字と小文字だけを変更することもできます。ファイルを別のフォルダーに移動するには FileMove を使用してください。

パラメーター

path: Text — 名前を変更するファイルの完全パス。
newName: Text — 新しいファイル名のみ (report-old.txt など)。スラッシュまたは円記号を含む名前の場合は、エラーでスクリプトが停止します。

戻り値

ファイルの名前が変更された場合は true。ファイルが存在しない場合、新しい名前の別のファイルまたはフォルダーが既に存在する場合、または名前の変更に失敗した場合は false。

Folder

FolderCreate

FolderCreate(path: Text) → Bool

フォルダーを作成します。存在しない親フォルダーもすべて作成します。既に存在するフォルダーは成功と見なされます。

パラメーター

path: Text — 作成するフォルダーの完全パス。

戻り値

処理後にフォルダーが存在する場合は true。同じ場所にファイルがある場合、またはフォルダーを作成できなかった場合は false。

FolderDelete

FolderDelete(path: Text, recursive: Bool) → Bool

フォルダーを完全に削除します。ごみ箱には移動されません。recursive が true の場合は、中にあるものもすべて削除されます。既に存在しないフォルダーは成功と見なされます。ファイルは削除されません。ファイルには FileDelete を使用してください。

パラメーター

path: Text — 削除するフォルダーの完全パス。
recursive: Bool — true の場合はフォルダーとその中のすべてを削除します。false の場合はフォルダーが空のときだけ削除します。

戻り値

フォルダーが存在しなくなった場合は true。パスがファイルの場合、フォルダーが空ではなく recursive が false の場合、または中のものがロックまたは保護されている場合は false。

FolderEnumerateAll

FolderEnumerateAll(path: Text, recursive: Bool) → Integer

フォルダー内のファイルとサブフォルダーを一覧にし、その数を返します。各完全パスは FolderGetEnumeratedPathAt で読み取ります。アクセスできないサブフォルダーはスキップされます。

パラメーター

path: Text — 一覧にするフォルダーの完全パス。
recursive: Bool — true の場合はすべてのサブフォルダー内のものも一覧にします。false の場合はフォルダーの直下の内容だけです。

戻り値

見つかった項目の数。フォルダーが存在しない場合、または読み取れない場合は -1。

1 個の例: フォルダー内のファイルの種類を数える

FolderExists

FolderExists(path: Text) → Bool

パスにフォルダーが存在するかどうかを確認します。そのパスにあるのがファイルの場合は対象外です。ファイルには FileExists を使用してください。

パラメーター

path: Text — 確認するフォルダーの完全パス。

戻り値

そこにフォルダーが存在する場合は true。何も存在しない場合、またはファイルの場合は false。

FolderGetEnumeratedPathAt

FolderGetEnumeratedPathAt(index: Integer) → Text

このスクリプトの実行中に最後に呼び出した FolderEnumerateAll が作成した一覧から、完全パスを 1 つ返します。

パラメーター

index: Integer — 一覧内の位置。0 から、FolderEnumerateAll が返した数 - 1 まで。

戻り値

ファイルまたはフォルダーの完全パス。index が範囲外の場合、または FolderEnumerateAll が呼び出されていない場合は空のテキスト。

1 個の例: フォルダー内のファイルの種類を数える

FolderRename

FolderRename(path: Text, newName: Text) → Bool

フォルダーの名前を変更し、中身とともに現在の親フォルダーにそのまま置きます。大文字と小文字だけを変更することもできます。

パラメーター

path: Text — 名前を変更するフォルダーの完全パス。
newName: Text — 新しいフォルダー名のみ。スラッシュまたは円記号を含む名前の場合は、エラーでスクリプトが停止します。

戻り値

フォルダーの名前が変更された場合は true。フォルダーが存在しない場合、新しい名前の別のファイルまたはフォルダーが既に存在する場合、または名前の変更に失敗した場合 (中のファイルが開かれている場合など) は false。

FolderWatchCreate

FolderWatchCreate(name: Text, path: Text, recursive: Bool, filterMask: Integer, script: Text) → Bool

フォルダーの監視を開始し、ファイルの作成、変更、名前の変更、削除など、Windows が報告する変更ごとにスクリプトを実行します。監視はこのスクリプトの終了後も続きます。

パラメーター

name: Text — 監視の名前。既に使用されている名前で監視を作成すると、その監視が置き換えられます。名前では大文字と小文字が区別されます。
path: Text — 監視するフォルダーの完全パス。
recursive: Bool — true の場合はすべてのサブフォルダーも監視します。false の場合はフォルダー自体だけを監視します。
filterMask: Integer — 報告する変更の種類。FileNotify.FileName | FileNotify.LastWrite のように、FileNotify 定数を | で組み合わせて指定します。
script: Text — 変更ごとに実行するスクリプト (Text)。スクリプトは ContextGetWatchAction (created、deleted、modified、renamed-old-name、renamed-new-name、overflow) と ContextGetWatchPath で変更内容を読み取ります。

戻り値

監視が実行中の場合は true。フォルダーが存在しない場合、開けない場合、または filterMask が 0 の場合は false。

1 個の例: フォルダーを監視する

FolderWatchDelete

FolderWatchDelete(name: Text) → Bool

FolderWatchCreate で作成したフォルダー監視を停止し、そのスクリプトが実行されないようにします。

パラメーター

name: Text — FolderWatchCreate に渡した名前。名前では大文字と小文字が区別されます。

戻り値

その名前の監視が見つかって停止された場合は true。見つからなかった場合は false。

1 個の例: フォルダーを監視する

FolderWatchDeleteAll

FolderWatchDeleteAll() → Bool

FolderWatchCreate で作成したすべてのフォルダー監視を停止し、どのスクリプトも実行されないようにします。

パラメーター

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

戻り値

常に true。

FolderWatchGetCount

FolderWatchGetCount() → Integer

実行中のフォルダー監視の数を返し、FolderWatchGetEnumeratedNameAt 用にそれらの名前のスナップショットを作成します。

パラメーター

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

戻り値

実行中のフォルダー監視の数。1 つもない場合は 0。

FolderWatchGetEnumeratedNameAt

FolderWatchGetEnumeratedNameAt(index: Integer) → Text

このスクリプトの実行中に最後に呼び出した FolderWatchGetCount が作成したスナップショットから、監視の名前を 1 つ返します。

パラメーター

index: Integer — スナップショット内の位置。0 から数 - 1 まで。順序に意味はありません。

戻り値

監視の名前。index が範囲外の場合、または FolderWatchGetCount が呼び出されていない場合は空のテキスト。

GestureProfile

GestureProfileEnumerateAll

GestureProfileEnumerateAll() → Integer

構成内のすべてのジェスチャプロファイルの一覧を作成し、その数を返します。各プロファイルは GestureProfileGetEnumeratedIdAt と GestureProfileGetEnumeratedNameAt で読み取ります。

パラメーター

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

戻り値

ジェスチャプロファイルの数。1 つもない場合は 0。

GestureProfileGetActiveId

GestureProfileGetActiveId() → Text

現在アクティブなジェスチャプロファイルの ID を返します。

パラメーター

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

戻り値

アクティブなプロファイルの ID。アクティブなプロファイルがない場合は空のテキスト。

2 個の例: Windows の通知, 次のジェスチャプロファイルに切り替える

GestureProfileGetEnumeratedIdAt

GestureProfileGetEnumeratedIdAt(index: Integer) → Text

このスクリプトで最後に GestureProfileEnumerateAll が作成した一覧から、プロファイルの ID を 1 つ返します。その ID を GestureProfileSwitch に渡します。

パラメーター

index: Integer — 一覧内の 0 から始まる位置。0 から数 - 1 まで。

戻り値

プロファイルの ID。index が範囲外の場合、または GestureProfileEnumerateAll が呼び出されていない場合は空のテキスト。

GestureProfileGetEnumeratedNameAt

GestureProfileGetEnumeratedNameAt(index: Integer) → Text

このスクリプトで最後に GestureProfileEnumerateAll が作成した一覧から、プロファイルの表示名を 1 つ返します。

パラメーター

index: Integer — 一覧内の 0 から始まる位置。0 から数 - 1 まで。

戻り値

プロファイルの名前。index が範囲外の場合、または GestureProfileEnumerateAll が呼び出されていない場合は空のテキスト。

GestureProfileSwitch

GestureProfileSwitch(profileId: Text) → Bool · シンプル

通知領域のメニューから選択した場合と同様に別のジェスチャプロファイルに切り替え、再起動後もその選択を記憶します。切り替えは呼び出しから戻った直後に行われます。

パラメーター

profileId: Text — 切り替え先のプロファイルの ID (GestureProfileGetEnumeratedIdAt で取得したものなど)。プロファイルなしにする場合は空のテキスト。

戻り値

要求が送信された場合は true。どのプロファイルにもない ID の場合は false で、何も変わりません。切り替えは呼び出しから戻った直後に行われます。確認するには GestureProfileGetActiveId を使用してください。

3 個の例: プログラムを起動し、そのウィンドウを待って操作する, 今日の日付とタイムスタンプ付きのファイル名, 署名を入力する

Keyboard

KeyboardGetKeyState

KeyboardGetKeyState(key: Integer) → Integer

キーの現在の Windows の生の状態を返します。UAC のプロンプトやロック画面など別のデスクトップが前面にある間は、すべてのキーが離された状態として読み取られます。単純なはい/いいえが必要な場合は KeyboardIsKeyDown または KeyboardIsKeyToggled を使用してください。

パラメーター

key: Integer — VirtualKey.CapsLock などの VirtualKey 定数、または 0 から 255 までの仮想キーコード。それ以外の値の場合は、エラーでスクリプトが停止します。

戻り値

生の Integer。キーが押されている場合は負の値 (最上位ビットがオン)、Caps Lock などのロックキーがオンの場合は奇数 (最下位ビットがオン)。

1 個の例: キーの状態のビット

KeyboardGetKeyStateAsync

KeyboardGetKeyStateAsync(key: Integer) → Integer

どのウィンドウにフォーカスがあるかにかかわらず、まさにこの瞬間のキーの Windows の生の状態を返します。

パラメーター

key: Integer — VirtualKey.ShiftKey などの VirtualKey 定数、または 0 から 255 までの仮想キーコード。それ以外の値の場合は、エラーでスクリプトが停止します。

戻り値

生の Integer。キーが今押されている場合は負の値 (最上位ビットがオン)。前回の確認以降にキーが押された場合は最下位ビットがオンになることがありますが、Windows はこれを保証しません。

KeyboardIsKeyDown

KeyboardIsKeyDown(key: Integer) → Bool

キーが今押されたままかどうかを確認します。UAC のプロンプトやロック画面など別のデスクトップが前面にある間は、すべてのキーが離された状態として読み取られます。

パラメーター

key: Integer — VirtualKey.ControlKey などの VirtualKey 定数、または 0 から 255 までの仮想キーコード。それ以外の値の場合は、エラーでスクリプトが停止します。

戻り値

キーが押されている場合は true。離されている場合は false。

2 個の例: キーの状態のビット, Ctrl キーを押している間は動作を変える

KeyboardIsKeyToggled

KeyboardIsKeyToggled(key: Integer) → Bool

ロックキーがオンになっているかどうかを確認します。意味があるのは VirtualKey.CapsLock、VirtualKey.NumLock、VirtualKey.Scroll だけです。

パラメーター

key: Integer — VirtualKey.CapsLock などの VirtualKey 定数、または 0 から 255 までの仮想キーコード。それ以外の値の場合は、エラーでスクリプトが停止します。

戻り値

ロックキーがオンの場合は true。オフの場合は false。

1 個の例: キーの状態のビット

KeyboardKeyDown

KeyboardKeyDown(key: Integer) → Bool

キーを押し、KeyboardKeyUp で離すまで押したままにします。[メディアキーとブラウザーキーをコマンドとして送信する] 設定がオンの場合、メディアキー、音量キー、ブラウザーキーは代わりにそのコマンドを送信します。

パラメーター

key: Integer — VirtualKey.ShiftKey などの VirtualKey 定数、または 0 から 255 までの仮想キーコード。それ以外の値の場合は、エラーでスクリプトが停止します。

戻り値

キーの押下が送信された場合は true。Windows がブロックした場合、またはコマンドとして送信されるキーでフォーカスのあるウィンドウがない場合は false。

1 個の例: Shift キーを押しながらクリックする

KeyboardKeyUp

KeyboardKeyUp(key: Integer) → Bool

KeyboardKeyDown で押したキーを離します。コマンドとして送信されるメディアキー、音量キー、ブラウザーキーの場合は、押した時点でコマンドが送信済みのため何も行いません。

パラメーター

key: Integer — VirtualKey.ShiftKey などの VirtualKey 定数、または 0 から 255 までの仮想キーコード。それ以外の値の場合は、エラーでスクリプトが停止します。

戻り値

キーの解放が送信された場合は true (コマンドとして送信されるキーでは常に true)。Windows がブロックした場合は false。

1 個の例: Shift キーを押しながらクリックする

KeyboardPressKey

KeyboardPressKey(key: Integer) → Bool · シンプル

キーを 1 つ押して離します。メディアキーを含め、Windows にコードがある任意のキーを指定できます。[メディアキーとブラウザーキーをコマンドとして送信する] 設定がオンの場合、それらのキーは代わりにそのコマンドを送信します。

パラメーター

key: Integer — VirtualKey.MediaPlayPause などの VirtualKey 定数、または 0 から 255 までの仮想キーコード。それ以外の値の場合は、エラーでスクリプトが停止します。

戻り値

3 個の例: 名前付き定数と数値の比較, メディアキー, シリアルデバイスのボタンをメディアキーに割り当てる

KeyboardPressKeyCombo

KeyboardPressKeyCombo(combo: Text) → Bool · シンプル

Ctrl+C などのキーの組み合わせを 1 つ押します。修飾キーを押したまま、キーを押して離し、その後修飾キーを離します。1 回の呼び出しで送信する組み合わせは 1 つです。

パラメーター

combo: Text — 省略可能な修飾記号 (Ctrl は ^、Shift は +、Windows は @、Alt はパーセント記号) の後に、1 文字の英字か数字、または {ENTER}、{F5}、{LEFT} のように中かっこで囲んだキー名 (大文字と小文字は問いません) を続けます。例: '^c' は Ctrl+C です。

戻り値

キー入力が送信された場合は true。Windows がブロックした場合は false。解釈できない combo の場合は、エラーでスクリプトが停止します。

4 個の例: キーの組み合わせ, 署名を入力する, 選択したテキストを大文字にする, 選択範囲を Web で検索する

KeyboardTypeText

KeyboardTypeText(text: Text) → Bool · シンプル

キーボードレイアウトにかかわらず、任意の言語のテキストを絵文字も含めて 1 文字ずつ、フォーカスのあるウィンドウに入力します。各文字の前に [入力の遅延] 設定の時間だけ待機します。

パラメーター

text: Text — 入力するテキスト。各改行は Enter キーの 1 回の押下として送信されます。テキスト展開のスクリプトでは、トリガーを終了させたキーがその後に入力されます。

戻り値

すべての文字が送信された場合、またはテキストが空の場合は true。Windows が一部をブロックした場合は false。

Macro

MacroClearTemporary

MacroClearTemporary() → Bool

MacroRecordTemporary で記録したマクロを破棄します。

パラメーター

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

戻り値

破棄する記録済みのマクロがあった場合は true。なかった場合は false。

MacroExpectFocusedWindow

MacroExpectFocusedWindow(exeName: Text, windowClass: Text) → Bool

フォアグラウンドウィンドウが指定したプログラムとウィンドウクラスのものになるまで、設定の [再生時のウィンドウ待機] の時間 (既定は 2 秒) を上限に待機します。一致しないままの場合は、通知を表示してスクリプトを停止します。

パラメーター

exeName: Text — プログラムのファイル名 (notepad.exe など)。大文字と小文字は区別されません。空のテキストは任意のプログラムに一致します。
windowClass: Text — トップレベルウィンドウのクラス名 (Notepad など)。大文字と小文字は区別されません。空のテキストは任意のクラスに一致します。

戻り値

ウィンドウが一致した時点で true。待機中にスクリプトの停止が要求された場合は false。

MacroExpectWindowAt

MacroExpectWindowAt(x: Integer, y: Integer, exeName: Text, windowClass: Text) → Bool

画面上の点にあるトップレベルウィンドウが指定したプログラムとウィンドウクラスのものになるまで、設定の [再生時のウィンドウ待機] の時間 (既定は 2 秒) を上限に待機します。一致しないままの場合は、通知を表示してスクリプトを停止します。

パラメーター

x: Integer — 確認する画面上の水平位置 (仮想画面のピクセル単位)。
y: Integer — 確認する画面上の垂直位置 (仮想画面のピクセル単位)。
exeName: Text — プログラムのファイル名 (notepad.exe など)。大文字と小文字は区別されません。空のテキストは任意のプログラムに一致します。
windowClass: Text — トップレベルウィンドウのクラス名 (Notepad など)。大文字と小文字は区別されません。空のテキストは任意のクラスに一致します。

戻り値

ウィンドウが一致した時点で true。待機中にスクリプトの停止が要求された場合は false。

MacroGetTemporaryScript

MacroGetTemporaryScript() → Text

MacroRecordTemporary で記録したマクロをステップスクリプトのテキストとして返し、スクリプトで保存したり内容を調べたりできるようにします。

パラメーター

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

戻り値

最後に完了した記録のステップテキスト。何も記録されていない場合、またはクリアされた場合は空のテキスト。新しい記録の実行中は、引き続き前回の記録を返します。

MacroPlayTemporary

MacroPlayTemporary(timeoutSeconds: Integer) → Bool

MacroRecordTemporary で記録したマクロを再生し、完了するかタイムアウトになるまで待機します。再生中、ユーザーの実際のマウスとキーボードの入力は保留されます。

パラメーター

timeoutSeconds: Integer — 待機する最大時間 (秒)。1 以上を指定してください。それ以外の場合はエラーでスクリプトが停止します。この時間を過ぎても実行中のマクロは続行されますが、実際の入力は保留されなくなります。

戻り値

マクロが時間内に最後まで再生された場合は true。何も記録されていない場合、ステップまたはウィンドウの確認に失敗した場合、再生が停止された場合、またはタイムアウトの時点でまだ実行中だった場合は false。

MacroRecordTemporary

MacroRecordTemporary() → Bool

マウスとキーボードの入力を、メモリに保持される一時マクロに記録し始めます。停止するには Ctrl+Break キーを押します。記録が始まる前にすぐ戻ります。先に確認ボックスが表示される場合があります。

パラメーター

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

戻り値

記録の要求が送信された場合は true。記録が既に実行中、開始中、または要求済みの場合、あるいはエンジンの起動が完了していない場合は false。

Math

MathAbs

MathAbs(value: Any) → Any

数値の絶対値、つまりマイナス記号を取り除いた数値を返します。Integer と Real の値に使用できます。

パラメーター

value: Any — Integer または Real の数値。

戻り値

value と同じ種類 (Integer または Real) の絶対値。NaN または無限大の Real の場合は 0.0。数値ではない値の場合は、エラーでアクションが停止します。

2 個の例: 値を範囲内に収める, ストロークはどの方向に描かれたか

MathAtan2

MathAtan2(y: Any, x: Any) → Real

原点から点 (x, y) への角度をラジアンで返します。画面の y は下向きに増えるため、通常の数学の向きでストロークの角度を求めるには、垂直方向の変化量の符号を反転して渡してください。

パラメーター

y: Any — 点の垂直座標。Integer または Real。y が先であることに注意してください。
x: Any — 点の水平座標。Integer または Real。

戻り値

-pi から pi までの角度 (ラジアン) の Real。どちらかの引数が NaN または無限大の場合は 0.0。数値ではない引数の場合は、エラーでアクションが停止します。

MathCeil

MathCeil(value: Real) → Integer

数値を切り上げて最も近い整数にします。MathCeil(2.1) は 3、MathCeil(-2.1) は -2 です。

パラメーター

value: Real — 切り上げる数値。Integer はそのまま受け付けられます。

戻り値

丸めた値の Integer。value が NaN または無限大の場合は 0。Integer の範囲を超える値の場合は、Integer の最大値または最小値になります。

1 個の例: 丸めと Real の Math 組み込み関数

MathClamp

MathClamp(value: Any, min: Any, max: Any) → Any

数値を範囲内に収めます。value が min より小さい場合は min、max より大きい場合は max、それ以外の場合は value を返します。Integer と Real の値に使用できます。

パラメーター

value: Any — 範囲内に収める数値。
min: Any — 許容される最小値。max より大きくすることはできません。
max: Any — 許容される最大値。

戻り値

value、min、max のうち選ばれたもの (元の種類である Integer または Real のまま)。いずれかの引数が NaN または無限大の場合は 0.0。数値ではない場合、または min が max より大きい場合は、エラーでアクションが停止します。

1 個の例: 値を範囲内に収める

MathCos

MathCos(radians: Real) → Real

ラジアンで指定した角度のコサインを返します。度から変換するには、MathGetPi() を掛けて 180 で割ります。

パラメーター

radians: Real — ラジアン単位の角度。Integer はそのまま受け付けられます。

戻り値

-1 から 1 までのコサインの Real。radians が NaN または無限大の場合は 0.0。

1 個の例: マウスを円を描くように動かす

MathFloor

MathFloor(value: Real) → Integer

数値を切り捨てて最も近い整数にします。MathFloor(2.9) は 2、MathFloor(-2.1) は -3 です。

パラメーター

value: Real — 切り捨てる数値。Integer はそのまま受け付けられます。

戻り値

丸めた値の Integer。value が NaN または無限大の場合は 0。Integer の範囲を超える値の場合は、Integer の最大値または最小値になります。

1 個の例: 丸めと Real の Math 組み込み関数

MathGetE

MathGetE() → Real

自然対数の底である数学定数 e (約 2.71828) を返します。

パラメーター

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

戻り値

e の値の Real。

MathGetPi

MathGetPi() → Real

数学定数 pi (約 3.14159) を返します。度とラジアンの変換に使用します。

パラメーター

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

戻り値

pi の値の Real。

1 個の例: マウスを円を描くように動かす

MathLog

MathLog(value: Real) → Real

数値の自然対数 (底 e) を返します。底が 10 の対数を求めるには、MathLog(10.0) で割ります。

パラメーター

value: Real — 0 より大きい数値。Integer はそのまま受け付けられます。

戻り値

自然対数の Real。value が 0、負の値、NaN、無限大のいずれかの場合は 0。

MathMax

MathMax(a: Any, b: Any) → Any

2 つの数値のうち大きい方を返します。Integer と Real の値に使用できます。

パラメーター

a: Any — 1 つ目の数値。
b: Any — 2 つ目の数値。

戻り値

a と b のうち大きい方 (元の種類のまま)。等しい場合は a。どちらかが NaN または無限大の場合は 0.0。数値ではない引数の場合は、エラーでアクションが停止します。

MathMin

MathMin(a: Any, b: Any) → Any

2 つの数値のうち小さい方を返します。Integer と Real の値に使用できます。

パラメーター

a: Any — 1 つ目の数値。
b: Any — 2 つ目の数値。

戻り値

a と b のうち小さい方 (元の種類のまま)。等しい場合は a。どちらかが NaN または無限大の場合は 0.0。数値ではない引数の場合は、エラーでアクションが停止します。

1 個の例: 画面表示付きで音量を上げる

MathMod

MathMod(value: Any, divisor: Any) → Any

value を divisor で割った余りを返します。結果は除数の符号に従うため、MathMod(-30, 360) は 330 になります。角度を一周させたり、インデックスを循環させたりするのに適しています。

パラメーター

value: Any — 割られる数値。Integer または Real。
divisor: Any — 割る数値。Integer または Real。

戻り値

余り。両方の引数が Integer の場合は Integer、それ以外の場合は Real。divisor が 0 の場合、またはどちらかの引数が NaN または無限大の場合は 0。数値ではない引数の場合は、エラーでアクションが停止します。

MathPow

MathPow(base: Real, exponent: Real) → Real

数値をべき乗します (2 乗や 3 乗など)。MathPow(2.0, 10.0) は 1024 です。

パラメーター

base: Real — べき乗する数値。Integer はそのまま受け付けられます。
exponent: Real — 指数。負の値や小数も指定できます。0.5 の場合は平方根になります。

戻り値

結果の Real。引数が NaN または無限大の場合、または有限の結果にならない場合 (0 の負のべき乗や、保持できないほど大きな結果など) は 0。

MathRandom

MathRandom(min: Integer, max: Integer) → Integer

min から max まで (両端を含む) のランダムな整数を返します。MathRandom(1, 6) はサイコロを振ることに相当します。

パラメーター

min: Integer — 結果として取り得る最小値。
max: Integer — 結果として取り得る最大値。min より小さくすることはできません。

戻り値

min から max までのランダムな Integer。min が max より大きい場合は、エラーでアクションが停止します。

2 個の例: 終了フラグ付きの while (true), 乱数とコイン投げ

MathRound

MathRound(value: Real) → Integer

数値を最も近い整数に丸めます。ちょうど半分の場合は 0 から遠い方に丸められ、2.5 は 3、-2.5 は -3 になります。

パラメーター

value: Real — 丸める数値。小数点以下 2 桁を整数として残すには、value に 100 を掛けてから丸めます。

戻り値

丸めた値の Integer。value が NaN または無限大の場合は 0。Integer の範囲を超える値の場合は、Integer の最大値または最小値になります。

5 個の例: 丸めと Real の Math 組み込み関数, ジェスチャのストロークの長さ, マウスを円を描くように動かす, 小数点以下 6 桁にせずに Real を書式設定する, 画面表示付きで音量を上げる

MathSin

MathSin(radians: Real) → Real

ラジアンで指定した角度のサインを返します。度から変換するには、MathGetPi() を掛けて 180 で割ります。

パラメーター

radians: Real — ラジアン単位の角度。Integer はそのまま受け付けられます。

戻り値

-1 から 1 までのサインの Real。radians が NaN または無限大の場合は 0.0。

1 個の例: マウスを円を描くように動かす

MathSqrt

MathSqrt(value: Real) → Real

数値の平方根を返します。MathSqrt(dx * dx + dy * dy) は 2 点間の距離です。

パラメーター

value: Real — 0 以上の数値。Integer はそのまま受け付けられます。

戻り値

平方根の Real。value が負の値、NaN、無限大のいずれかの場合は 0。

2 個の例: 丸めと Real の Math 組み込み関数, ジェスチャのストロークの長さ

MathTan

MathTan(radians: Real) → Real

ラジアンで指定した角度のタンジェントを返します。直角に近づくと結果は非常に大きくなります。

パラメーター

radians: Real — ラジアン単位の角度。Integer はそのまま受け付けられます。

戻り値

タンジェントの Real。radians が NaN または無限大の場合は 0.0。

Mouse

MouseButtonDown

MouseButtonDown(button: Integer) → Bool

現在のカーソル位置でマウスボタンを押し、MouseButtonUp まで押したままにします。MouseMoveTo と組み合わせるとドラッグをスクリプト化できます。

パラメーター

button: Integer — MouseButton.Primary などの MouseButton 定数。Primary と Secondary は Windows のボタンの入れ替え設定に従い、Left と Right は物理的なボタンです。

戻り値

ボタンの押下が送信された場合は true。Windows がブロックした場合は false。不明なボタンの場合は、エラーでスクリプトが停止します。

1 個の例: スクリプトによるドラッグ

MouseButtonUp

MouseButtonUp(button: Integer) → Bool

現在のカーソル位置でマウスボタンを離します。通常は MouseButtonDown で押したボタンに使用します。

パラメーター

button: Integer — MouseButton.Primary などの MouseButton 定数。Primary と Secondary は Windows のボタンの入れ替え設定に従い、Left と Right は物理的なボタンです。

戻り値

ボタンの解放が送信された場合は true。Windows がブロックした場合は false。不明なボタンの場合は、エラーでスクリプトが停止します。

1 個の例: スクリプトによるドラッグ

MouseClick

MouseClick(x: Integer, y: Integer, button: Integer) → Bool · シンプル

カーソルを画面上の点に移動し、そこでマウスボタンをクリックします。その後、カーソルはその位置に留まります。

パラメーター

x: Integer — クリックする画面上の水平位置 (ピクセル単位)。
y: Integer — クリックする画面上の垂直位置 (ピクセル単位)。
button: Integer — MouseButton.Primary などの MouseButton 定数。Primary と Secondary は Windows のボタンの入れ替え設定に従い、Left と Right は物理的なボタンです。

戻り値

クリックが送信された場合は true。カーソルをその点に移動できなかった場合 (この場合は何もクリックされません)、または Windows がクリックをブロックした場合は false。不明なボタンの場合は、エラーでスクリプトが停止します。

2 個の例: どこかをクリックしてカーソルを元に戻す, Shift キーを押しながらクリックする

MouseClickAtClientPoint

MouseClickAtClientPoint(window: Window, x: Integer, y: Integer, button: Integer) → Bool

ウィンドウのクライアント領域 (タイトルバーと境界線を除いた内側) の左上隅から測った点で、マウスボタンをクリックします。カーソルはそこに移動し、そのまま留まります。

パラメーター

window: Window — x と y の基準となるクライアント領域を持つウィンドウ。
x: Integer — クライアント領域の左端からの距離 (そのウィンドウ自身のピクセル単位)。Windows が DPI に合わせてスケーリングするウィンドウでは、画面のピクセルと異なる場合があります。
y: Integer — クライアント領域の上端からの距離 (そのウィンドウ自身のピクセル単位)。Windows が DPI に合わせてスケーリングするウィンドウでは、画面のピクセルと異なる場合があります。
button: Integer — MouseButton.Primary などの MouseButton 定数。Primary と Secondary は Windows のボタンの入れ替え設定に従い、Left と Right は物理的なボタンです。

戻り値

クリックが送信された場合は true。ウィンドウが無効か既に存在しない場合、カーソルをその点に移動できなかった場合 (これらの場合は何もクリックされません)、または Windows がクリックをブロックした場合は false。不明なボタンの場合は、エラーでスクリプトが停止します。

1 個の例: ウィンドウ内の点をクリックする

MouseDoubleClick

MouseDoubleClick(x: Integer, y: Integer, button: Integer) → Bool · シンプル

カーソルを画面上の点に移動し、そこでマウスボタンをダブルクリックします。その後、カーソルはその位置に留まります。

パラメーター

x: Integer — ダブルクリックする画面上の水平位置 (ピクセル単位)。
y: Integer — ダブルクリックする画面上の垂直位置 (ピクセル単位)。
button: Integer — MouseButton.Primary などの MouseButton 定数。Primary と Secondary は Windows のボタンの入れ替え設定に従い、Left と Right は物理的なボタンです。

戻り値

両方のクリックが送信された場合は true。カーソルをその点に移動できなかった場合 (この場合は何もクリックされません)、または Windows がクリックをブロックした場合は false。不明なボタンの場合は、エラーでスクリプトが停止します。

MouseGetCursorX

MouseGetCursorX() → Integer

マウスカーソルの画面上の水平位置を返します。

パラメーター

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

戻り値

カーソルの x 位置 (画面のピクセル単位)。プライマリモニターより左にあるモニター上では負の値。

8 個の例: else-if の連鎖, マウスを円を描くように動かす, カーソルの下のピクセルの色を読み取る, カーソルの下にある 3×2 グリッドのセルにウィンドウをスナップする, カーソルの下にあるものを説明する, どこかをクリックしてカーソルを元に戻す, スクリプトによるドラッグ, Shift キーを押しながらクリックする

MouseGetCursorY

MouseGetCursorY() → Integer

マウスカーソルの画面上の垂直位置を返します。

パラメーター

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

戻り値

カーソルの y 位置 (画面のピクセル単位)。プライマリモニターより上にあるモニター上では負の値。

MouseIsButtonDown

MouseIsButtonDown(button: Integer) → Bool

マウスボタンが現時点で押されたままかどうかを確認します。

パラメーター

button: Integer — MouseButton.Primary などの MouseButton 定数。Primary と Secondary は Windows のボタンの入れ替え設定に従い、Left と Right は物理的なボタンです。

戻り値

ボタンが押されている場合は true。離されている場合は false。不明なボタンの場合は、エラーでスクリプトが停止します。

MouseLockToRect

MouseLockToRect(x: Integer, y: Integer, width: Integer, height: Integer) → Bool

マウスカーソルを画面上の四角形の中に制限します。この制限はスクリプトの終了後も、MouseUnlock が呼び出されるか別のプログラムが変更するまで続くため、使い終わったら必ず解除してください。

パラメーター

x: Integer — 四角形の左端 (画面のピクセル単位)。
y: Integer — 四角形の上端 (画面のピクセル単位)。
width: Integer — 四角形の幅 (ピクセル単位)。0 より大きい値を指定する必要があります。
height: Integer — 四角形の高さ (ピクセル単位)。0 より大きい値を指定する必要があります。

戻り値

カーソルが制限された場合は true。width または height が正の値でない場合、または Windows が拒否した場合は false。

1 個の例: カーソルを 5 秒間ウィンドウ内に制限する

MouseMoveTo

MouseMoveTo(x: Integer, y: Integer) → Bool · シンプル

ユーザーがマウスを動かしたのと同じように、マウスカーソルを任意のモニター上の画面の点に移動します。

パラメーター

x: Integer — 画面上の水平位置 (ピクセル単位)。
y: Integer — 画面上の垂直位置 (ピクセル単位)。

戻り値

移動が送信された場合は true。Windows がブロックした場合は false。

3 個の例: マウスを円を描くように動かす, どこかをクリックしてカーソルを元に戻す, スクリプトによるドラッグ

MouseScrollHorizontal

MouseScrollHorizontal(amount: Integer) → Bool · シンプル

現在のカーソル位置で水平方向のマウスホイールを回します。別の場所をスクロールするには、先に MouseMoveTo を使用してください。

パラメーター

amount: Integer — ホイールの回転量 (120 が 1 ノッチ)。正の値で右に、負の値で左にスクロールします。対応しているアプリでは、より小さい値でより細かくスクロールします。

戻り値

スクロールが送信された場合は true。Windows がブロックした場合は false。

1 個の例: ノッチ単位でスクロールする

MouseScrollVertical

MouseScrollVertical(amount: Integer) → Bool · シンプル

現在のカーソル位置で垂直方向のマウスホイールを回します。別の場所をスクロールするには、先に MouseMoveTo を使用してください。

パラメーター

amount: Integer — ホイールの回転量 (120 が 1 ノッチ)。正の値で上に、負の値で下にスクロールします。対応しているアプリでは、より小さい値でより細かくスクロールします。

戻り値

スクロールが送信された場合は true。Windows がブロックした場合は false。

1 個の例: ノッチ単位でスクロールする

MouseUnlock

MouseUnlock() → Bool

MouseLockToRect によるものか別のプログラムによるものかにかかわらず、マウスカーソルの制限をすべて解除します。

パラメーター

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

戻り値

カーソルの制限が解除された場合は true。Windows が拒否した場合は false。

1 個の例: カーソルを 5 秒間ウィンドウ内に制限する

Multimedia

MultimediaGetMute

MultimediaGetMute(endpoint: Integer) → Bool

endpoint で選んだ既定の再生デバイスまたはマイクが、Windows でミュートになっているかどうかを返します。

パラメーター

endpoint: Integer — 確認するデバイス: AudioEndpoint.Playback (既定のスピーカーまたはヘッドホン)、AudioEndpoint.Capture (既定のマイク)、AudioEndpoint.Communications (Windows が通話に使用するマイク)。それ以外の値の場合は、エラーでアクションが停止します。

戻り値

デバイスがミュートの場合は true。ミュートでない場合、またはデバイスが存在しない場合 (マイクが接続されていない場合など) は false。

1 個の例: マイクのミュートを切り替える

MultimediaGetVolume

MultimediaGetVolume(endpoint: Integer) → Real

endpoint で選んだ既定の再生デバイスまたはマイクのマスター音量を、0.0 から 1.0 までの Real として返します。

パラメーター

endpoint: Integer — 読み取るデバイス: AudioEndpoint.Playback (既定のスピーカーまたはヘッドホン)、AudioEndpoint.Capture (既定のマイク)、AudioEndpoint.Communications (Windows が通話に使用するマイク)。それ以外の値の場合は、エラーでアクションが停止します。

戻り値

0.0 (無音) から 1.0 (最大) までの音量。MultimediaSetVolume と同じ尺度です。デバイスが存在しない場合は 0.0。

1 個の例: 画面表示付きで音量を上げる

MultimediaPlayMp3File

MultimediaPlayMp3File(path: Text) → Bool · シンプル

MP3 ファイルの再生を開始し、再生中にすぐ戻ります。別の MP3 を開始すると、再生中のものは停止します。

パラメーター

path: Text — .mp3 ファイルの完全パス (C:/Music/done.mp3 など)。

戻り値

再生が開始された場合は true。ファイルが存在しない場合、Windows が 10 秒以内にファイルを開けないか再生できない場合、または [すべて停止] で待機が終了した場合は false。

MultimediaPlayWavFile

MultimediaPlayWavFile(path: Text) → Bool · シンプル

.wav サウンドファイルの再生を開始し、再生中にすぐ戻ります。別の WAV を開始すると、再生中のものは停止します。使用できるのは .wav ファイルだけです。MP3 には MultimediaPlayMp3File を使用してください。

パラメーター

path: Text — .wav ファイルの完全パス (C:/Windows/Media/chimes.wav など)。

戻り値

ファイルが存在し、再生が開始された場合は true。そのパスにファイルがない場合は false。存在するが再生可能な WAV でないファイルの場合は、true を返して何も再生しません。

1 個の例: サウンドを再生する

MultimediaSetMute

MultimediaSetMute(endpoint: Integer, muted: Bool) → Bool · シンプル

Windows の音量のミュートボタンと同様に、endpoint で選んだ既定の再生デバイスまたはマイクをミュートまたはミュート解除します。

パラメーター

endpoint: Integer — 変更するデバイス: AudioEndpoint.Playback (既定のスピーカーまたはヘッドホン)、AudioEndpoint.Capture (既定のマイク)、AudioEndpoint.Communications (Windows が通話に使用するマイク)。それ以外の値の場合は、エラーでアクションが停止します。
muted: Bool — true の場合はデバイスをミュートします。false の場合はミュートを解除します。

戻り値

ミュートの状態が設定された場合は true。デバイスが存在しない場合、またはデバイスが変更を拒否した場合は false。

1 個の例: 実行をまたいで保持されるトグル

MultimediaSetVolume

MultimediaSetVolume(endpoint: Integer, level: Real) → Bool · シンプル

endpoint で選んだ既定の再生デバイスまたはマイクのマスター音量を、正確なレベルに設定します。

パラメーター

endpoint: Integer — 変更するデバイス: AudioEndpoint.Playback (既定のスピーカーまたはヘッドホン)、AudioEndpoint.Capture (既定のマイク)、AudioEndpoint.Communications (Windows が通話に使用するマイク)。それ以外の値の場合は、エラーでアクションが停止します。
level: Real — 0.0 (無音) から 1.0 (最大) までの新しい音量。0.5 は Windows の音量スライダーの 50 に相当します。0.0 から 1.0 の範囲外の値は範囲内に収められます。

戻り値

音量が設定された場合は true。デバイスが存在しない場合、またはデバイスが変更を拒否した場合は false。

2 個の例: 画面表示付きで音量を上げる, Arduino のノブを音量調節に使う

MultimediaToggleMute

MultimediaToggleMute(endpoint: Integer) → Bool · シンプル

endpoint で選んだ既定の再生デバイスまたはマイクを、ミュート解除中ならミュートし、ミュート中ならミュート解除します。新しい状態を知るには、後で MultimediaGetMute を呼び出してください。

パラメーター

endpoint: Integer — 切り替えるデバイス: AudioEndpoint.Playback (既定のスピーカーまたはヘッドホン)、AudioEndpoint.Capture (既定のマイク)、AudioEndpoint.Communications (Windows が通話に使用するマイク)。それ以外の値の場合は、エラーでアクションが停止します。

戻り値

ミュートの状態が切り替えられた場合は true。デバイスが存在しない場合、またはデバイスが変更を拒否した場合は false。これは新しいミュートの状態ではありません。

1 個の例: マイクのミュートを切り替える

Plugin

PluginSendMessage

PluginSendMessage(pluginName: Text, message: Text, timeoutSeconds: Integer) → Text

コマンドを受け付ける実行中のプラグインにテキストメッセージを送信し、その応答を待ちます。プラグインは一度に 1 つのメッセージを処理し、処理中に送信されたメッセージはキューで待機します。

パラメーター

pluginName: Text — プラグインの表示名。大文字と小文字を含めて完全に一致する必要があります。
message: Text — 送信するテキスト。その意味はプラグインによって決まります。
timeoutSeconds: Integer — 応答を待つ時間 (秒)。0 から 10 まで。それ以外の値の場合は、エラーでスクリプトが停止します。0 の場合は、すぐに空のテキストで戻ります。

戻り値

プラグインの応答。時間内に応答がなかった場合は空のテキスト。該当する実行中のプラグインがない場合、キューがいっぱいの場合、またはメッセージが長すぎる場合は、エラーでスクリプトが停止します。

1 個の例: プラグインと通信する

Region

RegionGetCellIndexAt

RegionGetCellIndexAt(rectX: Integer, rectY: Integer, rectWidth: Integer, rectHeight: Integer, columns: Integer, rows: Integer, pointX: Integer, pointY: Integer) → Integer

四角形を列と行のグリッドに分割し、点を含むセルを返します。セルには 0 から、左から右、次に上から下の順に番号が付けられます。

パラメーター

rectX: Integer — 分割する四角形の左端 (ピクセル単位)。
rectY: Integer — 分割する四角形の上端 (ピクセル単位)。
rectWidth: Integer — 四角形の幅 (ピクセル単位)。0 より大きい値を指定する必要があります。
rectHeight: Integer — 四角形の高さ (ピクセル単位)。0 より大きい値を指定する必要があります。
columns: Integer — グリッドの列数。0 より大きい値を指定する必要があります。余ったピクセルは先頭の列から 1 つずつ割り当てられます。
rows: Integer — グリッドの行数。0 より大きい値を指定する必要があります。余ったピクセルは先頭の行から 1 つずつ割り当てられます。
pointX: Integer — 調べる点の水平位置 (rectX と同じピクセル単位)。
pointY: Integer — 調べる点の垂直位置 (rectY と同じピクセル単位)。

戻り値

セル番号 (行 × 列数 + 列)。点が四角形の外にある場合、または rectWidth、rectHeight、columns、rows のいずれかが正の値でない場合は -1。

RegionGetHeight

RegionGetHeight(rectX: Integer, rectY: Integer, rectWidth: Integer, rectHeight: Integer, columns: Integer, rows: Integer, index: Integer) → Integer

四角形を列と行のグリッドに分割したときの、1 つのセルの高さを返します。余ったピクセルは先頭の行から 1 つずつ割り当てられます。

パラメーター

rectX: Integer — 分割する四角形の左端 (ピクセル単位)。
rectY: Integer — 分割する四角形の上端 (ピクセル単位)。
rectWidth: Integer — 四角形の幅 (ピクセル単位)。0 より大きい値を指定する必要があります。
rectHeight: Integer — 四角形の高さ (ピクセル単位)。0 より大きい値を指定する必要があります。
columns: Integer — グリッドの列数。0 より大きい値を指定する必要があります。
rows: Integer — グリッドの行数。0 より大きい値を指定する必要があります。
index: Integer — 0 から始まるセル番号。左から右、次に上から下の順に数え、0 から columns × rows - 1 まで。

戻り値

セルの高さ (ピクセル単位)。index が範囲外の場合、または rectWidth、rectHeight、columns、rows のいずれかが正の値でない場合は -1。

RegionGetWidth

RegionGetWidth(rectX: Integer, rectY: Integer, rectWidth: Integer, rectHeight: Integer, columns: Integer, rows: Integer, index: Integer) → Integer

四角形を列と行のグリッドに分割したときの、1 つのセルの幅を返します。余ったピクセルは先頭の列から 1 つずつ割り当てられます。

パラメーター

rectX: Integer — 分割する四角形の左端 (ピクセル単位)。
rectY: Integer — 分割する四角形の上端 (ピクセル単位)。
rectWidth: Integer — 四角形の幅 (ピクセル単位)。0 より大きい値を指定する必要があります。
rectHeight: Integer — 四角形の高さ (ピクセル単位)。0 より大きい値を指定する必要があります。
columns: Integer — グリッドの列数。0 より大きい値を指定する必要があります。
rows: Integer — グリッドの行数。0 より大きい値を指定する必要があります。
index: Integer — 0 から始まるセル番号。左から右、次に上から下の順に数え、0 から columns × rows - 1 まで。

戻り値

セルの幅 (ピクセル単位)。index が範囲外の場合、または rectWidth、rectHeight、columns、rows のいずれかが正の値でない場合は -1。

RegionGetX

RegionGetX(rectX: Integer, rectY: Integer, rectWidth: Integer, rectHeight: Integer, columns: Integer, rows: Integer, index: Integer) → Integer

四角形を列と行のグリッドに分割したときの、1 つのセルの左端を返します。余ったピクセルは先頭の列から 1 つずつ割り当てられます。

パラメーター

rectX: Integer — 分割する四角形の左端 (ピクセル単位)。
rectY: Integer — 分割する四角形の上端 (ピクセル単位)。
rectWidth: Integer — 四角形の幅 (ピクセル単位)。0 より大きい値を指定する必要があります。
rectHeight: Integer — 四角形の高さ (ピクセル単位)。0 より大きい値を指定する必要があります。
columns: Integer — グリッドの列数。0 より大きい値を指定する必要があります。
rows: Integer — グリッドの行数。0 より大きい値を指定する必要があります。
index: Integer — 0 から始まるセル番号。左から右、次に上から下の順に数え、0 から columns × rows - 1 まで。

戻り値

セルの左端。index が範囲外の場合、または rectWidth、rectHeight、columns、rows のいずれかが正の値でない場合は -1。実際のセルが -1 から始まることもあるため、先に index を確認してください。

RegionGetY

RegionGetY(rectX: Integer, rectY: Integer, rectWidth: Integer, rectHeight: Integer, columns: Integer, rows: Integer, index: Integer) → Integer

四角形を列と行のグリッドに分割したときの、1 つのセルの上端を返します。余ったピクセルは先頭の行から 1 つずつ割り当てられます。

パラメーター

rectX: Integer — 分割する四角形の左端 (ピクセル単位)。
rectY: Integer — 分割する四角形の上端 (ピクセル単位)。
rectWidth: Integer — 四角形の幅 (ピクセル単位)。0 より大きい値を指定する必要があります。
rectHeight: Integer — 四角形の高さ (ピクセル単位)。0 より大きい値を指定する必要があります。
columns: Integer — グリッドの列数。0 より大きい値を指定する必要があります。
rows: Integer — グリッドの行数。0 より大きい値を指定する必要があります。
index: Integer — 0 から始まるセル番号。左から右、次に上から下の順に数え、0 から columns × rows - 1 まで。

戻り値

セルの上端。index が範囲外の場合、または rectWidth、rectHeight、columns、rows のいずれかが正の値でない場合は -1。実際のセルが -1 から始まることもあるため、先に index を確認してください。

8 個の例: 今日の日付とタイムスタンプ付きのファイル名, 囲んだ領域のスクリーンショットを撮る, コピーした画像をファイルに保存する, ログファイルに追記する, フォルダー内のファイルの種類を数える, 編集前にファイルをバックアップする, フォルダーを監視する, 環境変数を展開する

Serial

SerialClosePort

SerialClosePort(port: Text) → Bool

SerialOpenPort で開いた COM ポートを閉じ、Arduino IDE などの他のプログラムが使えるようにします。まだ読み取っていない受信行は破棄されます。

パラメーター

port: Text — SerialOpenPort に渡したポート名 (COM3 など)。大文字と小文字は区別されません。

戻り値

ポートが開いていて、閉じられた場合は true。開いていなかった場合、またはシリアルモニターが使用している場合 (SerialMonitorDelete を使用してください) は false。

1 個の例: シリアルデバイスに問い合わせる

SerialEnumeratePorts

SerialEnumeratePorts() → Integer

このコンピューター上のシリアル (COM) ポート (USB で接続された Arduino、ESP32、USB シリアル変換アダプターなど) を検出し、その数を返します。各名前は SerialGetEnumeratedPortAt で読み取ります。

パラメーター

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

戻り値

見つかった COM ポートの数。1 つもない場合は 0。

1 個の例: COM ポートを一覧表示する

SerialGetEnumeratedPortAt

SerialGetEnumeratedPortAt(index: Integer) → Text

このスクリプトの実行中に最後に呼び出した SerialEnumeratePorts が作成した一覧から、ポート名 (COM3 など) を 1 つ返します。どのデバイスがどのポートにあるかはデバイスマネージャーで確認できます。

パラメーター

index: Integer — 一覧内の位置。0 から数 - 1 まで。名前は番号順に並べ替えられるため、COM3 は COM10 より前になります。

戻り値

ポート名。index が範囲外の場合、または SerialEnumeratePorts が呼び出されていない場合は空のテキスト。

1 個の例: COM ポートを一覧表示する

SerialGetTextLine

SerialGetTextLine(port: Text, timeoutSeconds: Integer, baudRate: Integer) → Text

COM ポートから次の完全な行が届くまで待機し、その行を返します。たとえば、センサーの読み取り値、バーコードのスキャン結果、デバイスの応答です。最大 timeoutSeconds の間スクリプトをブロックします。[すべて停止] で待機は終了します。

パラメーター

port: Text — ポート名 (COM3 など)。設定を選択し、早く届いた行を保持するには、先に SerialOpenPort で開いてください。そうしない場合は、この待機のためだけに baudRate で開かれます。
timeoutSeconds: Integer — 最大待機時間 (秒)。0 の場合は、行が届くかスクリプトが停止されるまで待機します。負の値の場合は、エラーでスクリプトが停止します。
baudRate: Integer — 1 秒あたりのビット数で表した速度 (9600 や 115200 など)。この呼び出しがポートを自分で開く場合にだけ使用され、SerialOpenPort で開いたポートでは無視されます。0 以下の場合は、エラーでスクリプトが停止します。

戻り値

終端文字を除いた行。時間内に行が届かなかった場合、ポートを開けなかった場合、またはデバイスが取り外された場合は空のテキスト。シリアルモニターがそのポートを使用している場合は、エラーでスクリプトが停止します。

2 個の例: シリアルデバイスに問い合わせる, Arduino のポートを開いたままにしてコマンドを送信する

SerialMonitorCreate

SerialMonitorCreate(name: Text, port: Text, baudRate: Integer, parity: Integer, dataBits: Integer, stopBits: Integer, terminator: Text, script: Text) → Bool

COM ポートを開き、デバイスが送信する行ごとにスクリプトを実行します。たとえば、Arduino のボタンボックスやマクロパッドをショートカットとして使えます。モニターはこのスクリプトの終了後も実行を続けます。[すべて停止] を実行すると、行に対して実行中のスクリプトが停止し、待機中の行は破棄されますが、モニターは実行を続けます。

パラメーター

name: Text — モニターの名前。このポートの現在のモニターと同じ名前を再利用すると、そのモニターが置き換えられます。既に別のポートを監視している名前の場合は、エラーでスクリプトが停止します。大文字と小文字は区別されません。
port: Text — ポート名 (COM3 など)。ボードがどのポートにあるかはデバイスマネージャーで確認できます。
baudRate: Integer — 速度 (ビット/秒)。デバイスと一致している必要があります。たとえば、Arduino スケッチの Serial.begin に指定した 9600 や 115200 です。
parity: Integer — SerialParity 定数。Arduino ボードを含むほとんどのデバイスは SerialParity.None を使用します。
dataBits: Integer — 1 文字あたりのビット数 (単純な数値)。ほぼすべてのデバイスが 8 を使用します。
stopBits: Integer — SerialStopBits 定数。通常は SerialStopBits.One です。定数を使用してください。単純な数値の 1 はストップビット 1.5 を意味します。
terminator: Text — 各行の終わりを示すテキスト。受信した行からは取り除かれ、SerialWriteTextLine が送信するすべての行に追加されます。空のテキストは、Arduino の Serial.println が送信する CR LF を意味します。行を LF だけで終えるデバイスには '\n' を、CR だけで終えるデバイスには '\r' を使用してください。
script: Text — 受信した行ごとに実行するスクリプト (Text)。スクリプトは ContextGetSerialTextLine で行を読み取ります。行は届いた順に 1 つずつ実行されます。スクリプトの実行中は最大 256 行が待機し、それを超えると古いものから破棄されます。

戻り値

モニターが実行を開始した時点で true。ポートが存在しない場合、取り外されている場合、または別のプログラムが使用中の場合は false。ポートが SerialOpenPort で開かれているか別の名前で監視されている場合、またはこの名前が既に別のポートを監視している場合は、エラーでスクリプトが停止します。デバイスを取り外すとモニターは終了し、コンソールの [システム] タブに 1 行記録されます。

2 個の例: シリアルデバイスのボタンをメディアキーに割り当てる, Arduino のノブを音量調節に使う

SerialMonitorDelete

SerialMonitorDelete(name: Text) → Bool

SerialMonitorCreate で作成したシリアルモニターを停止してその COM ポートを閉じ、他のプログラムが再びポートを使えるようにします。まだ処理されていない行は破棄されます。既に実行中のスクリプトは最後まで実行されます。

パラメーター

name: Text — SerialMonitorCreate に渡した名前。大文字と小文字は区別されません。

戻り値

その名前のモニターが見つかって停止された場合は true。見つからなかった場合は false。

SerialMonitorDeleteAll

SerialMonitorDeleteAll() → Bool

すべてのシリアルモニターを停止し、それらの COM ポートを閉じます。SerialOpenPort で開いたポートは開いたままです。

パラメーター

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

戻り値

常に true。

SerialMonitorGetCount

SerialMonitorGetCount() → Integer

実行中のシリアルモニターの数を返し、SerialMonitorGetEnumeratedNameAt 用にそれらの名前のスナップショットを作成します。

パラメーター

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

戻り値

実行中のシリアルモニターの数。1 つもない場合は 0。

SerialMonitorGetEnumeratedNameAt

SerialMonitorGetEnumeratedNameAt(index: Integer) → Text

このスクリプトの実行中に最後に呼び出した SerialMonitorGetCount が作成したスナップショットから、モニターの名前を 1 つ返します。

パラメーター

index: Integer — スナップショット内の位置。0 から数 - 1 まで。順序に意味はありません。

戻り値

モニターの名前。index が範囲外の場合、または SerialMonitorGetCount が呼び出されていない場合は空のテキスト。

SerialOpenPort

SerialOpenPort(port: Text, baudRate: Integer, parity: Integer, dataBits: Integer, stopBits: Integer, terminator: Text) → Bool

COM ポートを開いて SerialClosePort まで開いたままにし、受信した各行を SerialGetTextLine 用に収集します。ポートを開くと DTR と RTS の信号がオンになり、Arduino IDE と同じように多くの Arduino ボードが再起動するため、一度開いたら再利用してください。

パラメーター

port: Text — ポート名 (COM3 など)。デバイスマネージャーまたは SerialEnumeratePorts で確認できます。空のテキストの場合は、エラーでスクリプトが停止します。
baudRate: Integer — 速度 (ビット/秒)。デバイスと一致している必要があります。たとえば、Arduino スケッチの Serial.begin に指定した 9600 や 115200 です。
parity: Integer — SerialParity 定数。Arduino ボードを含むほとんどのデバイスは SerialParity.None を使用します。
dataBits: Integer — 1 文字あたりのビット数 (単純な数値)。ほぼすべてのデバイスが 8 を使用します。
stopBits: Integer — SerialStopBits 定数。通常は SerialStopBits.One です。定数を使用してください。単純な数値の 1 はストップビット 1.5 を意味します。
terminator: Text — 各行の終わりを示すテキスト。受信した行からは取り除かれ、SerialWriteTextLine が送信するすべての行に追加されます。空のテキストは、Arduino の Serial.println が送信する CR LF を意味します。行を LF だけで終えるデバイスには '\n' を、CR だけで終えるデバイスには '\r' を使用してください。

戻り値

ポートが開いている場合は true。ポートが存在しない場合、取り外されている場合、シリアルモニターなど別のプログラムが使用中の場合、または設定が拒否された場合は false。Input.Observer が既にそのポートを開いている場合、またはシリアルモニターがそのポートを使用している場合は、エラーでスクリプトが停止します。

2 個の例: シリアルデバイスに問い合わせる, Arduino のポートを開いたままにしてコマンドを送信する

SerialWriteTextLine

SerialWriteTextLine(port: Text, text: Text, baudRate: Integer) → Bool

テキスト行にポートの行末を付けて COM ポートに送信します。たとえば、Arduino へのコマンドや 3D プリンターへの G コードの行です。SerialOpenPort で開いたポートにも、シリアルモニターが使用しているポートにも使えるため、モニターのスクリプトからデバイスに応答できます。開いていないポートは、この書き込みのためだけに baudRate、8-N-1 で開かれます。

パラメーター

port: Text — ポート名 (COM3 など)。設定を選択するため、またポートを開くとリセットされるボードの再起動を避けるため、先に SerialOpenPort で開いてください。
text: Text — 送信する行 (UTF-8 でエンコード)。行末は追加しないでください。ポートを開いたときの terminator が追加されます。この呼び出しがポートを自分で開く場合は CR LF が追加されます。
baudRate: Integer — 1 秒あたりのビット数で表した速度 (9600 や 115200 など)。この呼び出しがポートを自分で開く場合にだけ使用され、既に開いているポートや監視されているポートでは無視されます。0 以下の場合は、エラーでスクリプトが停止します。

戻り値

行が送信された場合は true。ポートを開けなかった場合、または書き込みが失敗したかタイムアウトした場合は false。

2 個の例: シリアルデバイスに問い合わせる, Arduino のポートを開いたままにしてコマンドを送信する

Shell

ShellEmptyRecycleBins

ShellEmptyRecycleBins() → Bool · シンプル

確認を求めずに、すべてのドライブのごみ箱の中身を完全に削除します。この操作は元に戻せません。

パラメーター

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

戻り値

ごみ箱が空になった場合、または既に空だった場合は true。それ以外の場合は false。

ShellEnumerateProcessIdsByExeRegex

ShellEnumerateProcessIdsByExeRegex(pattern: Text) → Integer

プログラムのファイル名 (notepad.exe など) が正規表現に一致する実行中のすべてのプロセスを検索し、その数を返します。各プロセス ID は ShellGetEnumeratedProcessIdAt で読み取ります。

パラメーター

pattern: Text — 正規表現。大文字と小文字を区別せずに、完全パスではなくファイル名だけと照合されます。名前全体と一致させるには ^ と $ を使用します (^notepad[.]exe$ など)。

戻り値

一致するプロセスの数。一致するものがない場合は 0。無効なパターンの場合は、エラーでスクリプトが停止します。

1 個の例: プロセスからウィンドウへ

ShellExpandEnvironmentVariables

ShellExpandEnvironmentVariables(text: Text) → Text

text 内の各環境変数 (USERPROFILE や TEMP などの名前を 2 つのパーセント記号で囲んだもの) を、その値に置き換えます。どの PC でも機能するパスを作成するのに便利です。

パラメーター

text: Text — パーセント記号で囲んだ環境変数名を含むテキスト (ユーザープロファイルフォルダー内のパスなど)。

戻り値

既知の変数がすべて置き換えられたテキスト。不明な変数は記述されたまま残ります。展開に失敗した場合は空のテキスト。

ShellGetEnumeratedProcessIdAt

ShellGetEnumeratedProcessIdAt(index: Integer) → Integer

このスクリプトの実行中に最後に呼び出した ShellEnumerateProcessIdsByExeRegex が作成した一覧から、プロセス ID を 1 つ返します。

パラメーター

index: Integer — 一覧内の位置。0 から数 - 1 まで。

戻り値

プロセス ID。index が範囲外の場合、または ShellEnumerateProcessIdsByExeRegex が呼び出されていない場合は 0。

1 個の例: プロセスからウィンドウへ

ShellGetSystemMetricsByIndex

ShellGetSystemMetricsByIndex(index: Integer) → Integer

Windows のシステムの測定値または設定を、GetSystemMetrics のインデックスで返します。たとえば、0 はプライマリ画面の幅、80 はモニターの数です。

パラメーター

index: Integer — Windows の SM_ インデックス番号 (0 (SM_CXSCREEN) や 1 (SM_CYSCREEN) など)。これらには名前付きの定数はありません。

戻り値

Windows が報告する値 (多くの場合ピクセル単位)。不明なインデックスの場合は 0。

ShellRun

ShellRun(command: Text) → Bool · シンプル

Windows の [ファイル名を指定して実行] ボックス (Win+R) に入力した場合と同様に、プログラムを実行するか、ファイル、フォルダー、Web アドレスを開きます。プログラムの終了は待ちません。

パラメーター

command: Text — notepad.exe などのプログラム名、パス、または Web アドレス。必要に応じて後に引数を続けます。スペースを含むパスの後に引数が続く場合は、パスを単一引用符で囲んでください。

戻り値

Windows が起動した場合は true。見つからなかった場合、または起動できなかった場合は false。失敗しても Windows のエラーボックスは表示されません。

4 個の例: while ループ: タイムアウト付きでウィンドウを待つ, プログラムを起動し、そのウィンドウを待って操作する, 選択したテキストを Web で検索する, 選択範囲を Web で検索する

ShellRunOrActivate

ShellRunOrActivate(exeName: Text) → Bool · シンプル

プログラムが既に実行中の場合はそのウィンドウを前面に表示し、実行中でない場合はコマンドを実行します。いつも同じプログラムに移動するジェスチャに便利です。

パラメーター

exeName: Text — プログラムのファイル名 (notepad や notepad.exe など) またはその完全パス。続けて、起動が必要な場合にだけ使用される引数を指定できます。実行中のウィンドウは最初の語のファイル名で照合され、拡張子がない場合は .exe が補われます。スペースを含むパスは単一引用符で囲んでください。

戻り値

ウィンドウが前面に表示された場合、またはプログラムが起動された場合は true。Windows がウィンドウを前面に表示することを拒否した場合、または起動に失敗した場合は false。

1 個の例: アプリを起動する、または切り替える

ShellRunProgram

ShellRunProgram(path: Text, arguments: Text, verb: Any, windowStyle: Integer, waitForExit: Bool) → Bool

選択した操作 (verb) とウィンドウスタイルでプログラムを実行するかファイルを開き、閉じられるまで待機することもできます。プログラムを管理者として実行するには ShellVerb.RunAs を使用します。

パラメーター

path: Text — 開くプログラム、ドキュメント、またはフォルダー (notepad.exe やファイルの完全パスなど)。
arguments: Text — プログラムのコマンドライン引数。引数がない場合は空のテキスト。
verb: Any — ShellVerb.Open や ShellVerb.Print などの ShellVerb 定数、またはそのファイルの種類がサポートする任意の verb (Text)。空のテキストの場合は既定の操作が使用されます。
windowStyle: Integer — WindowStyle 定数: WindowStyle.Normal、WindowStyle.Minimized、WindowStyle.Maximized、WindowStyle.Hidden。それ以外の値の場合は、エラーでスクリプトが停止します。この指定を無視するプログラムもあります。
waitForExit: Bool — true の場合は、プログラムが閉じるまでスクリプトをブロックします。[すべて停止] で待機は終了し、プログラムは実行されたままになります。false の場合はすぐに続行します。

戻り値

Windows が起動した場合 (waitForExit を指定した場合は、さらに閉じられた場合) は true。起動できなかった場合、管理者の確認画面で拒否された場合、または [すべて停止] で待機が終了した場合は false。失敗しても Windows のエラーボックスは表示されません。

2 個の例: 動詞とウィンドウスタイルを指定してプログラムを実行する, 実行して終了を待つ

ShellRunStoreApp

ShellRunStoreApp(packageName: Text) → Bool · シンプル

インストールされている Microsoft Store アプリを、パッケージ名、その一部、または [スタート] メニューでの名前 (Microsoft.WindowsCalculator や電卓など) で起動します。通常のデスクトッププログラムは対象外です。それらには ShellRun を使用してください。

パラメーター

packageName: Text — アプリのパッケージファミリ名またはその一部、あるいは [スタート] メニューでの正確な名前。大文字と小文字を区別せずに照合されます。パッケージファミリ名の完全一致が最優先され、次に [スタート] メニュー名の完全一致、次にパッケージファミリ名にそのテキストを含む最初のアプリの順になります。

戻り値

アプリが起動された場合は true。packageName が空の場合、インストールされている Store アプリで一致するものがない場合、または起動に失敗した場合は false。

ShellShowToast

ShellShowToast(title: Text, message: Text) → Bool · シンプル

タイトルとメッセージ付きの Windows 通知 (トースト) を表示します。待機するのは Windows が通知を受け付けるまでで、通知が閉じられるまでではありません。

パラメーター

title: Text — 通知の 1 行目 (太字) のテキスト。
message: Text — タイトルの下に表示されるテキスト。

戻り値

通知が表示された場合は true。[全般] 設定で通知がオフになっている場合、Windows が拒否した場合、または [すべて停止] で待機が終了した場合は false。

9 個の例: ウィンドウを最前面に固定する, 囲んだ領域のスクリーンショットを撮る, コピーした画像をファイルに保存する, 実行をまたいで保持されるトグル, Windows の通知, マイクのミュートを切り替える, 実行して終了を待つ, 次のジェスチャプロファイルに切り替える, エンジンの状態

ShellTerminateProcess

ShellTerminateProcess(processId: Integer) → Bool

タスクマネージャーの [タスクの終了] と同様に、プロセスを直ちに終了します。そのプログラムで保存されていない作業は失われます。

パラメーター

processId: Integer — プロセス ID (WindowGetProcessId や ShellGetEnumeratedProcessIdAt で取得したものなど)。0 以下の値、Input.Observer 自身のプロセス、Windows のシステムプロセスの場合は、エラーでスクリプトが停止します。

戻り値

プロセスが終了された場合は true。既に終了していた場合、または Windows がアクセスを拒否した場合 (管理者として実行されているプログラムなど) は false。

Snippet

SnippetExecuteScript

SnippetExecuteScript(name: Text) → Bool · シンプル

この名前のスニペットを実行し、完了するまで待機します。スニペットからは呼び出し元のトリガーのコンテキストを参照できますが、変数はスニペット独自のものです。

パラメーター

name: Text — スニペットの名前。大文字と小文字を含めて完全に一致する必要があります。

戻り値

スニペットが最後まで実行された場合は true。その名前のスニペットがない場合、またはスニペットが空の場合、エラーがある場合、停止された場合は false。

1 個の例: 再利用可能な関数としてのスニペット

SnippetGetScript

SnippetGetScript(name: Text) → Text

この名前のスニペットのスクリプトテキストを、実行せずに返します。たとえば、TimerCreate に渡すために使用します。

パラメーター

name: Text — スニペットの名前。大文字と小文字を含めて完全に一致する必要があります。

戻り値

スニペットのスクリプトテキスト。その名前のスニペットがない場合は空のテキスト。

1 個の例: スニペットからのタイマースクリプト (エスケープ不要)

Storage

StorageClearAll

StorageClearAll() → Bool

StorageSetValue で格納したすべての値を、すべてのアクションについて削除します。永続的な値は影響を受けません。

パラメーター

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

戻り値

常に true。

StorageClearAllPersistent

StorageClearAllPersistent() → Bool

すべての永続的な値を削除して storage.toml から消去し、再起動後にどれも復元されないようにします。StorageSetValue で格納した値は影響を受けません。

パラメーター

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

戻り値

常に true。

StorageClearPersistentValue

StorageClearPersistentValue(key: Text) → Bool

永続的な値を 1 つ削除し、storage.toml から消去します。キーが格納されていない場合は何も起こりません。

パラメーター

key: Text — 削除する値の名前。大文字と小文字は区別されます。

戻り値

キーが格納されていたかどうかにかかわらず、常に true。

StorageClearValue

StorageClearValue(key: Text) → Bool

StorageSetValue で格納した値を 1 つ削除します。キーが格納されていない場合は何も起こりません。

パラメーター

key: Text — 削除する値の名前。大文字と小文字は区別されます。

戻り値

キーが格納されていたかどうかにかかわらず、常に true。

StorageGetPersistentValue

StorageGetPersistentValue(key: Text) → Any

StorageSetPersistentValue で保存した値を読み取ります。Input.Observer が前回再起動する前に保存した値も含まれます。

パラメーター

key: Text — 値を保存したときの名前。大文字と小文字は区別されます。

戻り値

格納されている値とその種類 (Bool、Integer、Real、Text)。キーが格納されていない場合は Integer の 0。キーがないのか 0 が格納されているのかを区別するには StorageHasPersistentValue を使用してください。

1 個の例: 再起動後も保持されるカウンター

StorageGetValue

StorageGetValue(key: Text) → Any

Input.Observer の起動以降に、このアクションまたは他のアクションが StorageSetValue で格納した値を読み取ります。

パラメーター

key: Text — 値を格納したときの名前。大文字と小文字は区別されます。

戻り値

格納されている値とその種類 (Bool、Integer、Real、Text、Window)。キーが格納されていない場合は Integer の 0。キーがないのか 0 が格納されているのかを区別するには StorageHasValue を使用してください。

5 個の例: && と || は両辺を評価する, カウントする繰り返しタイマー, 実行をまたいで保持されるトグル, ストレージに保持するリスト, 再利用可能な関数としてのスニペット

StorageHasPersistentValue

StorageHasPersistentValue(key: Text) → Bool

ある名前で永続的な値が格納されているかどうかを確認します。キーがないのか、0、false、空のテキストが格納されているのかを区別するのに使用します。

パラメーター

key: Text — 検索する名前。大文字と小文字は区別されます。

戻り値

key で永続的な値が格納されている場合は true。それ以外の場合は false。

StorageHasValue

StorageHasValue(key: Text) → Bool

StorageSetValue で、ある名前で値が格納されているかどうかを確認します。キーがないのか、0、false、空のテキストが格納されているのかを区別するのに使用します。

パラメーター

key: Text — 検索する名前。大文字と小文字は区別されます。

戻り値

key で値が格納されている場合は true。それ以外の場合は false。

StorageSetPersistentValue

StorageSetPersistentValue(key: Text, value: Any) → Bool

再起動後も残る名前で値を保存します。保存先は構成ファイルと同じ場所にある storage.toml です。このファイルはプレーンテキストで暗号化されないため、パスワードなどの機密情報は保存しないでください。

パラメーター

key: Text — 保存に使用する名前 (最大 256 文字)。大文字と小文字は区別されます。その名前で既に格納されている値は置き換えられます。
value: Any — 保存する値: Bool、Integer、Real、Text (最大 32,768 文字) のいずれか。読み取るときは同じ種類で返されます。Window は保存できません。

戻り値

値が格納された時点で true。起動時に storage.toml が存在していたのに読み取れなかった場合は false。その場合、次回の起動まで保存は無効になり、値は Input.Observer が終了するまでしか保持されません。ウィンドウの値、256 文字を超えるキー、32,768 文字を超える Text、または格納済みの値が 1,024 個に達した後の新しいキーの場合は、エラーでアクションが停止します。

1 個の例: 再起動後も保持されるカウンター

StorageSetValue

StorageSetValue(key: Text, value: Any) → Bool

名前を付けて値を格納し、このアクションや他のアクションの以降の実行で読み取れるようにします。値は Input.Observer が終了するまで保持されます。再起動後も保持するには StorageSetPersistentValue を使用してください。

パラメーター

key: Text — 格納に使用する名前 (最大 256 文字)。大文字と小文字は区別されます。その名前で既に格納されている値は、種類にかかわらず置き換えられます。
value: Any — 格納する値: Bool、Integer、Real、Text (最大 32,768 文字)、Window のいずれか。読み取るときは同じ種類で返されます。

戻り値

値が格納された時点で true。256 文字を超えるキー、32,768 文字を超える Text、または格納済みの値が 1,024 個に達した後の新しいキーの場合は、エラーでアクションが停止します。

String

StringContains

StringContains(text: Text, search: Text) → Bool

text のどこかに別のテキストが含まれているかどうかを確認します。大文字と小文字は一致している必要があります。大文字と小文字を区別せずに確認するには、両方に StringToLower を使用してください。

パラメーター

text: Text — 検索対象のテキスト。
search: Text — 検索するテキスト。

戻り値

search が text 内に含まれている場合、または search が空の場合は true。それ以外の場合は false。

1 個の例: 大文字と小文字を区別しない比較

StringEndsWith

StringEndsWith(text: Text, suffix: Text) → Bool

text が特定のテキスト (ファイルの拡張子など) で終わるかどうかを確認します。大文字と小文字は一致している必要があります。

パラメーター

text: Text — 確認するテキスト。
suffix: Text — 検索する末尾 ('.pdf' など)。

戻り値

text が suffix で終わる場合、または suffix が空の場合は true。それ以外の場合は false。

1 個の例: フォルダー内のファイルの種類を数える

StringFormat

StringFormat(format: Text, value0: Any, value1: Any) → Text

format 内のすべての {0} を value0 に、すべての {1} を value1 に置き換えてテキストを作成します。数値、Bool、ウィンドウを Text に変換するにはこの方法を使用します。

パラメーター

format: Text — {0} と {1} のプレースホルダーを含むテキスト。{2} はありません。さらに多くの値を使用するには呼び出しを入れ子にしてください。{0} が先に置き換えられるため、value0 内の {1} も置き換えられます。
value0: Any — {0} に入れる値 (任意の種類)。
value1: Any — {1} に入れる値 (任意の種類)。format に {1} がない場合は空のテキストを渡してください。

戻り値

プレースホルダーが置き換えられた format のテキスト。Real は小数点以下 6 桁で表示され、true と false は単語として表示されます。

50 個の例: 5 種類の値, カウントループ: 増加、減少、一定の間隔, 入れ子のループ: 九九の表, 終了フラグ付きの while (true), 意外な優先順位, && と || は両辺を評価する, 種類をまたいだ等価比較, 異なる種類の算術演算は 0 になる, コメント、空のステートメント、ブロック, Integer と Real の除算、0 による除算, % を使わない剰余, 丸めと Real の Math 組み込み関数, 値を範囲内に収める, 乱数とコイン投げ, ジェスチャのストロークの長さ, 小数点以下 6 桁にせずに Real を書式設定する, フラグマスク: セット、クリア、反転、テスト, カーソルの下のピクセルの色を読み取る, セットされているビットを数える, シフトの境界条件, 2 つの Integer を入れ替える, キーの状態のビット, 3 つ以上の値を書式設定する, 分割して反復処理する, 入れ子の分割: key=value のペア, 最後に出現する位置: ファイルの拡張子, 数値を 0 で埋める, クリップボードの単語数を数える, Text の順序は序数比較, 名前付き定数と数値の比較, 表示されているトップレベルウィンドウを一覧表示する, 1 つのアプリのすべてのウィンドウを最小化する, タイトルのパターンでウィンドウを確認後に閉じる, ウィンドウの子コントロールを調べる, プロセスからウィンドウへ, カーソルの下にあるものを説明する, トリガーのコンテキストで取得できるすべての情報, ログファイルに追記する, ファイルを読み取って行数を数える, フォルダー内のファイルの種類を数える, カウントする繰り返しタイマー, 再起動後も保持されるカウンター, ストレージに保持するリスト, 画面表示付きで音量を上げる, ライブ更新される表示メッセージ, Windows の通知, モニターを一覧表示する, エンジンの状態, 再利用可能な関数としてのスニペット, Arduino のポートを開いたままにしてコマンドを送信する

StringFromNumber

StringFromNumber(number: Any, decimals: Integer, invariantCulture: Bool) → Text

数値をテキストに変換します。表示用にはユーザーの地域の形式で桁区切り付きに、ファイルやデバイス用には固定のコンピューター向け形式にします。

パラメーター

number: Any — 変換する Integer または Real。
decimals: Integer — 小数点の記号の後の桁数 (0 から 15、丸められます)。-1 の場合は値に必要な桁数 (Integer の場合は 0 桁)。
invariantCulture: Bool — true の場合はコンピューター向けのテキスト (小数点はピリオド、桁区切りなし、StringToNumber(text, true) で読み戻し可能)。false の場合はユーザーの地域の形式。

戻り値

テキストとしての数値 (1,234.50 や 1234.5 など)。Real が有限の数値でない場合は空のテキスト。数値ではない値、または範囲外の decimals の場合は、エラーでアクションが停止します。

1 個の例: ユーザーが入力した数値を読み取る

StringGetIndexOf

StringGetIndexOf(text: Text, search: Text) → Integer

あるテキストが別のテキスト内で最初に現れる位置を検索します。大文字と小文字は一致している必要があります。位置は 0 から始まります。

パラメーター

text: Text — 検索対象のテキスト。
search: Text — 検索するテキスト。

戻り値

最初に現れる位置 (0 から始まる)。search が空の場合は 0。search が text 内に含まれていない場合は -1。

1 個の例: && と || は両辺を評価する

StringGetLength

StringGetLength(text: Text) → Integer

スペースや改行を含めた、text の文字数を返します。StringGetSubstring で使用する位置も同じ方法で数えます。

パラメーター

text: Text — 長さを調べるテキスト。

戻り値

文字数。空のテキストの場合は 0。一部の絵文字やまれな文字は 2 文字として数えられます。

3 個の例: 最後に出現する位置: ファイルの拡張子, 数値を 0 で埋める, Text を逆順にする

StringGetSplitPartAt

StringGetSplitPartAt(index: Integer) → Text

このスクリプトの実行中で最後に呼び出した StringSplit の結果から、部分を 1 つ返します。

パラメーター

index: Integer — 0 から始まる部分の番号。0 から、StringSplit が返した数 - 1 まで。

戻り値

その部分のテキスト。index が範囲外の場合、またはこの実行中に StringSplit が呼び出されていない場合は空のテキスト。

6 個の例: break と continue, 分割して反復処理する, 入れ子の分割: key=value のペア, クリップボードの単語数を数える, クリップボードの複数行を 1 行にまとめる, ファイルを読み取って行数を数える

StringGetSubstring

StringGetSubstring(text: Text, start: Integer, length: Integer) → Text

text の一部を返します。位置 start から最大 length 文字です。位置は 0 から始まります。

パラメーター

text: Text — 部分を取り出すテキスト。
start: Integer — 取り出す最初の文字の位置 (0 から始まる)。負の値は指定できません。
length: Integer — 取り出す最大文字数。負の値は指定できません。

戻り値

要求した部分 (text が先に終わる場合はそれより短くなります)。start が末尾以降の場合は空のテキスト。start または length が負の値の場合は、エラーでアクションが停止します。

4 個の例: && と || は両辺を評価する, Integer を 16 進のテキストに変換する, 最後に出現する位置: ファイルの拡張子, Text を逆順にする

StringIsNumber

StringIsNumber(text: Text, invariantCulture: Bool) → Bool

text が StringToNumber で読み取れる数値かどうかを確認します。たとえば、ユーザーが UIShowInputBox に入力した内容です。数値の前後のスペースは無視されます。

パラメーター

text: Text — 確認するテキスト。
invariantCulture: Bool — true の場合はコンピューター向けのテキスト (小数点はピリオド、桁区切りなし)。false の場合は、人が入力するようなユーザーの地域の形式。その場合、桁区切りの位置はその形式の桁数に従う必要があります。

戻り値

text が選択した形式の数値の場合は true。それ以外の場合 (空のテキストを含む) は false。

2 個の例: ユーザーが入力した数値を読み取る, Arduino のノブを音量調節に使う

StringRegexGetGroupAt

StringRegexGetGroupAt(index: Integer) → Text

このスクリプトの実行中で最後に成功した StringRegexMatch の呼び出しから、一致全体または 1 つのキャプチャグループを返します。

パラメーター

index: Integer — 0 は一致全体。1 以上はキャプチャグループで、開きかっこが現れる順に番号が付きます。名前付きグループにも番号が付きます。

戻り値

一致したテキスト。index が範囲外の場合、グループが一致に関与しなかった場合、または最後の StringRegexMatch で一致が見つからなかった場合は空のテキスト。

1 個の例: コピーしたテキストから正規表現で値を取り出す

StringRegexMatch

StringRegexMatch(text: Text, pattern: Text) → Bool

正規表現 (PCRE2 構文) が text のどこかに一致するかどうかを確認し、一致とそのグループを StringRegexGetGroupAt 用に記憶します。

パラメーター

text: Text — 検索するテキスト。
pattern: Text — 正規表現。大文字と小文字は区別されます。区別しない場合は先頭に (?i) を付けます。単語や数字などの文字クラスは Unicode に従います。

戻り値

パターンが一致した場合は true。一致しない場合は false。無効なパターン、またはこのテキストに対して必要なステップ数が多すぎるパターンの場合は、エラーでアクションが停止します。

1 個の例: コピーしたテキストから正規表現で値を取り出す

StringRegexReplace

StringRegexReplace(text: Text, pattern: Text, replacement: Text) → Text

text 内の正規表現 (PCRE2 構文) に一致するすべての部分を、一致したグループを含めることができる置換文字列で置き換えます。

パラメーター

text: Text — 変更するテキスト。
pattern: Text — 正規表現。大文字と小文字は区別されます。区別しない場合は先頭に (?i) を付けます。
replacement: Text — 各一致の代わりに入れるテキスト。$1 または ${1} はグループ 1、${name} は名前付きグループ、$0 は一致全体、$$ はドル記号そのものを挿入します。

戻り値

すべての一致が置き換えられたテキスト。何も一致しない場合は text がそのまま返されます。無効なパターンまたは置換文字列、ステップ数の超過、または 1,600 万文字を超える結果の場合は、エラーでアクションが停止します。

1 個の例: コピーしたテキストから正規表現で値を取り出す

StringReplace

StringReplace(text: Text, search: Text, replacement: Text) → Text

あるテキストが現れるすべての箇所を別のテキストに置き換えます。大文字と小文字は一致している必要があります。検索はパターンではなく、文字どおりのテキストです。

パラメーター

text: Text — 変更するテキスト。
search: Text — 検索するテキスト。空にすることはできません。
replacement: Text — 代わりに入れるテキスト。空にすると、すべての箇所を削除できます。

戻り値

すべての箇所が置き換えられたテキスト。search が含まれていない場合は text がそのまま返されます。search が空の場合は、エラーでアクションが停止します。

3 個の例: クリップボードの単語数を数える, テンプレートを埋めて貼り付ける, 選択範囲を Web で検索する

StringSplit

StringSplit(text: Text, delimiter: Text) → Integer

区切り文字が現れるすべての箇所で text を分割し、各部分を StringGetSplitPartAt 用に記憶します。区切り文字が連続している場合や、先頭または末尾にある場合は、空の部分になります。

パラメーター

text: Text — 分割するテキスト。
delimiter: Text — 分割位置となる文字どおりのテキスト (',' や改行など)。空にすることはできません。

戻り値

部分の数 (1 以上)。delimiter が空の場合は、エラーでアクションが停止します。

StringStartsWith

StringStartsWith(text: Text, prefix: Text) → Bool

text が特定のテキストで始まるかどうかを確認します。大文字と小文字は一致している必要があります。

パラメーター

text: Text — 確認するテキスト。
prefix: Text — 検索する先頭部分。

戻り値

text が prefix で始まる場合、または prefix が空の場合は true。それ以外の場合は false。

2 個の例: break と continue, ファイルを読み取って行数を数える

StringToLower

StringToLower(text: Text) → Text

ユーザーの Windows の地域の形式の大文字と小文字の規則 (トルコ語の点付き i と点なし i など) に従って、テキストを小文字に変換します。

パラメーター

text: Text — 変換するテキスト。

戻り値

小文字のテキスト。Windows が変換できない場合は text がそのまま返されます。

4 個の例: 大文字と小文字を区別しない比較, Text の順序は序数比較, 認識されなかった描画をそのまま通す, フォルダー内のファイルの種類を数える

StringToNumber

StringToNumber(text: Text, invariantCulture: Bool) → Any

ユーザーの入力、ファイル、シリアルデバイスなどのテキストから数値を読み取ります。数値の前後のスペースは無視されます。1.5e3 のような指数も使用できます。

パラメーター

text: Text — 読み取るテキスト。
invariantCulture: Bool — true の場合はコンピューター向けのテキスト (小数点はピリオド、桁区切りなし。このため '1,5' は数値ではありません)。false の場合は、人が入力するようなユーザーの地域の形式。その場合、桁区切りはその形式に従う必要があるため、日本語 (日本) では '1,234.5' は読み取れますが '1,5' は読み取れません。

戻り値

テキストに小数点の記号や指数がなく、範囲に収まる場合は Integer、それ以外の場合は Real。テキストが数値でない場合は 0。先に StringIsNumber で確認してください。

2 個の例: ユーザーが入力した数値を読み取る, Arduino のノブを音量調節に使う

StringToUpper

StringToUpper(text: Text) → Text

ユーザーの Windows の地域の形式の大文字と小文字の規則 (トルコ語の点付き i と点なし i など) に従って、テキストを大文字に変換します。

パラメーター

text: Text — 変換するテキスト。

戻り値

大文字のテキスト。Windows が変換できない場合は text がそのまま返されます。

2 個の例: 選択したテキストを大文字にする, 編集前にファイルをバックアップする

StringTrim

StringTrim(text: Text) → Text

テキストの先頭と末尾から、スペース、タブ、改行などの空白文字を取り除きます。テキスト内部の空白文字は残ります。

パラメーター

text: Text — 空白文字を取り除くテキスト。

戻り値

空白文字が取り除かれたテキスト。text が空白文字だけだった場合は空のテキスト。

6 個の例: クリップボードの単語数を数える, クリップボードの複数行を 1 行にまとめる, 選択したテキストを Web で検索する, 選択範囲を Web で検索する, ファイルを読み取って行数を数える, シリアルデバイスのボタンをメディアキーに割り当てる

StringUrlEncode

StringUrlEncode(text: Text) → Text · シンプル

テキストを Web アドレスの中に入れられるようにエンコードします。たとえば、選択したテキストから作成した検索語です。アドレス全体ではなく、値だけをエンコードしてください。

パラメーター

text: Text — エンコードするテキスト (検索語など)。

戻り値

エンコードされたテキスト。英字、数字、- . _ ~ はそのまま残り、UTF-8 テキストのそれ以外の各バイトは、パーセント記号と 2 桁の 16 進数によるエスケープになります。スペースはプラス記号ではなく、パーセント記号と 20 になります。

1 個の例: 選択したテキストを Web で検索する

Style

StyleGetCurrent

StyleGetCurrent() → Text · シンプル

レンダラープラグインが現在描画している軌跡スタイルのキー (neonglow など) を返します。シャッフルが選択されている場合は shuffle を返します。

パラメーター

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

戻り値

スタイルのキー。使用可能なものが選択されていない場合はレンダラーの既定のスタイル。レンダラーが実行されていない場合、またはレンダラーがスタイルを報告していない場合は空のテキスト。

StyleNext

StyleNext() → Bool · シンプル

レンダラーの一覧で次のロック解除済みの軌跡スタイルを選択します。末尾に達すると先頭に戻ります。新しいスタイルは次のジェスチャから描画されます。

パラメーター

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

戻り値

スタイルの変更が要求された場合は true。レンダラーが実行されていない場合、または選択できる他のスタイルがない場合は false。

StyleSet

StyleSet(key: Text) → Bool · シンプル

このキーを持つレンダラーの軌跡スタイルを選択します。次のジェスチャから描画されます。独自のスタイルを持つ描画ボタンは、そのスタイルを維持します。

パラメーター

key: Text — スタイルのキー (neonglow や auto など)。大文字と小文字は区別されません。ジェスチャごとに異なるスタイルにするには shuffle を使用します。

戻り値

スタイルの変更が要求された場合は true。レンダラーが実行されていない場合、そのキーを持つスタイルがない場合、またはスタイルがロックされている場合は false。

System

SystemHibernate

SystemHibernate() → Bool · シンプル

確認せずにコンピューターを休止状態にします。スクリプトはここで待機し、コンピューターの電源が再び入った後に続行します。Windows で休止状態がオフになっている場合は何も行いません。

パラメーター

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

戻り値

コンピューターが休止状態になって再開した後に true。休止状態を使用できない場合、または Windows が拒否した場合は false。

SystemLock

SystemLock() → Bool · シンプル

Windows+L キーと同様に、コンピューターをロックして Windows のサインイン画面を表示します。アプリは実行を続けます。

パラメーター

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

戻り値

Windows がコンピューターをロックした場合は true。ポリシーによってロックが無効になっている場合など、Windows が拒否した場合は false。

SystemMonitorOff

SystemMonitorOff() → Bool · シンプル

モニターの電源を切ります。次にマウスを動かすかキーを押すと再びオンになるため、ジェスチャで開始したスクリプトでは先に UtilityWait(500) を呼び出してください。

パラメーター

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

戻り値

要求が Windows に送信された時点で true。送信できなかった場合は false。

SystemRestart

SystemRestart(force: Bool) → Bool · シンプル

確認を求めずにコンピューターを再起動します。Windows は先に実行中のアプリを閉じます。確認したい場合は、先に UIShowMessageBox を表示してください。

パラメーター

force: Bool — false の場合は、アプリが未保存の作業の保存を求めることができます (応答しないアプリだけが強制的に閉じられます)。true の場合はすべてのアプリを直ちに閉じ、未保存の作業は失われます。

戻り値

Windows が再起動の要求を受け付けた場合 (その後は Windows が自動的に処理を進めます) は true。Windows が拒否した場合は false。

SystemShutDown

SystemShutDown(force: Bool) → Bool · シンプル

確認を求めずにコンピューターをシャットダウンし、電源を切ります。確認したい場合は、先に UIShowMessageBox を表示してください。

パラメーター

force: Bool — false の場合は、アプリが未保存の作業の保存を求めることができます (応答しないアプリだけが強制的に閉じられます)。true の場合はすべてのアプリを直ちに閉じ、未保存の作業は失われます。

戻り値

Windows がシャットダウンの要求を受け付けた場合 (その後は Windows が自動的に処理を進めます) は true。Windows が拒否した場合は false。

SystemSignOut

SystemSignOut(force: Bool) → Bool · シンプル

確認を求めずに現在のユーザーを Windows からサインアウトします。すべてのアプリと Input.Observer も閉じられます。

パラメーター

force: Bool — false の場合は、アプリが未保存の作業の保存を求めることができます (応答しないアプリだけが強制的に閉じられます)。true の場合はすべてのアプリを直ちに閉じ、未保存の作業は失われます。

戻り値

Windows がサインアウトの要求を受け付けた場合 (その後は Windows が自動的に処理を進めます) は true。Windows が拒否した場合は false。

SystemSleep

SystemSleep() → Bool · シンプル

確認せずにコンピューターをスリープ状態にします。スクリプトはここで待機し、コンピューターのスリープが解除された後に続行します。モダンスタンバイのコンピューターでは何も行いません。その場合は SystemMonitorOff を使用してください。

パラメーター

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

戻り値

コンピューターがスリープ状態になって復帰した後に true。このコンピューターにプログラムから開始できるスリープ状態がない場合、または Windows が拒否した場合は false。

Timer

TimerCreate

TimerCreate(name: Text, startDelayMs: Integer, intervalMs: Integer, repeatCount: Integer, script: Text) → Bool

遅延の後、一定の間隔でスクリプトテキストを実行する名前付きタイマーを作成するか、その名前のタイマーを置き換えます。タイマーはスクリプトの終了後も、削除されるかエンジンが終了するまで実行を続けます。

パラメーター

name: Text — タイマーの名前 (TimerDelete で使用)。大文字と小文字は区別されます。この名前の既存のタイマーは置き換えられます。
startDelayMs: Integer — 最初の実行までの遅延 (ミリ秒)。0 以上。
intervalMs: Integer — 実行の間隔 (ミリ秒)。1 以上。前回の実行の完了は待ちません。
repeatCount: Integer — 実行する合計回数。0 の場合は、タイマーが削除されるまで繰り返します。
script: Text — 各タイミングで実行するスクリプトテキスト。トリガーのコンテキストもこのスクリプトの変数も持たずに、単独で実行されます。

戻り値

タイマーが設定された時点で true。startDelayMs または repeatCount が負の値の場合、または intervalMs が 1 未満の場合は、エラーでスクリプトが停止します。

2 個の例: カウントする繰り返しタイマー, スニペットからのタイマースクリプト (エスケープ不要)

TimerDelete

TimerDelete(name: Text) → Bool

この名前のタイマーを削除し、再び実行されないようにします。

パラメーター

name: Text — TimerCreate に渡したタイマーの名前。大文字と小文字は区別されます。

戻り値

タイマーが存在し、削除された場合は true。その名前のタイマーがなかった場合は false。

TimerDeleteAll

TimerDeleteAll() → Bool

TimerCreate で作成したすべてのタイマーを削除し、どれも再び実行されないようにします。

パラメーター

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

戻り値

常に true。

TimerEnumerateAll

TimerEnumerateAll() → Integer

現在のすべてのタイマーの名前の一覧を作成し、その数を返します。各名前は TimerGetEnumeratedNameAt で読み取ります。

パラメーター

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

戻り値

タイマーの数。1 つもない場合は 0。

TimerGetEnumeratedNameAt

TimerGetEnumeratedNameAt(index: Integer) → Text

このスクリプトで最後に TimerEnumerateAll が作成した一覧から、タイマーの名前を 1 つ返します。

パラメーター

index: Integer — 一覧内の 0 から始まる位置。0 から数 - 1 まで。順序に意味はありません。

戻り値

タイマーの名前。index が範囲外の場合、または TimerEnumerateAll が呼び出されていない場合は空のテキスト。

70 個の例: Hello、コンソール, 5 種類の値, 各種類の truthy の判定, else-if の連鎖, カウントループ: 増加、減少、一定の間隔, 入れ子のループ: 九九の表, while ループ: タイムアウト付きでウィンドウを待つ, 終了フラグ付きの while (true), break と continue, 意外な優先順位, && と || は両辺を評価する, 種類をまたいだ等価比較, 異なる種類の算術演算は 0 になる, コメント、空のステートメント、ブロック, Integer と Real の除算、0 による除算, % を使わない剰余, 丸めと Real の Math 組み込み関数, 値を範囲内に収める, 乱数とコイン投げ, ジェスチャのストロークの長さ, 小数点以下 6 桁にせずに Real を書式設定する, フラグマスク: セット、クリア、反転、テスト, カーソルの下のピクセルの色を読み取る, Integer を 16 進のテキストに変換する, セットされているビットを数える, シフトの境界条件, 2 つの Integer を入れ替える, キーの状態のビット, 文字列のエスケープと Windows のパス, 3 つ以上の値を書式設定する, 分割して反復処理する, 入れ子の分割: key=value のペア, 最後に出現する位置: ファイルの拡張子, ユーザーが入力した数値を読み取る, プログラムを起動し、そのウィンドウを待って操作する, コピーしたテキストから正規表現で値を取り出す, 数値を 0 で埋める, Text を逆順にする, クリップボードの単語数を数える, 大文字と小文字を区別しない比較, Text の順序は序数比較, 今日の日付とタイムスタンプ付きのファイル名, 名前付き定数と数値の比較, 表示されているトップレベルウィンドウを一覧表示する, 1 つのアプリのすべてのウィンドウを最小化する, ウィンドウの子コントロールを調べる, プロセスからウィンドウへ, カーソルの下にあるものを説明する, トリガーのコンテキストで取得できるすべての情報, ストロークはどの方向に描かれたか, ストロークのボタンで分岐する, コピーした画像をファイルに保存する, ファイルを読み取って行数を数える, フォルダー内のファイルの種類を数える, フォルダーを監視する, カウントする繰り返しタイマー, タイマーを一覧表示して停止する, 再起動後も保持されるカウンター, ストレージに保持するリスト, ある区間を一度に 1 つのアクションだけが実行するようにする, 質問する, 環境変数を展開する, AutoHotkey に処理を渡す, モニターを一覧表示する, エンジンの状態, 再利用可能な関数としてのスニペット, プラグインと通信する, シリアルデバイスに問い合わせる, COM ポートを一覧表示する, Arduino のポートを開いたままにしてコマンドを送信する

Tray

TrayMinimizeWindow

TrayMinimizeWindow(window: Window) → Bool

ウィンドウを隠し、そのウィンドウ自身のアイコンとタイトルで通知領域アイコンを表示します。アイコンをクリックすると、ウィンドウは元の位置に戻ります。コントロールの場合は、そのトップレベルウィンドウが隠されます。

パラメーター

window: Window — 隠すウィンドウ (ContextGetWindow() など)。

戻り値

要求が受け付けられた場合は true。null ウィンドウまたは既に存在しないウィンドウの場合は false。

1 個の例: ウィンドウを通知領域に隠す

TrayRestoreAllWindows

TrayRestoreAllWindows() → Bool

TrayMinimizeWindow で隠したすべてのウィンドウを元に戻し、それらの通知領域アイコンを削除します。

パラメーター

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

戻り値

要求が送信された場合は true。エンジンの起動が完了していない場合は false。

UI

UIClearPrintLog

UIClearPrintLog() → Bool

UtilityPrint の出力が表示される診断コンソールの [ユーザー] タブを、コンソールが閉じている間に保存された出力も含めてクリアします。

パラメーター

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

戻り値

常に true。

UICloseDisplayMessage

UICloseDisplayMessage(sessionId: Integer) → Bool

UIShowDisplayMessage で開いた画面上のメッセージを 1 つ閉じます。そのメッセージが既に閉じている場合は何も行いません。

パラメーター

sessionId: Integer — 閉じるメッセージについて UIShowDisplayMessage が返した ID。

戻り値

メッセージが既に閉じていた場合も含め、常に true。

1 個の例: ライブ更新される表示メッセージ

UIGetCulture

UIGetCulture() → Text

Input.Observer が自身のテキスト (通知領域のメニュー、メッセージ、エラーテキスト) に使用している言語と地域を返します。これは UISetCulture、言語の設定、または Windows によって決まります。

パラメーター

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

戻り値

設定されたとおりのカルチャ名 (en-US や es-ES など)。別の地域の翻訳が代わりに使われている場合も同じです。

UISetCulture

UISetCulture(culture: Text) → Bool

Input.Observer が自身のテキスト (通知領域のメニュー、メッセージ、エラーテキスト) に使用する言語を、終了するか言語の設定が変更されるまで切り替えます。設定ウィンドウや保存済みの設定は変更しません。

パラメーター

culture: Text — en-US、de-DE、es-MX などのカルチャ名。

戻り値

カルチャが適用された場合は true。culture が Windows の認識しないカルチャである場合、または Input.Observer にその言語の翻訳がない場合は false で、言語は元のままです。翻訳済みの言語の別の地域 (es-ES など) は受け付けられます。

UIShowConsole

UIShowConsole() → Bool

診断コンソールを開きます。既に開いている場合は前面に表示し、開くまで待機します。構成がパスワードで保護されている場合は、パスワードの入力中も待機します。コンソールを閉じられるのは、コンソール自身の閉じるボタンだけです。

パラメーター

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

戻り値

コンソールが開いた時点で true。開かなかった場合 (パスワードの入力がキャンセルされた場合や、コンソールの保存された状態を読み取れない場合など) は false。

UIShowDisplayMessage

UIShowDisplayMessage(title: Text, message: Text, durationMs: Integer, opacity: Real, location: Any, titleFontFamily: Text, titleFontSizePt: Integer, titleBold: Bool, titleItalic: Bool, messageFontFamily: Text, messageFontSizePt: Integer, messageBold: Bool, messageItalic: Bool, foreColor: Text, backColor: Text, paddingPx: Integer, usePrimaryScreen: Bool, titleAlign: Integer, messageAlign: Integer) → Integer · シンプル

タイトル行とメッセージ行を含むパネルを画面上の決まった場所に表示し、すぐに戻ります。複数を同時に開くことができます。このパネルを更新したり閉じたりするには、返された ID を保持しておいてください。

パラメーター

title: Text — 上の行のテキスト。タイトルのフォントで描画されます。空のテキストの場合、この行は表示されません。
message: Text — 2 行目のテキスト。メッセージのフォントで描画されます。長いテキストは複数行に折り返されます。空のテキストの場合、この行は表示されません。
durationMs: Integer — パネルを表示し続ける時間 (ミリ秒)。0 以下の場合は、UICloseDisplayMessage で閉じるまで表示されます (組み込みのパネルはダブルクリックでも閉じます)。
opacity: Real — パネルの不透明度。0.05 (ほぼ透明) から 1.0 (完全に不透明) まで。範囲外の値は範囲内に収められます。
location: Any — 表示する場所: Location.BottomCenter などの Location 定数 (タスクバーで覆われていない画面領域内に配置されます)、またはパネルの左上隅を画面のピクセル単位で示す、スペースを含まない Text の 'x,y' ('100,200' など)。それ以外の場合は、エラーでアクションが停止します。
titleFontFamily: Text — タイトル行のフォント名 (Segoe UI など)。
titleFontSizePt: Integer — タイトルのフォントサイズ (ポイント)。1 未満の値は 1 として扱われます。
titleBold: Bool — true の場合はタイトル行を太字で描画します。
titleItalic: Bool — true の場合はタイトル行を斜体で描画します。
messageFontFamily: Text — メッセージ行のフォント名 (Segoe UI など)。
messageFontSizePt: Integer — メッセージのフォントサイズ (ポイント)。1 未満の値は 1 として扱われます。
messageBold: Bool — true の場合はメッセージ行を太字で描画します。
messageItalic: Bool — true の場合はメッセージ行を斜体で描画します。
foreColor: Text — 両方の行の文字の色: white や black などの色の名前、'#RRGGBB'、または各数値が 0 から 255 でスペースを含まない 'R,G,B'。それ以外の場合は、エラーでアクションが停止します。
backColor: Text — 背景色。foreColor と同じ形式で指定します ('#F7F7F5' など)。パネルを透けて見えるようにするには、色ではなく opacity を使用してください。
paddingPx: Integer — テキストの周囲の余白 (表示スケール 100 パーセントでのピクセル単位)。表示スケールに応じて大きくなります。0 未満の値は 0 として扱われます。
usePrimaryScreen: Bool — true の場合は Location をプライマリモニター上に配置します。false の場合は、現在マウスポインターがあるモニターを使用します。'x,y' の場所では無視されます。
titleAlign: Integer — タイトル行の配置: TextAlign.Left、TextAlign.Center、TextAlign.Right。それ以外の値の場合は、エラーでアクションが停止します。
messageAlign: Integer — メッセージ行の配置: TextAlign.Left、TextAlign.Center、TextAlign.Right。それ以外の値の場合は、エラーでアクションが停止します。

戻り値

UIUpdateDisplayMessage と UICloseDisplayMessage で使用するメッセージのセッション ID (常に 0 より大きい値)。設定でメッセージがオフになっていて何も表示されない場合でも、ID は返されます。

2 個の例: 画面表示付きで音量を上げる, ライブ更新される表示メッセージ

UIShowInputBox

UIShowInputBox(prompt: Text, title: Text, defaultText: Text) → Text · シンプル

ユーザーに 1 行のテキストの入力を求めるボックスを、[OK] ボタンと [キャンセル] ボタン付きで表示します。ボックスが閉じるまでスクリプトをブロックし、その後フォーカスを元のウィンドウに戻します。

パラメーター

prompt: Text — テキストフィールドの上に表示される質問。2000 文字を超えるテキストは切り捨てられます。
title: Text — ボックスのタイトルバーに表示されるタイトル。
defaultText: Text — ボックスが開いたときにフィールドに入っているテキスト。選択された状態になるため、入力するとそれが置き換えられます。空のフィールドにするには空のテキストを使用します。

戻り値

ユーザーが [OK] をクリックしたときに入力されていたテキスト (最大 4096 文字)。[キャンセル]、Esc キー、または閉じるボタンの場合は空のテキスト。何も入力せずに [OK] をクリックした場合も空のテキストを返します。

2 個の例: ユーザーが入力した数値を読み取る, 1 つのジェスチャで複数の選択肢

UIShowMenu

UIShowMenu(items: Text) → Integer · シンプル

マウスポインターの位置にポップアップメニューを表示し、1 つのジェスチャやホットキーで複数の選択肢を提供できるようにします。ユーザーが項目を選ぶかメニューを閉じるまで、スクリプトをブロックします。

パラメーター

items: Text — メニュー項目 (1 行に 1 つ)。- だけの行は区切り線になり、空行はスキップされます。項目は 1 から 100 個まで (それ以外の場合はエラーでアクションが停止します)。260 文字を超える項目は切り捨てられます。文字の前に & を付けると、その文字が項目のショートカットキーになります。&& は & を 1 つ表示します。

戻り値

選択された項目の 0 から始まる位置 (区切り線を除き、項目だけを数えます)。メニューが閉じられた場合、または表示できなかった場合は -1。

1 個の例: 1 つのジェスチャで複数の選択肢

UIShowMessageBox

UIShowMessageBox(message: Text, title: Text, buttons: Text, icon: Text) → Text · シンプル

Windows の標準のメッセージボックスを他のウィンドウより前面に表示し、ユーザーがボタンを押すまで待機します。ボックスが閉じるまでスクリプトをブロックします。

パラメーター

message: Text — ボックスに表示するメッセージテキスト。
title: Text — ボックスのタイトルバーに表示されるタイトル。
buttons: Text — 表示するボタン。OK、OKCancel、YesNo、YesNoCancel、RetryCancel、AbortRetryIgnore のいずれかを正確に記述します。それ以外の場合は、エラーでアクションが停止します。
icon: Text — 表示するアイコン。None、Information、Warning、Error、Question のいずれかを正確に記述します。それ以外の場合は、エラーでアクションが停止します。

戻り値

押されたボタン: OK、Cancel、Yes、No、Retry、Abort、Ignore のいずれか ([キャンセル] ボタンがある場合、Esc キーや閉じるボタンでボックスを閉じると Cancel を返します)。ボックスを表示できなかった場合は空のテキスト。

3 個の例: ユーザーが入力した数値を読み取る, タイトルのパターンでウィンドウを確認後に閉じる, 質問する

UIShowSettings

UIShowSettings() → Bool · シンプル

Input.Observer の設定ウィンドウを開きます。既に開いている場合は前面に表示します。ウィンドウの読み込みの完了を待たずに戻ります。

パラメーター

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

戻り値

設定ウィンドウが前面に表示された場合、または起動された場合は true。Input.Observer.UI.exe が存在しない場合、起動できなかった場合、またはエンジンが 3 秒以内に応答しなかった場合は false。

UIUpdateDisplayMessage

UIUpdateDisplayMessage(sessionId: Integer, title: Text, message: Text, durationMs: Integer, opacity: Real, location: Any, titleFontFamily: Text, titleFontSizePt: Integer, titleBold: Bool, titleItalic: Bool, messageFontFamily: Text, messageFontSizePt: Integer, messageBold: Bool, messageItalic: Bool, foreColor: Text, backColor: Text, paddingPx: Integer, usePrimaryScreen: Bool, titleAlign: Integer, messageAlign: Integer) → Bool

開いている UIShowDisplayMessage のパネルのすべて (テキスト、位置、フォント、色、表示時間) を新しい値に置き換えます。表示時間はこの呼び出しから改めて始まります。

パラメーター

sessionId: Integer — 変更するメッセージについて UIShowDisplayMessage が返した ID。
title: Text — 上の行の新しいテキスト。タイトルのフォントで描画されます。空のテキストの場合、この行は表示されません。
message: Text — 2 行目の新しいテキスト。メッセージのフォントで描画されます。長いテキストは複数行に折り返されます。空のテキストの場合、この行は表示されません。
durationMs: Integer — 今からパネルを表示し続ける時間 (ミリ秒)。0 以下の場合は、UICloseDisplayMessage で閉じるまで表示されます (組み込みのパネルはダブルクリックでも閉じます)。
opacity: Real — パネルの不透明度。0.05 (ほぼ透明) から 1.0 (完全に不透明) まで。範囲外の値は範囲内に収められます。
location: Any — 表示する場所: Location.BottomCenter などの Location 定数 (タスクバーで覆われていない画面領域内に配置されます)、またはパネルの左上隅を画面のピクセル単位で示す、スペースを含まない Text の 'x,y' ('100,200' など)。それ以外の場合は、エラーでアクションが停止します。
titleFontFamily: Text — タイトル行のフォント名 (Segoe UI など)。
titleFontSizePt: Integer — タイトルのフォントサイズ (ポイント)。1 未満の値は 1 として扱われます。
titleBold: Bool — true の場合はタイトル行を太字で描画します。
titleItalic: Bool — true の場合はタイトル行を斜体で描画します。
messageFontFamily: Text — メッセージ行のフォント名 (Segoe UI など)。
messageFontSizePt: Integer — メッセージのフォントサイズ (ポイント)。1 未満の値は 1 として扱われます。
messageBold: Bool — true の場合はメッセージ行を太字で描画します。
messageItalic: Bool — true の場合はメッセージ行を斜体で描画します。
foreColor: Text — 両方の行の文字の色: white や black などの色の名前、'#RRGGBB'、または各数値が 0 から 255 でスペースを含まない 'R,G,B'。それ以外の場合は、エラーでアクションが停止します。
backColor: Text — 背景色。foreColor と同じ形式で指定します ('#F7F7F5' など)。パネルを透けて見えるようにするには、色ではなく opacity を使用してください。
paddingPx: Integer — テキストの周囲の余白 (表示スケール 100 パーセントでのピクセル単位)。表示スケールに応じて大きくなります。0 未満の値は 0 として扱われます。
usePrimaryScreen: Bool — true の場合は Location をプライマリモニター上に配置します。false の場合は、現在マウスポインターがあるモニターを使用します。'x,y' の場所では無視されます。
titleAlign: Integer — タイトル行の配置: TextAlign.Left、TextAlign.Center、TextAlign.Right。それ以外の値の場合は、エラーでアクションが停止します。
messageAlign: Integer — メッセージ行の配置: TextAlign.Left、TextAlign.Center、TextAlign.Right。それ以外の値の場合は、エラーでアクションが停止します。

戻り値

メッセージが既に閉じていた場合 (その場合、呼び出しは何も行いません) も含め、常に true。

1 個の例: ライブ更新される表示メッセージ

Utility

UtilityGetTickCount

UtilityGetTickCount() → Integer

Windows の起動からの経過ミリ秒数を返します。2 回の読み取り値の差を取ると経過時間を測定でき、たとえば二重のトリガーを検出できます。これは時計ではありません。時刻には DateTimeGetNow を使用してください。

パラメーター

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

戻り値

Windows の起動からの経過ミリ秒数の Integer。

UtilityLockAcquire

UtilityLockAcquire(name: Text, timeoutSeconds: Integer) → Integer

名前付きロックを取得し、スクリプトの特定の部分を一度に 1 つのアクションだけが実行するようにします。ロックが解放されるか timeoutSeconds が経過するまで、スクリプトをブロックします。ロックはスクリプトの終了時に自動的に解放されます。

パラメーター

name: Text — ロックの名前 (1 から 255 文字)。すべてのアクションで共有され、大文字と小文字は同じと見なされます。このスクリプトが既に保持しているロックを再び取得することもでき、その場合は UtilityLockRelease がもう 1 回必要です。
timeoutSeconds: Integer — 待機する最大時間 (秒)。0 または 24 日を超える値の場合は、ロックが解放されるかアクションが停止されるまで待機します。負の値の場合は、エラーでアクションが停止します。

戻り値

LockResult.Acquired、LockResult.TimedOut (待機中にアクションが停止された場合も含む)、またはロックが固定されている場合はすぐに LockResult.Pinned。

1 個の例: ある区間を一度に 1 つのアクションだけが実行するようにする

UtilityLockAcquirePinned

UtilityLockAcquirePinned(name: Text, timeoutSeconds: Integer) → Integer

名前付きロックを取得して固定し、スクリプトの終了後も取得されたままにします。解放できるのは、同じスクリプトの実行中の UtilityLockRelease、または構成の再読み込みだけです。UtilityLockAcquire と同様にブロックします。

パラメーター

name: Text — ロックの名前 (1 から 255 文字)。すべてのアクションで共有され、大文字と小文字は同じと見なされます。このスクリプトが既に保持しているロックは固定されます。
timeoutSeconds: Integer — 待機する最大時間 (秒)。0 または 24 日を超える値の場合は、ロックが解放されるかアクションが停止されるまで待機します。負の値の場合は、エラーでアクションが停止します。

戻り値

LockResult.Acquired、LockResult.TimedOut (待機中にアクションが停止された場合も含む)、またはロックが既に固定されている場合はすぐに LockResult.Pinned。

UtilityLockGetState

UtilityLockGetState(name: Text) → Integer

名前付きロックが、解放されているか、このスクリプトが保持しているか、別のアクションが保持しているか、固定されているかを返します。待機することはありません。

パラメーター

name: Text — ロックの名前 (1 から 255 文字)。大文字と小文字は同じと見なされます。

戻り値

LockState.Free、LockState.HeldByMe、LockState.HeldByOther、LockState.Pinned のいずれか。固定されたロックは、固定したスクリプトに対しても LockState.Pinned を返します。

UtilityLockRelease

UtilityLockRelease(name: Text) → Bool

このスクリプトが保持している名前付きロックを解放するか、その固定を解除します。複数回取得したロックは、同じ回数解放すると解放されます。

パラメーター

name: Text — ロックの名前 (1 から 255 文字)。大文字と小文字は同じと見なされます。

戻り値

このスクリプトがロックを保持していた場合は true。誰も保持していない場合、または別のアクションが保持している場合は、何もせずに false。

1 個の例: ある区間を一度に 1 つのアクションだけが実行するようにする

UtilityPrint

UtilityPrint(text: Text) → Bool

診断コンソールの [ユーザー] セクションにテキストを 1 行書き込みます。スクリプトがコンソールの [スクリプト] セクションから実行された場合は、そこの出力に書き込みます。コンソールが閉じている間に出力された行は、次にコンソールを開いたときに表示されます。

パラメーター

text: Text — 書き込むテキスト。数値は先に StringFormat または StringFromNumber で Text に変換してください。

戻り値

常に true。

UtilityWait

UtilityWait(milliseconds: Integer) → Bool · シンプル

スクリプトを指定したミリ秒数だけ一時停止します。たとえば、ウィンドウやクリップボードの処理が追いつくのを待つために使用します。アクションが停止されると、待機は早めに終了します。

パラメーター

milliseconds: Integer — 待機する時間 (ミリ秒)。0 から 60000 (1 分) まで。これより大きい値の場合は 1 分待機し、負の値の場合は待機しません。

戻り値

常に true。

10 個の例: while ループ: タイムアウト付きでウィンドウを待つ, マウスを円を描くように動かす, テンプレートを埋めて貼り付ける, どこかをクリックしてカーソルを元に戻す, スクリプトによるドラッグ, カーソルを 5 秒間ウィンドウ内に制限する, メディアキー, 選択したテキストを大文字にする, 選択範囲を Web で検索する, ライブ更新される表示メッセージ

Window

WindowCenterToScreen

WindowCenterToScreen(window: Window) → Bool · シンプル

ウィンドウのサイズを変えずに、ウィンドウがあるモニターの作業領域 (画面からタスクバーを除いた領域) の中央に移動します。

パラメーター

window: Window — 中央に配置するウィンドウ。

戻り値

ウィンドウが移動した場合は true。ウィンドウが null か閉じている場合、または移動を拒否した場合は false。

2 個の例: while ループ: タイムアウト付きでウィンドウを待つ, ウィンドウの位置を記憶して復元する

WindowClipToScreen

WindowClipToScreen(window: Window) → Bool

ウィンドウがあるモニターの作業領域 (画面からタスクバーを除いた領域) からどの端もはみ出さないように、必要な分だけウィンドウを縮小して移動します。作業領域の完全に外にあるウィンドウは、まず現在のサイズのまま作業領域内に移動されます。

パラメーター

window: Window — 作業領域内に収めるウィンドウ。

戻り値

ウィンドウが配置された場合 (既に作業領域内にあった場合を含む) は true。ウィンドウが null か閉じている場合、または変更を拒否した場合は false。

WindowClose

WindowClose(window: Window) → Bool · シンプル

ユーザーが閉じるボタンをクリックした場合と同様に、ウィンドウに閉じるよう要求します。プログラムは変更の保存を求めたり、拒否したりすることがあります。ウィンドウがなくなるまで待つには WindowWaitClose を使用してください。

パラメーター

window: Window — 閉じるウィンドウ。

戻り値

閉じる要求が送信された場合は true (ウィンドウが閉じたことを意味するわけではありません)。ウィンドウが null か閉じている場合、または管理者として実行されているなど、より高い権限で実行されているプログラムのウィンドウの場合は false。

3 個の例: タイトルのパターンでウィンドウを確認後に閉じる, ストロークのボタンで分岐する, Ctrl キーを押している間は動作を変える

WindowContainsTitle

WindowContainsTitle(window: Window, text: Text) → Bool

大文字と小文字を区別せずに、ウィンドウのタイトルに特定のテキストが含まれているかどうかを確認します。

パラメーター

window: Window — タイトルを確認するウィンドウ。
text: Text — タイトル内のどこかで検索するテキスト。大文字と小文字は区別されません。

戻り値

タイトルに text が含まれている場合は true (text が空の場合は常に true)。それ以外の場合は false (null ウィンドウや閉じたウィンドウを含む)。

WindowControlFromPoint

WindowControlFromPoint(x: Integer, y: Integer) → Window

画面上の点にある最も内側のウィンドウ (プログラムのウィンドウ内のボタン、テキストボックス、その他のコントロールなど) を返します。非表示のウィンドウと無効なウィンドウはスキップされます。

パラメーター

x: Integer — 画面上の水平位置 (仮想画面のピクセル単位)。
y: Integer — 画面上の垂直位置 (仮想画面のピクセル単位)。

戻り値

点の下にあるコントロールまたはウィンドウ。何もない場合は null ウィンドウ。

4 個の例: 各種類の truthy の判定, while ループ: タイムアウト付きでウィンドウを待つ, 種類をまたいだ等価比較, ウィンドウ内の点をクリックする

WindowEnsureVisible

WindowEnsureVisible(window: Window) → Bool

ウィンドウのサイズを変えずに、ウィンドウがあるモニターの作業領域内に完全に収まるようにずらします。作業領域より大きいウィンドウは、作業領域の左上隅に揃えられます。

パラメーター

window: Window — 画面内に完全に収めるウィンドウ。

戻り値

ウィンドウが配置された場合 (既に完全に表示されていた場合を含む) は true。ウィンドウが null か閉じている場合、または移動を拒否した場合は false。

WindowFindAllByModuleRegex

WindowFindAllByModuleRegex(pattern: Text) → Integer

プログラムファイルのパスが正規表現に一致するすべてのトップレベルウィンドウ (非表示のものを含む) を検索し、その一覧を WindowGetEnumeratedAt 用に保持します。以前のウィンドウの一覧は置き換えられます。

パラメーター

pattern: Text — 各ウィンドウを所有するプログラムの完全パスと、大文字と小文字を区別せずに照合される正規表現 ('notepad[.]exe$' など)。

戻り値

一致するウィンドウの数。一致するものがない場合は 0。無効なパターンの場合は、エラーでアクションが停止します。

1 個の例: 1 つのアプリのすべてのウィンドウを最小化する

WindowFindAllByTitleRegex

WindowFindAllByTitleRegex(pattern: Text) → Integer

タイトルが正規表現に一致するすべてのトップレベルウィンドウ (非表示のものを含む) を検索し、その一覧を WindowGetEnumeratedAt 用に保持します。以前のウィンドウの一覧は置き換えられます。

パラメーター

pattern: Text — 各ウィンドウのタイトルと、大文字と小文字を区別せずに照合される正規表現。^ または $ で固定しない限り、タイトル内のどこでも一致します。

戻り値

一致するウィンドウの数。一致するものがない場合は 0。無効なパターンの場合は、エラーでアクションが停止します。

1 個の例: タイトルのパターンでウィンドウを確認後に閉じる

WindowFindByClassName

WindowFindByClassName(className: Text) → Window

大文字と小文字を区別せずに、クラス名に指定したテキストを含む、最も手前にある表示中のトップレベルウィンドウを検索します。

パラメーター

className: Text — クラス名の中で検索するテキスト ('Notepad' など)。名前の一部でも一致します。空のテキストは最も手前にある表示中のウィンドウに一致します。

戻り値

見つかったウィンドウ。一致する表示中のトップレベルウィンドウがない場合は null ウィンドウ。

WindowFindByTitle

WindowFindByTitle(title: Text) → Window

大文字と小文字を区別せずに、タイトルに指定したテキストを含む、最も手前にある表示中のトップレベルウィンドウを検索します。

パラメーター

title: Text — タイトル内のどこかで検索するテキスト。大文字と小文字は区別されません。空のテキストは最も手前にある表示中のウィンドウに一致します。

戻り値

見つかったウィンドウ。一致する表示中のトップレベルウィンドウがない場合は null ウィンドウ。

WindowFitToScreen

WindowFitToScreen(window: Window) → Bool · シンプル

ウィンドウを最大化せずに、ウィンドウの見える端がモニターの作業領域 (画面からタスクバーを除いた領域) いっぱいになるようにサイズを変更して移動します。

パラメーター

window: Window — 作業領域に合わせるウィンドウ。

戻り値

ウィンドウのサイズが変更された場合は true。ウィンドウが null か閉じている場合、または変更を拒否した場合は false。

WindowFromPoint

WindowFromPoint(x: Integer, y: Integer) → Window

画面上の点にあるトップレベルウィンドウ (マウスの下にあるプログラムのウィンドウなど) を、その中のコントロールではなく返します。

パラメーター

x: Integer — 画面上の水平位置 (仮想画面のピクセル単位)。
y: Integer — 画面上の垂直位置 (仮想画面のピクセル単位)。

戻り値

点の下にあるトップレベルウィンドウ。何もない場合は null ウィンドウ。

WindowFromProcessId

WindowFromProcessId(processId: Integer) → Window

実行中のプログラムのメインウィンドウ、つまりそのプロセスが所有する、最も手前にある表示中のトップレベルウィンドウを返します。

パラメーター

processId: Integer — WindowGetProcessId または ShellGetEnumeratedProcessIdAt が返すプロセス ID。

戻り値

ウィンドウ。プロセスに表示中のトップレベルウィンドウがない場合、または processId が 0 の場合は null ウィンドウ。

1 個の例: プロセスからウィンドウへ

WindowGetActive

WindowGetActive() → Window

フォアグラウンドウィンドウ、つまりユーザーが現在作業しているトップレベルウィンドウを返します。

パラメーター

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

戻り値

アクティブなウィンドウ。その時点でアクティブなウィンドウがない場合 (フォーカスの切り替え中など) は null ウィンドウ。

4 個の例: 5 種類の値, 3 つ以上の値を書式設定する, 大文字と小文字を区別しない比較, アクティブウィンドウをモニターの左半分にスナップする

WindowGetAllChildren

WindowGetAllChildren(window: Window, directOnly: Bool) → Integer

ウィンドウ内の子ウィンドウ (コントロール) を一覧にし、その一覧を WindowGetEnumeratedAt 用に保持します。以前のウィンドウの一覧は置き換えられます。

パラメーター

window: Window — 子ウィンドウを一覧にするウィンドウ。
directOnly: Bool — true の場合はウィンドウの直接の子だけ。false の場合はすべての階層の子孫。

戻り値

見つかった子ウィンドウの数。1 つもない場合、またはウィンドウが null の場合は 0。

1 個の例: ウィンドウの子コントロールを調べる

WindowGetAllProps

WindowGetAllProps(window: Window) → Integer

このエンジン、プログラム自体、またはその他のソフトウェアによってウィンドウに格納されたすべてのプロパティを一覧にし、その一覧を WindowGetEnumeratedPropNameAt と WindowGetEnumeratedPropValueAt 用に保持します。

パラメーター

window: Window — プロパティを一覧にするウィンドウ。

戻り値

見つかったプロパティの数。1 つもない場合、またはウィンドウが null の場合は 0。

WindowGetAllTopLevel

WindowGetAllTopLevel() → Integer

デスクトップ上のすべてのトップレベルウィンドウを、非表示のものやクロークされたものも含めて手前から奥の順に一覧にし、その一覧を WindowGetEnumeratedAt 用に保持します。以前のウィンドウの一覧は置き換えられます。

パラメーター

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

戻り値

見つかったトップレベルウィンドウの数。

1 個の例: 表示されているトップレベルウィンドウを一覧表示する

WindowGetAlpha

WindowGetAlpha(window: Window) → Integer

WindowSetAlpha またはプログラム自体によって設定された、ウィンドウの透明度のレベルを返します。

パラメーター

window: Window — 読み取るウィンドウ。

戻り値

0 (完全に透明) から 255 (完全に不透明) までの値。透明度が設定されていないウィンドウ、および null ウィンドウや閉じたウィンドウの場合は 255。

1 個の例: ウィンドウの透明度を順に切り替える

WindowGetClassName

WindowGetClassName(window: Window) → Text

ウィンドウのクラス名 ('Notepad' や 'Button' など、Windows がそのウィンドウに使用する種類の名前) を返します。タイトルが変わるウィンドウを識別するのに便利です。

パラメーター

window: Window — 読み取るウィンドウ。

戻り値

クラス名。ウィンドウが null か閉じている場合は空のテキスト。

2 個の例: ウィンドウの子コントロールを調べる, カーソルの下にあるものを説明する

WindowGetControlText

WindowGetControlText(window: Window) → Text

任意のプログラムのコントロール (テキストボックス、ステータスバー、ダイアログのメッセージなど) のテキストを読み取ります。従来の Windows コントロールでのみ機能します。プログラムが応答しない場合は、最大 2 秒間スクリプトをブロックします。

パラメーター

window: Window — 読み取るコントロールまたはウィンドウ (WindowControlFromPoint や WindowGetEnumeratedAt で取得したものなど)。

戻り値

コントロールのテキスト (最大約 100 万文字)。テキストがない場合、ウィンドウが null か閉じている場合、またはプログラムが応答しなかった場合は空のテキスト。他のプログラムのパスワードボックスでは空のテキストになります。

WindowGetDpi

WindowGetDpi(window: Window) → Integer

ウィンドウがあるモニターの DPI を返します。表示スケール 100 パーセントでは 96、150 パーセントでは 144 です。

パラメーター

window: Window — 確認するウィンドウ。

戻り値

DPI。ウィンドウが null か閉じている場合は 0。

WindowGetEnabled

WindowGetEnabled(window: Window) → Bool

ウィンドウがマウスとキーボードの入力を受け付けるかどうかを確認します。無効なウィンドウやコントロールは、通常は淡色表示になります。

パラメーター

window: Window — 確認するウィンドウ。

戻り値

ウィンドウが有効な場合は true。無効な場合、null の場合、または閉じている場合は false。

WindowGetEnumeratedAt

WindowGetEnumeratedAt(index: Integer) → Window

最後に呼び出した WindowGetAllTopLevel、WindowGetAllChildren、WindowFindAllByTitleRegex、WindowFindAllByModuleRegex が作成した一覧から、ウィンドウを 1 つ返します。

パラメーター

index: Integer — 一覧内の位置。0 から、一覧を作成した呼び出しが返した数 - 1 まで。

戻り値

その位置にあるウィンドウ。index が範囲外の場合は null ウィンドウ。

4 個の例: 表示されているトップレベルウィンドウを一覧表示する, 1 つのアプリのすべてのウィンドウを最小化する, タイトルのパターンでウィンドウを確認後に閉じる, ウィンドウの子コントロールを調べる

WindowGetEnumeratedPropNameAt

WindowGetEnumeratedPropNameAt(index: Integer) → Text

最後に呼び出した WindowGetAllProps が作成した一覧から、プロパティの名前を 1 つ返します。

パラメーター

index: Integer — 一覧内の位置。0 から、WindowGetAllProps が返した数 - 1 まで。

戻り値

プロパティの名前。index が範囲外の場合は空のテキスト。

WindowGetEnumeratedPropValueAt

WindowGetEnumeratedPropValueAt(index: Integer) → Integer

最後に呼び出した WindowGetAllProps が作成した一覧から、プロパティの生の整数値を 1 つ返します。WindowSetPropertyText で設定したプロパティでは、テキストではなく内部的な数値が返されます。

パラメーター

index: Integer — 一覧内の位置。0 から、WindowGetAllProps が返した数 - 1 まで。

戻り値

プロパティの値。index が範囲外の場合は 0。

WindowGetExecutableFolder

WindowGetExecutableFolder(window: Window) → Text

ウィンドウを所有するプログラムを含むフォルダーを、ファイル名と末尾の区切り記号を除いて返します。ファイル名には WindowGetExecutableName を、両方には WindowGetExecutableFullPath を使用してください。

パラメーター

window: Window — プログラムの場所を調べるウィンドウ。

戻り値

フォルダーのパス。ウィンドウが null か閉じている場合、またはプログラムを照会できない場合は空のテキスト。

WindowGetExecutableFullPath

WindowGetExecutableFullPath(window: Window) → Text

ウィンドウを所有するプログラムの完全パスを、フォルダーとファイル名を合わせて返します (Windows フォルダーにある notepad.exe のパスなど)。一方だけが必要な場合は WindowGetExecutableFolder または WindowGetExecutableName を使用してください。

パラメーター

window: Window — プログラムの場所を調べるウィンドウ。

戻り値

完全パス。ウィンドウが null か閉じている場合、またはプログラムを照会できない場合は空のテキスト。

WindowGetExecutableName

WindowGetExecutableName(window: Window) → Text

ウィンドウを所有するプログラムのファイル名 ('notepad.exe' など) を返します。

パラメーター

window: Window — プログラムを特定するウィンドウ。

戻り値

プログラムのファイル名。ウィンドウが null か閉じている場合、またはプログラムを照会できない場合は空のテキスト。

2 個の例: 大文字と小文字を区別しない比較, 表示されているトップレベルウィンドウを一覧表示する

WindowGetHeight

WindowGetHeight(window: Window) → Integer

Windows がほとんどのウィンドウの周囲に追加する、見えないサイズ変更用の境界線を除いた、ウィンドウの表示上の高さを返します。

パラメーター

window: Window — サイズを測るウィンドウ。

戻り値

高さ (ピクセル単位)。ウィンドウが null か閉じている場合は 0。

3 個の例: 3 つ以上の値を書式設定する, アクティブウィンドウをモニターの左半分にスナップする, カーソルを 5 秒間ウィンドウ内に制限する

WindowGetLastFocus

WindowGetLastFocus() → Window

デスクトップ上で最後にキーボードフォーカスを受け取ったウィンドウまたはコントロールを返します。多くの場合、トップレベルウィンドウではなく、テキストボックスなどのコントロールです。

パラメーター

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

戻り値

最後にフォーカスがあったウィンドウまたはコントロール。エンジンの起動以降にフォーカスが変わっていない場合は null ウィンドウ。

WindowGetMovableAncestor

WindowGetMovableAncestor(window: Window) → Window

ドラッグできる最も近いウィンドウ、つまりウィンドウ自体、またはその上位でシステムメニューを持つ最初の親を返します。マウスの下にあるコントロールを、移動するウィンドウに変換するのに使用します。

パラメーター

window: Window — 開始点となるウィンドウまたはコントロール。

戻り値

ウィンドウ自体、またはシステムメニューを持つ最初の親。どれもシステムメニューを持たない場合、またはウィンドウが null の場合は null ウィンドウ。

WindowGetParent

WindowGetParent(window: Window) → Window

コントロールを含むウィンドウを返します。ダイアログなどのポップアップウィンドウの場合は、それを所有するウィンドウになることがあります。

パラメーター

window: Window — 親を取得するウィンドウまたはコントロール。

戻り値

親ウィンドウまたはオーナーウィンドウ。ない場合、またはウィンドウが null か閉じている場合は null ウィンドウ。

WindowGetProcessId

WindowGetProcessId(window: Window) → Integer

ウィンドウを所有するプロセス (実行中のプログラム) の ID を返します。タスクマネージャーに表示されるのと同じ番号です。

パラメーター

window: Window — プロセスを特定するウィンドウ。

戻り値

プロセス ID。ウィンドウが null か閉じている場合は 0。

WindowGetPropertyInteger

WindowGetPropertyInteger(window: Window, name: Text) → Integer

ウィンドウに格納された名前付きの整数を読み取ります。たとえば、そのウィンドウについて何かを記憶するために、以前に WindowSetPropertyInteger で格納した値です。

パラメーター

window: Window — 読み取り元のウィンドウ。
name: Text — プロパティの名前。

戻り値

格納されている値。プロパティが存在しない場合、またはウィンドウが null の場合は 0。格納された 0 とプロパティが存在しない場合は区別できません。

2 個の例: ウィンドウを最前面に固定する, ウィンドウの位置を記憶して復元する

WindowGetPropertyText

WindowGetPropertyText(window: Window, name: Text) → Text

このエンジンが WindowSetPropertyText でウィンドウに格納した、名前付きのテキスト値を読み取ります。

パラメーター

window: Window — 読み取り元のウィンドウ。
name: Text — プロパティの名前。

戻り値

格納されているテキスト。プロパティが存在しない場合、このエンジンがテキストとして格納したものではない場合、その後上書きされた場合、またはウィンドウが null の場合は空のテキスト。

WindowGetRoot

WindowGetRoot(window: Window) → Window

ウィンドウまたはコントロールを含むトップレベルウィンドウ (ボタンを囲むプログラムのウィンドウなど) を返します。

パラメーター

window: Window — 開始点となるウィンドウまたはコントロール。

戻り値

トップレベルウィンドウ。ウィンドウが既にトップレベルの場合はウィンドウ自体。ウィンドウが null か閉じている場合は null ウィンドウ。

9 個の例: 大文字と小文字を区別しない比較, 1 つのジェスチャで複数の選択肢, ウィンドウを最前面に固定する, 表示されているトップレベルウィンドウを一覧表示する, ウィンドウの子コントロールを調べる, プロセスからウィンドウへ, カーソルの下にあるものを説明する, トリガーのコンテキストで取得できるすべての情報, ストレージに保持するリスト

WindowGetTitle

WindowGetTitle(window: Window) → Text

ウィンドウのタイトルバーのテキストを返します。他のプログラムのコントロールでは通常は空になるため、その場合は WindowGetControlText を使用してください。

パラメーター

window: Window — 読み取るウィンドウ。

戻り値

タイトル。タイトルがない場合、またはウィンドウが null か閉じている場合は空のテキスト。

WindowGetVisible

WindowGetVisible(window: Window) → Bool

ウィンドウが表示される設定になっているかどうかを確認します。表示中のウィンドウでも、最小化されていたり、他のウィンドウに隠れていたり、画面外や別の仮想デスクトップにあったりすることがあります。

パラメーター

window: Window — 確認するウィンドウ。

戻り値

ウィンドウとそのすべての親が表示されている場合は true。非表示の場合、null の場合、または閉じている場合は false。

1 個の例: 表示されているトップレベルウィンドウを一覧表示する

WindowGetWidth

WindowGetWidth(window: Window) → Integer

Windows がほとんどのウィンドウの周囲に追加する、見えないサイズ変更用の境界線を除いた、ウィンドウの表示上の幅を返します。

パラメーター

window: Window — サイズを測るウィンドウ。

戻り値

幅 (ピクセル単位)。ウィンドウが null か閉じている場合は 0。

3 個の例: 3 つ以上の値を書式設定する, アクティブウィンドウをモニターの左半分にスナップする, カーソルを 5 秒間ウィンドウ内に制限する

WindowGetX

WindowGetX(window: Window) → Integer

見えないサイズ変更用の境界線を除いた、ウィンドウの表示上の左端の画面上の位置を返します。最小化されたウィンドウでは、画面外の待避位置になります。

パラメーター

window: Window — 位置を調べるウィンドウ。

戻り値

左端 (仮想画面のピクセル単位)。ウィンドウが null か閉じている場合は 0。

4 個の例: 3 つ以上の値を書式設定する, アクティブウィンドウをモニターの左半分にスナップする, ウィンドウの位置を記憶して復元する, カーソルを 5 秒間ウィンドウ内に制限する

WindowGetY

WindowGetY(window: Window) → Integer

見えないサイズ変更用の境界線を除いた、ウィンドウの表示上の上端の画面上の位置を返します。最小化されたウィンドウでは、画面外の待避位置になります。

パラメーター

window: Window — 位置を調べるウィンドウ。

戻り値

上端 (仮想画面のピクセル単位)。ウィンドウが null か閉じている場合は 0。

WindowHide

WindowHide(window: Window) → Bool

タスクバーボタンも含めて、ウィンドウを完全に非表示にします。エンジンは終了時にウィンドウを再表示します。また、通知領域のメニューの [非表示のウィンドウを表示] でいつでも元に戻せます。

パラメーター

window: Window — 非表示にするウィンドウ。

戻り値

ウィンドウが非表示になった場合、または既に非表示だった場合は true。ウィンドウが null か閉じている場合、デスクトップ、タスクバー、このエンジン自身のウィンドウのいずれかである場合、または既に 256 個の非表示ウィンドウを追跡している場合は false。

WindowIsCloaked

WindowIsCloaked(window: Window) → Bool

表示されていると見なされるにもかかわらず、Windows がウィンドウを見えない状態にしているかどうかを確認します。たとえば、別の仮想デスクトップ上のウィンドウや中断された Store アプリです。一覧でそのようなウィンドウをスキップするのに便利です。

パラメーター

window: Window — 確認するウィンドウ。

戻り値

ウィンドウがクロークされている場合は true。クロークされていない場合、またはウィンドウが null か閉じている場合は false。

1 個の例: 表示されているトップレベルウィンドウを一覧表示する

WindowIsMaximized

WindowIsMaximized(window: Window) → Bool

ウィンドウが最大化されているかどうかを確認します。たとえば、WindowRestore と WindowMaximize のどちらを呼び出すかを決める前に使用します。

パラメーター

window: Window — 確認するウィンドウ。

戻り値

ウィンドウが最大化されている場合は true。最大化されていない場合、またはウィンドウが null か閉じている場合は false。

1 個の例: ジェスチャのウィンドウの最大化を切り替える

WindowIsMinimized

WindowIsMinimized(window: Window) → Bool

ウィンドウがタスクバーに最小化されているかどうかを確認します。たとえば、WindowRestore を呼び出すかどうかを決める前に使用します。

パラメーター

window: Window — 確認するウィンドウ。

戻り値

ウィンドウが最小化されている場合は true。最小化されていない場合、またはウィンドウが null か閉じている場合は false。

WindowMapClientPointToScreenX

WindowMapClientPointToScreenX(window: Window, x: Integer, y: Integer) → Integer

ウィンドウのクライアント領域 (タイトルバーより下で境界線の内側にあるウィンドウの内部) 内の点を画面上の位置に変換し、その水平成分を返します。

パラメーター

window: Window — 点がクライアント領域内にあるウィンドウ。
x: Integer — クライアント領域の左端からの水平位置 (ピクセル単位)。
y: Integer — クライアント領域の上端からの垂直位置 (ピクセル単位)。

戻り値

画面上の X 位置 (仮想画面のピクセル単位)。ウィンドウが null か閉じている場合は 0。

WindowMapClientPointToScreenY

WindowMapClientPointToScreenY(window: Window, x: Integer, y: Integer) → Integer

ウィンドウのクライアント領域 (タイトルバーより下で境界線の内側にあるウィンドウの内部) 内の点を画面上の位置に変換し、その垂直成分を返します。

パラメーター

window: Window — 点がクライアント領域内にあるウィンドウ。
x: Integer — クライアント領域の左端からの水平位置 (ピクセル単位)。
y: Integer — クライアント領域の上端からの垂直位置 (ピクセル単位)。

戻り値

画面上の Y 位置 (仮想画面のピクセル単位)。ウィンドウが null か閉じている場合は 0。

WindowMapScreenPointToClientX

WindowMapScreenPointToClientX(window: Window, x: Integer, y: Integer) → Integer

画面上の位置を、ウィンドウのクライアント領域 (タイトルバーより下で境界線の内側にあるウィンドウの内部) を基準とした点に変換し、その水平成分を返します。

パラメーター

window: Window — 基準となるクライアント領域を持つウィンドウ。
x: Integer — 画面上の水平位置 (仮想画面のピクセル単位)。
y: Integer — 画面上の垂直位置 (仮想画面のピクセル単位)。

戻り値

クライアント領域の左端からの X 位置 (ピクセル単位)。点がそれより左にある場合は負の値。ウィンドウが null か閉じている場合は 0。

WindowMapScreenPointToClientY

WindowMapScreenPointToClientY(window: Window, x: Integer, y: Integer) → Integer

画面上の位置を、ウィンドウのクライアント領域 (タイトルバーより下で境界線の内側にあるウィンドウの内部) を基準とした点に変換し、その垂直成分を返します。

パラメーター

window: Window — 基準となるクライアント領域を持つウィンドウ。
x: Integer — 画面上の水平位置 (仮想画面のピクセル単位)。
y: Integer — 画面上の垂直位置 (仮想画面のピクセル単位)。

戻り値

クライアント領域の上端からの Y 位置 (ピクセル単位)。点がそれより上にある場合は負の値。ウィンドウが null か閉じている場合は 0。