Signaturen der integrierten Funktionen

Alle integrierten Funktionen, nach Bereich gruppiert. Jede Zeile zeigt die Namen und Typen der Parameter in ihrer Reihenfolge sowie den zurückgegebenen Typ. Einfach kennzeichnet die integrierten Funktionen, die der einfache Modus der Konfigurationsoberfläche anbietet. Beispiele filtert die Beispielbibliothek auf Skripts, die diese integrierte Funktion aufrufen. Die QuickInfo der Autovervollständigung im Editor zeigt dieselben Signaturen.

AutoHotkey

AutoHotkeyExecuteScript

AutoHotkeyExecuteScript(script: Text) → Integer · Einfach

Führt AutoHotkey-v2-Code mit dem in den Einstellungen festgelegten AutoHotkey-Programm aus und wartet, bis es beendet ist. Der Kontext des Auslösers wird als Variablen übergeben, und Ausgabezeilen werden mit dem Präfix AHK: ausgegeben.

Parameter

• script: Text — Der auszuführende AutoHotkey-v2-Skripttext. Wird die Aktion beendet, wird auch der AutoHotkey-Prozess beendet.

Rückgabe

Der Exitcode von AutoHotkey oder -1, wenn die AutoHotkey-Unterstützung ausgeschaltet ist, der Programmpfad nicht festgelegt ist oder nicht gefunden wird oder das Programm nicht gestartet werden konnte.

1 Beispiel: An AutoHotkey übergeben

Capture

CaptureSaveRegion

CaptureSaveRegion(fileName: Text, x: Integer, y: Integer, width: Integer, height: Integer) → Bool

Nimmt ein Rechteck des Bildschirms auf und speichert es als Bilddatei. Entfernt zuvor die eigene Gestenspur und den Hinweis dieser App vom Bildschirm und wartet dafür bis zu 250 Millisekunden.

Parameter

• fileName: Text — Pfad der zu schreibenden Bilddatei. Die Erweiterung (.bmp, .png, .jpg oder .jpeg) bestimmt das Format. Eine vorhandene Datei wird überschrieben; fehlende Ordner werden nicht erstellt.
• x: Integer — Linker Rand des Rechtecks, in Bildschirmpixeln.
• y: Integer — Oberer Rand des Rechtecks, in Bildschirmpixeln.
• width: Integer — Breite des Rechtecks, in Pixeln. Muss größer als 0 sein.
• height: Integer — Höhe des Rechtecks, in Pixeln. Muss größer als 0 sein.

Rückgabe

true, wenn die Bilddatei geschrieben wurde; false, wenn width oder height nicht positiv ist, die Aufnahme fehlgeschlagen ist oder die Datei nicht geschrieben werden konnte. Ein fileName, der nicht auf .bmp, .png, .jpg oder .jpeg endet, beendet das Skript mit einem Fehler.

1 Beispiel: Einen Screenshot des umkreisten Bereichs erstellen

CaptureShowImage

CaptureShowImage(fileName: Text) → Bool

Zeigt eine Bilddatei in Originalgröße in einem rahmenlosen, immer im Vordergrund liegenden Vorschaufenster an, zentriert auf dem Monitor unter dem Mauszeiger. Ziehen verschiebt es, Doppelklicken schließt es, ein Rechtsklick bietet Kopieren, Speichern und Schließen.

Parameter

• fileName: Text — Pfad der anzuzeigenden .bmp-, .png-, .jpg- oder .jpeg-Datei.

Rückgabe

true, wenn das Bild geladen wurde und sein Vorschaufenster geöffnet wird; false, wenn die Datei fehlt oder kein lesbares Bild ist. Ein fileName, der nicht auf .bmp, .png, .jpg oder .jpeg endet, beendet das Skript mit einem Fehler.

CaptureShowRegion

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

Nimmt ein Rechteck des Bildschirms auf und zeigt die Kopie in einem rahmenlosen, immer im Vordergrund liegenden Vorschaufenster genau über diesem Bereich an. Entfernt zuvor die eigene Gestenspur und den Hinweis dieser App und wartet bis zu 250 Millisekunden.

Parameter

• x: Integer — Linker Rand des Rechtecks, in Bildschirmpixeln.
• y: Integer — Oberer Rand des Rechtecks, in Bildschirmpixeln.
• width: Integer — Breite des Rechtecks, in Pixeln. Muss größer als 0 sein.
• height: Integer — Höhe des Rechtecks, in Pixeln. Muss größer als 0 sein.

Rückgabe

true, wenn die Aufnahme erfolgreich war und ihr Vorschaufenster geöffnet wird; false, wenn width oder height nicht positiv ist oder der Bildschirm nicht aufgenommen werden konnte.

Clipboard

ClipboardClear

ClipboardClear() → Bool

Leert die Zwischenablage und entfernt Text, Bilder und alle anderen Formate, ohne etwas Neues hineinzulegen.

Parameter

Keine Parameter.

Rückgabe

true, wenn die Zwischenablage geleert wurde; false, wenn ein anderes Programm die Zwischenablage belegt hielt.

1 Beispiel: Den markierten Text in Großbuchstaben umwandeln

ClipboardCopySelection

ClipboardCopySelection(timeoutMs: Integer) → Text · Einfach

Sendet Strg+C an das aktive Fenster und gibt den kopierten Text zurück. Wartet zuvor, bis Strg, Umschalt, Alt und die Windows-Tasten losgelassen sind. Die Kopie ersetzt den Inhalt der Zwischenablage; verwenden Sie ClipboardSave und ClipboardRestore, um ihn zu erhalten.

Parameter

• timeoutMs: Integer — Gesamte Wartezeit für das Loslassen der Tasten und das Eintreffen der Kopie, in Millisekunden, von 0 bis 60000. Größere Werte zählen als 60000. 1000 passt für die meisten Programme.

Rückgabe

Der kopierte Text oder leerer Text, wenn die Tasten gedrückt blieben, nichts kopiert wurde (keine Auswahl) oder die Kopie keinen Text enthält, bevor timeoutMs abläuft.

1 Beispiel: Im Web nach dem markierten Text suchen

ClipboardGetHtml

ClipboardGetHtml() → Text

Gibt den HTML-Inhalt der Zwischenablage zurück, etwa das, was ein Browser dort ablegt, wenn Sie einen Teil einer Webseite kopieren.

Parameter

Keine Parameter.

Rückgabe

Das kopierte HTML-Fragment ohne den HTML-Header der Zwischenablage oder leerer Text, wenn die Zwischenablage kein HTML enthält oder belegt ist.

ClipboardGetRtf

ClipboardGetRtf() → Text

Gibt den formatierten Text (RTF) der Zwischenablage zurück, etwa das, was ein Textverarbeitungsprogramm dort ablegt, wenn Sie formatierten Text kopieren.

Parameter

Keine Parameter.

Rückgabe

Das RTF-Markup als Text oder leerer Text, wenn die Zwischenablage kein RTF enthält oder belegt ist.

ClipboardGetSequenceNumber

ClipboardGetSequenceNumber() → Integer

Gibt eine Zahl zurück, die Windows bei jeder Änderung des Inhalts der Zwischenablage ändert. Lesen Sie sie vor einem Vorgang, der kopieren soll, und vergleichen Sie danach, um zu erkennen, dass die Kopie angekommen ist.

Parameter

Keine Parameter.

Rückgabe

Die aktuelle Sequenznummer der Zwischenablage. Aussagekräftig ist nur eine Änderung der Zahl, nicht der Wert selbst.

ClipboardGetText

ClipboardGetText() → Text · Einfach

Gibt den reinen Text zurück, der sich gerade in der Zwischenablage befindet. Formatierungen, Bilder und Dateien in der Zwischenablage werden ignoriert.

Parameter

Keine Parameter.

Rückgabe

Der Text der Zwischenablage oder leerer Text, wenn die Zwischenablage keinen Text enthält oder ein anderes Programm sie belegt hielt.

6 Beispiele: Mit einem regulären Ausdruck einen Wert aus kopiertem Text holen, Wörter in der Zwischenablage zählen, Zeilen der Zwischenablage zu einer Zeile verbinden, Das heutige Datum und ein Dateiname mit Zeitstempel, Den markierten Text in Großbuchstaben umwandeln, Im Web nach der Markierung suchen

ClipboardLoadImage

ClipboardLoadImage(path: Text) → Bool

Lädt eine Bilddatei und legt sie in die Zwischenablage, wobei der aktuelle Inhalt ersetzt wird, bereit zum Einfügen in andere Programme. Transparente Bereiche einer PNG-Datei werden weiß.

Parameter

• path: Text — Vollständiger Pfad der Bilddatei, endend auf .bmp, .png, .jpg oder .jpeg. Jede andere Erweiterung beendet das Skript mit einem Fehler.

Rückgabe

true, wenn sich das Bild in der Zwischenablage befindet; false, wenn die Datei fehlt, kein lesbares Bild ist oder die Zwischenablage belegt ist.

ClipboardPasteReplacementText

ClipboardPasteReplacementText(text: Text) → Bool · Einfach

Legt Text in die Zwischenablage und sendet Strg+V, um ihn in das aktive Fenster einzufügen. Wartet nicht, bis das Einfügen abgeschlossen ist; warten Sie daher vor ClipboardRestore kurz mit UtilityWait.

Parameter

• text: Text — Der einzufügende Text.

Rückgabe

true, wenn die Zwischenablage gesetzt und Strg+V gesendet wurde; false, wenn die Zwischenablage belegt war oder Windows die Tastenanschläge blockiert hat.

2 Beispiele: Eine Vorlage füllen und einfügen, Den markierten Text in Großbuchstaben umwandeln

ClipboardRestore

ClipboardRestore() → Bool

Stellt den durch das letzte ClipboardSave in diesem Skriptlauf gespeicherten Inhalt der Zwischenablage in allen Formaten wieder her. Ohne vorheriges ClipboardSave in diesem Lauf wird die Zwischenablage geleert.

Parameter

Keine Parameter.

Rückgabe

true, wenn alles Gespeicherte wiederhergestellt wurde; false, wenn die Zwischenablage belegt war oder ein Format nicht wiederhergestellt werden konnte.

5 Beispiele: Eine Vorlage füllen und einfügen, Im Web nach dem markierten Text suchen, Den markierten Text in Großbuchstaben umwandeln, Im Web nach der Markierung suchen, Nur eine Aktion gleichzeitig einen Abschnitt ausführen lassen

ClipboardSave

ClipboardSave() → Bool

Speichert eine Kopie des gesamten Inhalts der Zwischenablage in allen Formaten, damit ClipboardRestore ihn später im selben Skriptlauf wiederherstellen kann. Ein zweiter Aufruf ersetzt die gespeicherte Kopie.

Parameter

Keine Parameter.

Rückgabe

true, wenn die Zwischenablage gelesen wurde; false, wenn ein anderes Programm sie belegt hielt.

5 Beispiele: Eine Vorlage füllen und einfügen, Im Web nach dem markierten Text suchen, Den markierten Text in Großbuchstaben umwandeln, Im Web nach der Markierung suchen, Nur eine Aktion gleichzeitig einen Abschnitt ausführen lassen

ClipboardSaveImage

ClipboardSaveImage(path: Text) → Bool

Speichert das Bild in der Zwischenablage, etwa einen mit der Druck-Taste erstellten Screenshot, in einer Datei im Format, das die Dateierweiterung angibt. Eine vorhandene Datei wird überschrieben.

Parameter

• path: Text — Vollständiger Pfad der zu schreibenden Datei, endend auf .bmp, .png, .jpg oder .jpeg. Jede andere Erweiterung beendet das Skript mit einem Fehler.

Rückgabe

true, wenn die Datei geschrieben wurde; false, wenn die Zwischenablage kein Bild enthält oder die Datei nicht geschrieben werden konnte.

1 Beispiel: Ein kopiertes Bild in einer Datei speichern

ClipboardSetHtml

ClipboardSetHtml(html: Text) → Bool

Legt ein HTML-Fragment in die Zwischenablage und ersetzt den aktuellen Inhalt, sodass beim Einfügen in eine E-Mail oder ein Textverarbeitungsprogramm die Formatierung erhalten bleibt. Zusätzlich wird eine Nur-Text-Kopie ohne Tags hinzugefügt, für Programme, die nur Text einfügen.

Parameter

• html: Text — Das abzulegende HTML-Fragment, etwa <b>fetter</b> Text. Fügen Sie den HTML-Header der Zwischenablage nicht selbst hinzu; er wird automatisch ergänzt.

Rückgabe

true, wenn das HTML und seine Nur-Text-Kopie in die Zwischenablage gelegt wurden; false, wenn die Zwischenablage belegt war.

ClipboardSetRtf

ClipboardSetRtf(rtf: Text) → Bool

Legt formatierten Text (RTF) in die Zwischenablage und ersetzt den aktuellen Inhalt, sodass beim Einfügen in WordPad, Word oder Outlook die Formatierung erhalten bleibt. Zusätzlich wird eine Nur-Text-Kopie der Wörter hinzugefügt, für Programme, die nur Text einfügen.

Parameter

• rtf: Text — Ein vollständiges RTF-Dokument als Text. Jedes Zeichen kann direkt eingegeben werden; Zeichen außerhalb von einfachem ASCII werden automatisch als RTF-Unicode-Escapes geschrieben.

Rückgabe

true, wenn das RTF und seine Nur-Text-Kopie in die Zwischenablage gelegt wurden; false, wenn die Zwischenablage belegt war.

ClipboardSetText

ClipboardSetText(text: Text) → Bool · Einfach

Legt Text in die Zwischenablage und ersetzt den vorhandenen Inhalt, bereit zum Einfügen in jedes Programm.

Parameter

• text: Text — Der Text, der in die Zwischenablage gelegt werden soll.

Rückgabe

true, wenn der Text in die Zwischenablage gelegt wurde; false, wenn ein anderes Programm die Zwischenablage belegt hielt.

2 Beispiele: Mit einem regulären Ausdruck einen Wert aus kopiertem Text holen, Zeilen der Zwischenablage zu einer Zeile verbinden

Context

ContextGetActionName

ContextGetActionName() → Text

Gibt den Namen der laufenden Aktion zurück. Ein globales Ereignis gibt Global_Event_ gefolgt von der ID des Ereignisses zurück, etwa Global_Event_release.

Parameter

Keine Parameter.

Rückgabe

Der Name der Aktion, ein Global_Event_-Name für ein globales Ereignis oder leerer Text in einem Skript eines Timers, einer Ordnerüberwachung oder eines seriellen Monitors.

1 Beispiel: Alles, was der Auslöserkontext weiß

ContextGetApplicationName

ContextGetApplicationName() → Text

Gibt den Namen der App-Gruppe zurück, deren Aktion läuft, für eine Aktion, die durch eine Geste, einen Hotkey oder eine Texterweiterung ausgelöst wurde.

Parameter

Keine Parameter.

Rückgabe

Der Name der App-Gruppe (für die globale Gruppe meist Global) oder leerer Text für ein globales Ereignis oder das Skript eines Timers, einer Ordnerüberwachung oder eines seriellen Monitors.

4 Beispiele: Eine Vorlage füllen und einfügen, Alles, was der Auslöserkontext weiß, Eine nicht erkannte Zeichnung durchlassen, An eine Protokolldatei anhängen

ContextGetBoundingBoxHeight

ContextGetBoundingBoxHeight() → Integer

Gibt die Höhe des Rechtecks um die gesamte gezeichnete Geste in Pixeln zurück. Außerhalb einer Geste wird 0 zurückgegeben.

Parameter

Keine Parameter.

Rückgabe

Die Höhe in Pixeln oder 0 außerhalb einer Geste.

2 Beispiele: Alles, was der Auslöserkontext weiß, Einen Screenshot des umkreisten Bereichs erstellen

ContextGetBoundingBoxWidth

ContextGetBoundingBoxWidth() → Integer

Gibt die Breite des Rechtecks um die gesamte gezeichnete Geste in Pixeln zurück. Außerhalb einer Geste wird 0 zurückgegeben.

Parameter

Keine Parameter.

Rückgabe

Die Breite in Pixeln oder 0 außerhalb einer Geste.

2 Beispiele: Alles, was der Auslöserkontext weiß, Einen Screenshot des umkreisten Bereichs erstellen

ContextGetBoundingBoxX

ContextGetBoundingBoxX() → Integer

Gibt den linken Rand des Rechtecks um die gesamte gezeichnete Geste in Pixeln des virtuellen Bildschirms zurück. Außerhalb einer Geste wird 0 zurückgegeben.

Parameter

Keine Parameter.

Rückgabe

Der linke Rand in Pixeln des virtuellen Bildschirms oder 0 außerhalb einer Geste.

2 Beispiele: Alles, was der Auslöserkontext weiß, Einen Screenshot des umkreisten Bereichs erstellen

ContextGetBoundingBoxY

ContextGetBoundingBoxY() → Integer

Gibt den oberen Rand des Rechtecks um die gesamte gezeichnete Geste in Pixeln des virtuellen Bildschirms zurück. Außerhalb einer Geste wird 0 zurückgegeben.

Parameter

Keine Parameter.

Rückgabe

Der obere Rand in Pixeln des virtuellen Bildschirms oder 0 außerhalb einer Geste.

2 Beispiele: Alles, was der Auslöserkontext weiß, Einen Screenshot des umkreisten Bereichs erstellen

ContextGetButtonState

ContextGetButtonState() → Text

Gibt an, ob ein globales Maustastenereignis beim Drücken oder beim Loslassen der Taste ausgelöst wurde. Nur das Skript eines globalen Maustastenereignisses erhält einen Wert.

Parameter

Keine Parameter.

Rückgabe

'down' für das Drücken, 'up' für das Loslassen oder leerer Text für jeden anderen Auslöser, auch für eine Geste.

ContextGetControl

ContextGetControl() → Window

Gibt genau das Steuerelement zurück, auf das der Auslöser zielte, etwa ein Eingabefeld unter der Geste oder der Maus oder das fokussierte Fenster bei einem Hotkey oder einer Texterweiterung. Für das zugehörige Anwendungsfenster verwenden Sie ContextGetWindow.

Parameter

Keine Parameter.

Rückgabe

Das Steuerelement als Window oder ein Null-Fenster, wenn der Auslöser kein Fenster hat, wie bei einem Timer, einer Ordnerüberwachung, einem seriellen Monitor oder einem Load-Skript.

ContextGetGestureName

ContextGetGestureName() → Text

Gibt den Namen der Geste zurück, die gezeichnet wurde, um diese Aktion auszuführen. Das ist der eigene Name der Geste, nicht der der Aktion; siehe ContextGetActionName.

Parameter

Keine Parameter.

Rückgabe

Der Name der Geste oder leerer Text außerhalb einer Geste.

2 Beispiele: Alles, was der Auslöserkontext weiß, An eine Protokolldatei anhängen

ContextGetPointCount

ContextGetPointCount() → Integer

Gibt zurück, wie viele Mauszeigerpositionen entlang der gezeichneten Geste aufgezeichnet wurden. Lesen Sie jede mit ContextGetPointX und ContextGetPointY.

Parameter

Keine Parameter.

Rückgabe

Die Anzahl der Punkte oder 0 außerhalb einer Geste.

3 Beispiele: Länge eines Gestenstrichs, Alles, was der Auslöserkontext weiß, In welche Richtung ging der Strich?

ContextGetPointX

ContextGetPointX(index: Integer) → Integer

Gibt die horizontale Bildschirmposition eines aufgezeichneten Punkts der gezeichneten Geste in Pixeln des virtuellen Bildschirms zurück.

Parameter

• index: Integer — Nullbasierte Punktnummer, von 0 bis ContextGetPointCount() minus 1. Punkt 0 ist der Startpunkt der Geste.

Rückgabe

Die x-Koordinate oder 0, wenn index außerhalb des Bereichs liegt oder die Aktion nicht durch eine Geste ausgelöst wurde.

2 Beispiele: Länge eines Gestenstrichs, In welche Richtung ging der Strich?

ContextGetPointY

ContextGetPointY(index: Integer) → Integer

Gibt die vertikale Bildschirmposition eines aufgezeichneten Punkts der gezeichneten Geste in Pixeln des virtuellen Bildschirms zurück.

Parameter

• index: Integer — Nullbasierte Punktnummer, von 0 bis ContextGetPointCount() minus 1. Punkt 0 ist der Startpunkt der Geste.

Rückgabe

Die y-Koordinate oder 0, wenn index außerhalb des Bereichs liegt oder die Aktion nicht durch eine Geste ausgelöst wurde.

2 Beispiele: Länge eines Gestenstrichs, In welche Richtung ging der Strich?

ContextGetSerialMonitorName

ContextGetSerialMonitorName() → Text

Gibt den Namen des seriellen Monitors zurück, dessen empfangene Zeile dieses Skript gestartet hat, wie er an SerialMonitorCreate übergeben wurde. Nur das Skript eines seriellen Monitors erhält einen Wert.

Parameter

Keine Parameter.

Rückgabe

Der Name des Monitors oder leerer Text für jeden anderen Auslöser.

ContextGetSerialPortName

ContextGetSerialPortName() → Text

Gibt den COM-Anschluss zurück, etwa COM3, an dem die empfangene Zeile eingetroffen ist. Nur das Skript eines seriellen Monitors erhält einen Wert.

Parameter

Keine Parameter.

Rückgabe

Der Name des Anschlusses oder leerer Text für jeden anderen Auslöser.

ContextGetSerialTextLine

ContextGetSerialTextLine() → Text

Gibt die Textzeile zurück, die am seriellen Anschluss eingetroffen ist und dieses Skript gestartet hat, etwa einen Sensorwert, den ein Arduino mit Serial.println gesendet hat. Das Zeilenende wird entfernt.

Parameter

Keine Parameter.

Rückgabe

Die empfangene Zeile ohne Zeilenabschluss oder leerer Text für jeden anderen Auslöser.

2 Beispiele: Tasten eines seriellen Geräts Medientasten zuordnen, Einen Arduino-Drehknopf zum Lautstärkeregler machen

ContextGetStrokeButton

ContextGetStrokeButton() → Integer

Gibt die Maustaste, mit der die Geste gezeichnet wurde oder die ein globales Maustastenereignis ausgelöst hat, als MouseButton-Konstante zurück: MouseButton.Primary oder MouseButton.Secondary für die Tasten, die Windows als Links- und Rechtsklick behandelt, nach einer eventuellen Vertauschung von primärer und sekundärer Taste, sonst MouseButton.Middle, MouseButton.X1 oder MouseButton.X2. Übergeben Sie den Wert an MouseClick oder MouseButtonDown, um dieselbe Taste zu drücken.

Parameter

Keine Parameter.

Rückgabe

Ein MouseButton-Wert wie MouseButton.Secondary oder -1 für jeden anderen Auslöser.

2 Beispiele: Alles, was der Auslöserkontext weiß, Nach der Maustaste des Strichs verzweigen

ContextGetWatchAction

ContextGetWatchAction() → Text

Gibt zurück, was im überwachten Ordner geschehen ist und dieses Skript gestartet hat: 'created', 'deleted', 'modified', 'renamed-old-name', 'renamed-new-name' oder 'overflow'.

Parameter

Keine Parameter.

Rückgabe

Die Art der Änderung oder leerer Text für jeden anderen Auslöser. 'overflow' bedeutet, dass zu viele Änderungen gleichzeitig eingetroffen sind und der Ordner erneut geprüft werden muss.

1 Beispiel: Einen Ordner überwachen

ContextGetWatchName

ContextGetWatchName() → Text

Gibt den Namen der Ordnerüberwachung zurück, die dieses Skript gestartet hat, wie er an FolderWatchCreate übergeben wurde. Nur das Skript einer Ordnerüberwachung erhält einen Wert.

Parameter

Keine Parameter.

Rückgabe

Der Name der Überwachung oder leerer Text für jeden anderen Auslöser.

ContextGetWatchPath

ContextGetWatchPath() → Text

Gibt den Pfad der Datei oder des Ordners zurück, die bzw. der sich geändert und dieses Ordnerüberwachungsskript gestartet hat, relativ zum überwachten Ordner.

Parameter

Keine Parameter.

Rückgabe

Der Pfad des geänderten Elements relativ zum überwachten Ordner oder leerer Text für eine 'overflow'-Änderung oder jeden anderen Auslöser.

1 Beispiel: Einen Ordner überwachen

ContextGetWindow

ContextGetWindow() → Window

Gibt das Anwendungsfenster zurück, auf das der Auslöser zielte: das Fenster der obersten Ebene um das Steuerelement unter der Geste oder der Maus bzw. um das fokussierte Steuerelement bei einem Hotkey oder einer Texterweiterung.

Parameter

Keine Parameter.

Rückgabe

Das Fenster oder ein Null-Fenster, wenn der Auslöser kein Fenster hat, wie bei einem Timer, einer Ordnerüberwachung, einem seriellen Monitor oder einem Load-Skript.

16 Beispiele: Eine Geste, mehrere Möglichkeiten, Maximieren des Fensters der Geste umschalten, Ein Fenster im Vordergrund fixieren, Fenstertransparenz durchschalten, Ein Fenster in eine Zelle eines 3×2-Rasters unter dem Mauszeiger einpassen, Ein Fenster auf den nächsten Monitor werfen, Die Position eines Fensters merken und wiederherstellen, Die untergeordneten Steuerelemente eines Fensters untersuchen, Ein Fenster im Infobereich verstecken, Alles, was der Auslöserkontext weiß, Nach der Maustaste des Strichs verzweigen, Den Mauszeiger 5 Sekunden lang auf ein Fenster beschränken, Verhalten ändern, solange Strg gedrückt ist, Eine in Storage gehaltene Liste, Ein Fenster auf einen bestimmten Monitor senden, Snippets als wiederverwendbare Funktionen

ContextRelayGesture

ContextRelayGesture() → Bool

Spielt die gezeichnete Geste als echtes Ziehen mit derselben Maustaste entlang desselben Pfads erneut ab, sodass die darunterliegende Anwendung es empfängt, etwa um Text auszuwählen. Echte Eingaben werden während des Ziehens zurückgehalten.

Parameter

Keine Parameter.

Rückgabe

true, wenn das gesamte Ziehen gesendet wurde; false außerhalb einer Geste oder wenn Windows einen Teil der Eingabe abgelehnt hat.

1 Beispiel: Eine nicht erkannte Zeichnung durchlassen

DateTime

DateTimeFormat

DateTimeFormat(iso: Text, style: Integer) → Text · Einfach

Formatiert Datum und Uhrzeit als lesbaren Text im regionalen Format des Benutzers oder als sortierbaren FileStamp. Eine Uhrzeit mit Z oder einem UTC-Offset wird zuerst in Ortszeit umgerechnet.

Parameter

• iso: Text — Datum und Uhrzeit im ISO 8601-Format, wie DateTimeGetNow sie zurückgibt (2026-10-05T14:05:09-04:00). Ein Datum allein bedeutet Mitternacht; ohne Z oder Offset wird es als Ortszeit behandelt. Jahre 1601 bis 9999.
• style: Integer — Eine DateTimeStyle-Konstante wie DateTimeStyle.ShortDate, DateTimeStyle.LongDateTime oder DateTimeStyle.FileStamp. Jeder andere Wert beendet die Aktion mit einem Fehler.

Rückgabe

Der formatierte Text, etwa 20261005-140509 für DateTimeStyle.FileStamp, oder leerer Text, wenn iso leer ist. Text, der nicht ISO 8601 entspricht, beendet die Aktion mit einem Fehler.

1 Beispiel: Das heutige Datum und ein Dateiname mit Zeitstempel

DateTimeGetNow

DateTimeGetNow() → Text · Einfach

Gibt das aktuelle lokale Datum und die Uhrzeit als ISO 8601-Text sekundengenau mit UTC-Offset zurück. Übergeben Sie das Ergebnis an DateTimeFormat oder DateTimeGetPart.

Parameter

Keine Parameter.

Rückgabe

Text wie 2026-10-05T14:05:09-04:00 oder leerer Text, wenn Windows die Zeitzone nicht melden kann.

1 Beispiel: Das heutige Datum und ein Dateiname mit Zeitstempel

DateTimeGetPart

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

Gibt einen Teil von Datum und Uhrzeit als Zahl zurück: Jahr, Monat, Tag, Stunde, Minute, Sekunde oder Wochentag, in Ortszeit.

Parameter

• iso: Text — Datum und Uhrzeit im ISO 8601-Format, wie DateTimeGetNow sie zurückgibt. Eine Uhrzeit mit Z oder einem UTC-Offset wird in Ortszeit umgerechnet; ohne beides wird sie als Ortszeit behandelt.
• part: Integer — Eine DateTimePart-Konstante wie DateTimePart.Hour oder DateTimePart.Weekday. Jeder andere Wert beendet die Aktion mit einem Fehler.

Rückgabe

Der Wert des Teils: Monat 1 bis 12, Stunde 0 bis 23, Wochentag 1 (Montag) bis 7 (Sonntag). -1, wenn iso leer ist. Text, der nicht ISO 8601 entspricht, beendet die Aktion mit einem Fehler.

1 Beispiel: Das heutige Datum und ein Dateiname mit Zeitstempel

Display

DisplayGetMonitorDpiFromPoint

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

Gibt den DPI-Wert zurück, den Windows aktuell für den Monitor verwendet, der einen Bildschirmpunkt enthält. Für einen Punkt außerhalb aller Monitore wird der nächstgelegene Monitor verwendet.

Parameter

• x: Integer — Horizontale Bildschirmposition, in Pixeln.
• y: Integer — Vertikale Bildschirmposition, in Pixeln.

Rückgabe

Der DPI-Wert, etwa 96 bei 100 Prozent Skalierung oder 144 bei 150 Prozent. Kann Windows ihn nicht melden, der System-DPI-Wert.

DisplayGetPixelColorFromPoint

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

Gibt die Farbe des Bildschirmpixels an einem Punkt zurück, wie sie gerade auf dem Monitor angezeigt wird.

Parameter

• x: Integer — Horizontale Bildschirmposition des Pixels, in Pixeln.
• y: Integer — Vertikale Bildschirmposition des Pixels, in Pixeln.

Rückgabe

Die Farbe als Integer im Format 0xRRGGBB (Rot im höchsten Byte, Blau im niedrigsten) oder -1, wenn der Punkt außerhalb aller Monitore liegt oder der Bildschirm nicht gelesen werden kann.

1 Beispiel: Die Pixelfarbe unter dem Mauszeiger lesen

DisplayMonitorEnumeratedAll

DisplayMonitorEnumeratedAll() → Integer

Erstellt eine Momentaufnahme aller angeschlossenen Monitore, sortiert von links nach rechts und dann von oben nach unten, die die DisplayMonitorGetEnumerated-Funktionen über den Index lesen. Rufen Sie sie nach einer Änderung der Monitore erneut auf.

Parameter

Keine Parameter.

Rückgabe

Die Anzahl der Monitore in der Momentaufnahme. Gültige Indizes reichen von 0 bis zu dieser Zahl minus 1.

2 Beispiele: Monitore auflisten, Ein Fenster auf einen bestimmten Monitor senden

DisplayMonitorExistsByName

DisplayMonitorExistsByName(name: Text) → Bool

Prüft, ob ein nach Namen gespeicherter Monitor gerade angeschlossen ist. Verwenden Sie dies vor den FromName-Rechteckfunktionen, die sowohl für einen fehlenden Monitor als auch für eine echte Koordinate 0 den Wert 0 zurückgeben.

Parameter

• name: Text — Ein Monitor-Gerätepfad (die zuverlässige Wahl, von DisplayMonitorGetDevicePathFromPoint) oder ein Modellname wie DELL U2720Q. Groß-/Kleinschreibung wird nicht beachtet; eine exakte Übereinstimmung mit dem Gerätepfad hat Vorrang vor einem Modellnamen.

Rückgabe

true, wenn ein angeschlossener Monitor dem Namen entspricht; false, wenn keiner entspricht oder name leer ist.

DisplayMonitorGetDevicePathFromPoint

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

Gibt den Gerätepfad des Monitors zurück, der einen Bildschirmpunkt enthält: einen eindeutigen Namen, den Sie speichern und später an die FromName-Funktionen übergeben können. Er ändert sich, wenn der Monitor an einen anderen Videoanschluss umgesteckt wird.

Parameter

• x: Integer — Horizontale Bildschirmposition, in Pixeln.
• y: Integer — Vertikale Bildschirmposition, in Pixeln.

Rückgabe

Der Gerätepfad oder leerer Text, wenn Windows den Monitor nicht identifizieren kann. Für einen Punkt außerhalb aller Monitore wird der nächstgelegene Monitor verwendet.

DisplayMonitorGetEnumeratedDevicePathAt

DisplayMonitorGetEnumeratedDevicePathAt(index: Integer) → Text

Gibt den Gerätepfad, einen eindeutigen Namen zum Speichern, eines Monitors aus der letzten Momentaufnahme von DisplayMonitorEnumeratedAll zurück.

Parameter

• index: Integer — Nullbasierte Position des Monitors in der letzten Momentaufnahme von DisplayMonitorEnumeratedAll (von links nach rechts, dann von oben nach unten).

Rückgabe

Der Gerätepfad oder leerer Text, wenn index außerhalb des Bereichs liegt oder sich die Monitore seit der Momentaufnahme geändert haben.

DisplayMonitorGetEnumeratedDpiAt

DisplayMonitorGetEnumeratedDpiAt(index: Integer) → Integer

Gibt den DPI-Wert eines Monitors aus der letzten Momentaufnahme von DisplayMonitorEnumeratedAll zurück, wie er zum Zeitpunkt der Momentaufnahme war.

Parameter

• index: Integer — Nullbasierte Position des Monitors in der letzten Momentaufnahme von DisplayMonitorEnumeratedAll (von links nach rechts, dann von oben nach unten).

Rückgabe

Der DPI-Wert, etwa 96 bei 100 Prozent Skalierung oder 144 bei 150 Prozent, oder 0, wenn index außerhalb des Bereichs liegt.

1 Beispiel: Monitore auflisten

DisplayMonitorGetEnumeratedFriendlyNameAt

DisplayMonitorGetEnumeratedFriendlyNameAt(index: Integer) → Text

Gibt den Modellnamen, den ein Monitor meldet, etwa DELL U2720Q, für einen Monitor aus der letzten Momentaufnahme von DisplayMonitorEnumeratedAll zurück. Zwei identische Monitore melden denselben Namen.

Parameter

• index: Integer — Nullbasierte Position des Monitors in der letzten Momentaufnahme von DisplayMonitorEnumeratedAll (von links nach rechts, dann von oben nach unten).

Rückgabe

Der Modellname oder leerer Text, wenn index außerhalb des Bereichs liegt, der Monitor keinen Namen meldet (häufig bei integrierten Laptopbildschirmen) oder sich die Monitore seit der Momentaufnahme geändert haben.

1 Beispiel: Monitore auflisten

DisplayMonitorGetEnumeratedHeightAt

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

Gibt die Höhe eines Monitors aus der letzten Momentaufnahme von DisplayMonitorEnumeratedAll zurück, entweder seines gesamten Bereichs oder seines Arbeitsbereichs, wie sie zum Zeitpunkt der Momentaufnahme war.

Parameter

• index: Integer — Nullbasierte Position des Monitors in der letzten Momentaufnahme von DisplayMonitorEnumeratedAll (von links nach rechts, dann von oben nach unten).
• workArea: Bool — true für den Arbeitsbereich, der die Taskleiste und angedockte Symbolleisten ausschließt; false für den gesamten Monitor.

Rückgabe

Die Höhe in Pixeln oder 0, wenn index außerhalb des Bereichs liegt.

1 Beispiel: Monitore auflisten

DisplayMonitorGetEnumeratedWidthAt

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

Gibt die Breite eines Monitors aus der letzten Momentaufnahme von DisplayMonitorEnumeratedAll zurück, entweder seines gesamten Bereichs oder seines Arbeitsbereichs, wie sie zum Zeitpunkt der Momentaufnahme war.

Parameter

• index: Integer — Nullbasierte Position des Monitors in der letzten Momentaufnahme von DisplayMonitorEnumeratedAll (von links nach rechts, dann von oben nach unten).
• workArea: Bool — true für den Arbeitsbereich, der die Taskleiste und angedockte Symbolleisten ausschließt; false für den gesamten Monitor.

Rückgabe

Die Breite in Pixeln oder 0, wenn index außerhalb des Bereichs liegt.

1 Beispiel: Monitore auflisten

DisplayMonitorGetEnumeratedXAt

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

Gibt den linken Rand eines Monitors aus der letzten Momentaufnahme von DisplayMonitorEnumeratedAll zurück, entweder seines gesamten Bereichs oder seines Arbeitsbereichs, wie er zum Zeitpunkt der Momentaufnahme war.

Parameter

• index: Integer — Nullbasierte Position des Monitors in der letzten Momentaufnahme von DisplayMonitorEnumeratedAll (von links nach rechts, dann von oben nach unten).
• workArea: Bool — true für den Arbeitsbereich, der die Taskleiste und angedockte Symbolleisten ausschließt; false für den gesamten Monitor.

Rückgabe

Der linke Rand in Bildschirmpixeln (negativ für einen Monitor links vom primären Monitor) oder 0, wenn index außerhalb des Bereichs liegt. 0 ist auch ein echter Randwert; prüfen Sie index daher anhand der Monitoranzahl.

DisplayMonitorGetEnumeratedYAt

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

Gibt den oberen Rand eines Monitors aus der letzten Momentaufnahme von DisplayMonitorEnumeratedAll zurück, entweder seines gesamten Bereichs oder seines Arbeitsbereichs, wie er zum Zeitpunkt der Momentaufnahme war.

Parameter

• index: Integer — Nullbasierte Position des Monitors in der letzten Momentaufnahme von DisplayMonitorEnumeratedAll (von links nach rechts, dann von oben nach unten).
• workArea: Bool — true für den Arbeitsbereich, der die Taskleiste und angedockte Symbolleisten ausschließt; false für den gesamten Monitor.

Rückgabe

Der obere Rand in Bildschirmpixeln (negativ für einen Monitor oberhalb des primären Monitors) oder 0, wenn index außerhalb des Bereichs liegt. 0 ist auch ein echter Randwert; prüfen Sie index daher anhand der Monitoranzahl.

DisplayMonitorGetFriendlyNameFromPoint

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

Gibt den Modellnamen, etwa DELL U2720Q, des Monitors zurück, der einen Bildschirmpunkt enthält. Lesbar, aber nicht eindeutig: Zwei identische Monitore melden denselben Namen.

Parameter

• x: Integer — Horizontale Bildschirmposition, in Pixeln.
• y: Integer — Vertikale Bildschirmposition, in Pixeln.

Rückgabe

Der Modellname oder leerer Text, wenn der Monitor keinen meldet (häufig bei integrierten Laptopbildschirmen). Für einen Punkt außerhalb aller Monitore wird der nächstgelegene Monitor verwendet.

DisplayMonitorGetRectHeightFromName

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

Gibt die Höhe eines angeschlossenen Monitors zurück, der über seinen gespeicherten Gerätepfad oder Modellnamen gefunden wird, entweder seines gesamten Bereichs oder seines Arbeitsbereichs.

Parameter

• name: Text — Ein Monitor-Gerätepfad (die zuverlässige Wahl) oder ein Modellname wie DELL U2720Q. Groß-/Kleinschreibung wird nicht beachtet; eine exakte Übereinstimmung mit dem Gerätepfad hat Vorrang vor einem Modellnamen.
• workArea: Bool — true für den Arbeitsbereich, der die Taskleiste und angedockte Symbolleisten ausschließt; false für den gesamten Monitor.

Rückgabe

Die Höhe in Pixeln oder 0, wenn kein angeschlossener Monitor dem Namen entspricht.

DisplayMonitorGetRectHeightFromPoint

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

Gibt die Höhe des Monitors zurück, der einen Bildschirmpunkt enthält, entweder seines gesamten Bereichs oder seines Arbeitsbereichs. Für einen Punkt außerhalb aller Monitore wird der nächstgelegene Monitor verwendet.

Parameter

• x: Integer — Horizontale Bildschirmposition, in Pixeln.
• y: Integer — Vertikale Bildschirmposition, in Pixeln.
• workArea: Bool — true für den Arbeitsbereich, der die Taskleiste und angedockte Symbolleisten ausschließt; false für den gesamten Monitor.

Rückgabe

Die Höhe in Pixeln.

2 Beispiele: Das aktive Fenster an der linken Hälfte seines Monitors ausrichten, Ein Fenster in eine Zelle eines 3×2-Rasters unter dem Mauszeiger einpassen

DisplayMonitorGetRectWidthFromName

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

Gibt die Breite eines angeschlossenen Monitors zurück, der über seinen gespeicherten Gerätepfad oder Modellnamen gefunden wird, entweder seines gesamten Bereichs oder seines Arbeitsbereichs.

Parameter

• name: Text — Ein Monitor-Gerätepfad (die zuverlässige Wahl) oder ein Modellname wie DELL U2720Q. Groß-/Kleinschreibung wird nicht beachtet; eine exakte Übereinstimmung mit dem Gerätepfad hat Vorrang vor einem Modellnamen.
• workArea: Bool — true für den Arbeitsbereich, der die Taskleiste und angedockte Symbolleisten ausschließt; false für den gesamten Monitor.

Rückgabe

Die Breite in Pixeln oder 0, wenn kein angeschlossener Monitor dem Namen entspricht.

DisplayMonitorGetRectWidthFromPoint

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

Gibt die Breite des Monitors zurück, der einen Bildschirmpunkt enthält, entweder seines gesamten Bereichs oder seines Arbeitsbereichs. Für einen Punkt außerhalb aller Monitore wird der nächstgelegene Monitor verwendet.

Parameter

• x: Integer — Horizontale Bildschirmposition, in Pixeln.
• y: Integer — Vertikale Bildschirmposition, in Pixeln.
• workArea: Bool — true für den Arbeitsbereich, der die Taskleiste und angedockte Symbolleisten ausschließt; false für den gesamten Monitor.

Rückgabe

Die Breite in Pixeln.

3 Beispiele: else-if-Kette, Das aktive Fenster an der linken Hälfte seines Monitors ausrichten, Ein Fenster in eine Zelle eines 3×2-Rasters unter dem Mauszeiger einpassen

DisplayMonitorGetRectXFromName

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

Gibt den linken Rand eines angeschlossenen Monitors zurück, der über seinen gespeicherten Gerätepfad oder Modellnamen gefunden wird, entweder seines gesamten Bereichs oder seines Arbeitsbereichs.

Parameter

• name: Text — Ein Monitor-Gerätepfad (die zuverlässige Wahl) oder ein Modellname wie DELL U2720Q. Groß-/Kleinschreibung wird nicht beachtet; eine exakte Übereinstimmung mit dem Gerätepfad hat Vorrang vor einem Modellnamen.
• workArea: Bool — true für den Arbeitsbereich, der die Taskleiste und angedockte Symbolleisten ausschließt; false für den gesamten Monitor.

Rückgabe

Der linke Rand in Bildschirmpixeln oder 0, wenn kein angeschlossener Monitor dem Namen entspricht. 0 ist auch ein echter Randwert; prüfen Sie daher zuerst mit DisplayMonitorExistsByName.

DisplayMonitorGetRectXFromPoint

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

Gibt den linken Rand des Monitors zurück, der einen Bildschirmpunkt enthält, entweder seines gesamten Bereichs oder seines Arbeitsbereichs. Für einen Punkt außerhalb aller Monitore wird der nächstgelegene Monitor verwendet.

Parameter

• x: Integer — Horizontale Bildschirmposition, in Pixeln.
• y: Integer — Vertikale Bildschirmposition, in Pixeln.
• workArea: Bool — true für den Arbeitsbereich, der die Taskleiste und angedockte Symbolleisten ausschließt; false für den gesamten Monitor.

Rückgabe

Der linke Rand in Bildschirmpixeln; negativ für einen Monitor links vom primären Monitor.

3 Beispiele: else-if-Kette, Das aktive Fenster an der linken Hälfte seines Monitors ausrichten, Ein Fenster in eine Zelle eines 3×2-Rasters unter dem Mauszeiger einpassen

DisplayMonitorGetRectYFromName

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

Gibt den oberen Rand eines angeschlossenen Monitors zurück, der über seinen gespeicherten Gerätepfad oder Modellnamen gefunden wird, entweder seines gesamten Bereichs oder seines Arbeitsbereichs.

Parameter

• name: Text — Ein Monitor-Gerätepfad (die zuverlässige Wahl) oder ein Modellname wie DELL U2720Q. Groß-/Kleinschreibung wird nicht beachtet; eine exakte Übereinstimmung mit dem Gerätepfad hat Vorrang vor einem Modellnamen.
• workArea: Bool — true für den Arbeitsbereich, der die Taskleiste und angedockte Symbolleisten ausschließt; false für den gesamten Monitor.

Rückgabe

Der obere Rand in Bildschirmpixeln oder 0, wenn kein angeschlossener Monitor dem Namen entspricht. 0 ist auch ein echter Randwert; prüfen Sie daher zuerst mit DisplayMonitorExistsByName.

DisplayMonitorGetRectYFromPoint

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

Gibt den oberen Rand des Monitors zurück, der einen Bildschirmpunkt enthält, entweder seines gesamten Bereichs oder seines Arbeitsbereichs. Für einen Punkt außerhalb aller Monitore wird der nächstgelegene Monitor verwendet.

Parameter

• x: Integer — Horizontale Bildschirmposition, in Pixeln.
• y: Integer — Vertikale Bildschirmposition, in Pixeln.
• workArea: Bool — true für den Arbeitsbereich, der die Taskleiste und angedockte Symbolleisten ausschließt; false für den gesamten Monitor.

Rückgabe

Der obere Rand in Bildschirmpixeln; negativ für einen Monitor oberhalb des primären Monitors.

2 Beispiele: Das aktive Fenster an der linken Hälfte seines Monitors ausrichten, Ein Fenster in eine Zelle eines 3×2-Rasters unter dem Mauszeiger einpassen

Engine

EngineConsumePhysicalInput

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

Verhindert, dass die echten Maus- und Tastatureingaben des Benutzers ein Fenster erreichen, oder hebt diese Sperre auf. Von Skripten gesendete Eingaben funktionieren weiterhin, und die Sperre endet nach Ablauf des Zeitlimits von selbst.

Parameter

• enable: Bool — true, um das Sperren echter Eingaben zu starten oder neu zu starten; false, um die Sperre aufzuheben, gleich welches Skript sie gestartet hat.
• timeoutSeconds: Integer — Die maximale Dauer der Sperre in Sekunden; 1 oder mehr, wenn enable true ist. Längere Werte werden auf das Maximum auf der Einstellungsseite Skripte gekürzt (standardmäßig 120 Sekunden). Wird ignoriert, wenn enable false ist.

Rückgabe

Immer true. Ist enable auf true gesetzt, beendet ein timeoutSeconds von 0 oder weniger das Skript mit einem Fehler.

EngineDisable

EngineDisable() → Bool · Einfach

Deaktiviert die Engine, genau wie das Deaktivieren über das Infobereichssymbol, bis EngineEnable oder das Infobereichssymbol sie wieder einschaltet. Die Änderung erfolgt direkt nach der Rückkehr des Aufrufs. Bewirkt im abgesicherten Modus nichts.

Parameter

Keine Parameter.

Rückgabe

true, wenn die Anforderung gesendet wurde; false, wenn die Engine noch nicht vollständig gestartet ist.

1 Beispiel: Zustand der Engine

EngineDisableNextGesture

EngineDisableNextGesture() → Bool · Einfach

Lässt den nächsten Druck einer Zeichentaste einmalig direkt an die Anwendung durch, statt eine Geste zu beginnen. Hat keine Wirkung, solange die Engine deaktiviert ist.

Parameter

Keine Parameter.

Rückgabe

Immer true.

1 Beispiel: Das nächste Ziehen mit der rechten Maustaste durchlassen

EngineEnable

EngineEnable() → Bool · Einfach

Aktiviert die Engine wieder nach EngineDisable oder einer Deaktivierung über das Infobereichssymbol. Die Änderung erfolgt direkt nach der Rückkehr des Aufrufs. Bewirkt im abgesicherten Modus nichts.

Parameter

Keine Parameter.

Rückgabe

true, wenn die Anforderung gesendet wurde; false, wenn die Engine noch nicht vollständig gestartet ist.

EngineExit

EngineExit() → Bool · Einfach

Schließt die Engine mit einem normalen Herunterfahren, genau wie Beenden im Infobereichsmenü: In den Infobereich minimierte Fenster werden wiederhergestellt, und die Konfigurationsoberfläche wird geschlossen. Das Herunterfahren beginnt direkt nach der Rückkehr des Aufrufs.

Parameter

Keine Parameter.

Rückgabe

true, wenn die Anforderung zum Herunterfahren gesendet wurde; false, wenn die Engine noch nicht vollständig gestartet ist.

EngineIsDisabled

EngineIsDisabled() → Bool

Gibt an, ob die Engine gerade deaktiviert ist, entweder durch EngineDisable oder das Infobereichssymbol oder automatisch für die fokussierte Anwendung.

Parameter

Keine Parameter.

Rückgabe

true, wenn die Engine deaktiviert ist; false, wenn sie aktiv ist.

1 Beispiel: Zustand der Engine

EngineIsSafeMode

EngineIsSafeMode() → Bool

Gibt an, ob die Engine im abgesicherten Modus gestartet wurde. Im abgesicherten Modus können nur Skripte ausgeführt werden, die über die Diagnosekonsole gestartet werden.

Parameter

Keine Parameter.

Rückgabe

true im abgesicherten Modus; andernfalls false.

1 Beispiel: Zustand der Engine

EngineReload

EngineReload() → Bool · Einfach

Lädt die Konfiguration ohne Neustart erneut vom Datenträger, wie Konfiguration neu laden im Infobereichsmenü. Wartet bis zu 3 Sekunden. Alle anderen laufenden Skripte werden beendet; dieses läuft weiter.

Parameter

Keine Parameter.

Rückgabe

true, sobald die neue Konfiguration verwendet wird; false, wenn sie nicht geladen werden konnte oder das Neuladen länger als 3 Sekunden gedauert hat.

EngineStopAllActions

EngineStopAllActions() → Bool · Einfach

Fordert alle laufenden Aktionen und Skripte zum Beenden auf, auch das aufrufende. Nichts wird zwangsweise beendet: Jedes Skript stoppt bei seinem nächsten Schritt, sodass der Aufrufer zunächst noch etwas weiterlaufen kann.

Parameter

Keine Parameter.

Rückgabe

Immer true.

File

FileAppendText

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

Hängt Text an das Ende einer Textdatei an und erstellt die Datei, falls sie nicht existiert. Praktisch für Protokolle. Der Text wird als UTF-8 geschrieben, und es wird kein Zeilenumbruch automatisch hinzugefügt.

Parameter

• path: Text — Vollständiger Pfad der Datei. Ihr Ordner muss bereits existieren.
• text: Text — Der anzuhängende Text. Beenden Sie ihn mit '\n', um einen Eintrag pro Zeile zu erhalten.

Rückgabe

true, wenn der Text geschrieben wurde; false, wenn der Ordner nicht existiert, die Datei gesperrt ist oder der Anfang der vorhandenen Datei wie Binärdaten aussieht.

1 Beispiel: An eine Protokolldatei anhängen

FileCopy

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

Kopiert eine Datei beliebigen Typs an einen neuen Pfad. Der Zielordner muss bereits existieren.

Parameter

• source: Text — Vollständiger Pfad der zu kopierenden Datei.
• destination: Text — Vollständiger Pfad der neuen Kopie, einschließlich Dateiname.
• overwrite: Bool — true, um eine vorhandene Datei unter destination zu ersetzen; false, um sie unverändert zu lassen und false zurückzugeben.

Rückgabe

true, wenn die Datei kopiert wurde; false, wenn die Quelle fehlt, das Ziel existiert und overwrite false ist oder das Kopieren fehlgeschlagen ist.

1 Beispiel: Eine Datei vor dem Bearbeiten sichern

FileCreate

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

Erstellt eine neue Textdatei mit dem angegebenen Inhalt, geschrieben als UTF-8. Lehnt ab, wenn unter diesem Pfad bereits etwas existiert; verwenden Sie FileEditText, um den Inhalt einer vorhandenen Datei zu ersetzen.

Parameter

• path: Text — Vollständiger Pfad der neuen Datei. Ihr Ordner muss bereits existieren.
• text: Text — Der Inhalt der Datei. Leerer Text erstellt eine leere Datei.

Rückgabe

true, wenn die Datei erstellt wurde; false, wenn dort bereits eine Datei oder ein Ordner existiert oder die Datei nicht geschrieben werden konnte.

2 Beispiele: Das heutige Datum und ein Dateiname mit Zeitstempel, An eine Protokolldatei anhängen

FileDelete

FileDelete(path: Text) → Bool

Löscht eine Datei endgültig; sie wird nicht in den Papierkorb verschoben. Eine bereits nicht mehr vorhandene Datei gilt als Erfolg. Ein Ordner wird nie gelöscht; verwenden Sie dafür FolderDelete.

Parameter

• path: Text — Vollständiger Pfad der zu löschenden Datei.

Rückgabe

true, wenn die Datei nicht mehr vorhanden ist, auch wenn sie nie existiert hat; false, wenn der Pfad ein Ordner ist oder die Datei gesperrt ist oder der Zugriff verweigert wird.

FileEditText

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

Ersetzt den gesamten Inhalt einer vorhandenen Textdatei, geschrieben als UTF-8. Lehnt eine Datei ab, die wie Binärdaten aussieht. Verwenden Sie FileCreate für eine neue Datei.

Parameter

• path: Text — Vollständiger Pfad einer vorhandenen Textdatei.
• text: Text — Der neue Inhalt, der alles in der Datei ersetzt.

Rückgabe

true, wenn die Datei neu geschrieben wurde; false, wenn sie nicht existiert, ihr Anfang wie Binärdaten aussieht oder sie nicht geschrieben werden konnte.

1 Beispiel: Eine Datei vor dem Bearbeiten sichern

FileExists

FileExists(path: Text) → Bool

Prüft, ob unter einem Pfad eine Datei existiert. Ein Ordner unter diesem Pfad zählt nicht; verwenden Sie FolderExists für Ordner.

Parameter

• path: Text — Vollständiger Pfad der zu prüfenden Datei.

Rückgabe

true, wenn dort eine Datei existiert; false, wenn dort nichts existiert oder es ein Ordner ist.

2 Beispiele: An eine Protokolldatei anhängen, Eine Datei vor dem Bearbeiten sichern

FileGetCreationDate

FileGetCreationDate(path: Text) → Text

Gibt zurück, wann eine Datei erstellt wurde, als ISO 8601-Datum und -Uhrzeit in UTC, die DateTimeFormat und die anderen DateTime-Funktionen lesen können.

Parameter

• path: Text — Vollständiger Pfad der Datei.

Rückgabe

Der Erstellungszeitpunkt, etwa 2026-10-01T18:05:09Z, oder leerer Text, wenn die Datei nicht existiert oder der Pfad ein Ordner ist.

FileGetModifiedDate

FileGetModifiedDate(path: Text) → Text

Gibt zurück, wann der Inhalt einer Datei zuletzt geändert wurde, als ISO 8601-Datum und -Uhrzeit in UTC, die DateTimeFormat und die anderen DateTime-Funktionen lesen können.

Parameter

• path: Text — Vollständiger Pfad der Datei.

Rückgabe

Der Zeitpunkt der letzten Änderung, etwa 2026-10-01T18:05:09Z, oder leerer Text, wenn die Datei nicht existiert oder der Pfad ein Ordner ist.

1 Beispiel: Eine Datei lesen und ihre Zeilen zählen

FileGetProductVersion

FileGetProductVersion(path: Text) → Text

Gibt die in einer Programm- oder Bibliotheksdatei, etwa einer .exe oder .dll, gespeicherte Produktversion zurück. Das ist die Version des Produkts, mit dem die Datei ausgeliefert wird, und kann von FileGetVersion abweichen.

Parameter

• path: Text — Vollständiger Pfad der .exe-, .dll- oder anderen Datei mit Versionsinformationen.

Rückgabe

Die Version als vier Zahlen, etwa 10.0.22621.1, oder leerer Text, wenn die Datei keine Versionsinformationen hat oder nicht existiert.

FileGetSize

FileGetSize(path: Text) → Integer

Gibt die Größe einer Datei in Bytes zurück, ohne die Datei zu öffnen oder zu lesen.

Parameter

• path: Text — Vollständiger Pfad der Datei.

Rückgabe

Die Größe in Bytes oder -1, wenn die Datei nicht existiert oder der Pfad ein Ordner ist.

1 Beispiel: Eine Datei lesen und ihre Zeilen zählen

FileGetVersion

FileGetVersion(path: Text) → Text

Gibt die in einer Programm- oder Bibliotheksdatei, etwa einer .exe oder .dll, gespeicherte Dateiversion zurück, wie sie auf der Registerkarte Details ihrer Eigenschaften angezeigt wird.

Parameter

• path: Text — Vollständiger Pfad der .exe-, .dll- oder anderen Datei mit Versionsinformationen.

Rückgabe

Die Version als vier Zahlen, etwa 10.0.22621.1, oder leerer Text, wenn die Datei keine Versionsinformationen hat oder nicht existiert.

FileMove

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

Verschiebt eine Datei beliebigen Typs an einen neuen Pfad, wodurch sie auch einen neuen Namen erhalten kann, auch eine reine Änderung der Groß-/Kleinschreibung. Der Zielordner muss bereits existieren.

Parameter

• source: Text — Vollständiger Pfad der zu verschiebenden Datei.
• destination: Text — Vollständiger Pfad des neuen Speicherorts der Datei, einschließlich Dateiname.
• overwrite: Bool — true, um eine vorhandene Datei unter destination in einem Schritt zu ersetzen; false, um sie unverändert zu lassen und false zurückzugeben. Ein Ziel, das sich von der Quelle nur in der Groß-/Kleinschreibung unterscheidet, gilt nicht als vorhandene Datei.

Rückgabe

true, wenn die Datei verschoben wurde; false, wenn die Quelle fehlt, das Ziel existiert und overwrite false ist oder das Verschieben fehlgeschlagen ist.

FileReadText

FileReadText(path: Text) → Text

Liest eine ganze Textdatei und gibt ihren Inhalt zurück. Versteht UTF-8, UTF-16 mit Byte Order Mark und Dateien in der älteren Codepage des Systems. Lehnt Binärdateien ab.

Parameter

• path: Text — Vollständiger Pfad der Textdatei.

Rückgabe

Der Inhalt der Datei oder leerer Text, wenn die Datei nicht existiert, nicht gelesen werden kann oder wie Binärdaten aussieht.

2 Beispiele: Eine Datei lesen und ihre Zeilen zählen, Eine Datei vor dem Bearbeiten sichern

FileRename

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

Benennt eine Datei um und belässt sie in ihrem aktuellen Ordner. Auch eine reine Änderung der Groß-/Kleinschreibung, etwa von report.txt zu Report.txt, funktioniert. Um eine Datei in einen anderen Ordner zu verschieben, verwenden Sie FileMove.

Parameter

• path: Text — Vollständiger Pfad der umzubenennenden Datei.
• newName: Text — Nur der neue Dateiname, etwa report-old.txt. Ein Name mit einem Schrägstrich oder umgekehrten Schrägstrich beendet das Skript mit einem Fehler.

Rückgabe

true, wenn die Datei umbenannt wurde; false, wenn sie nicht existiert, bereits eine andere Datei oder ein Ordner mit dem neuen Namen existiert oder das Umbenennen fehlgeschlagen ist.

Folder

FolderCreate

FolderCreate(path: Text) → Bool

Erstellt einen Ordner einschließlich aller fehlenden übergeordneten Ordner. Ein bereits vorhandener Ordner gilt als Erfolg.

Parameter

• path: Text — Vollständiger Pfad des zu erstellenden Ordners.

Rückgabe

true, wenn der Ordner danach existiert; false, wenn eine Datei im Weg ist oder der Ordner nicht erstellt werden konnte.

FolderDelete

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

Löscht einen Ordner endgültig; er wird nicht in den Papierkorb verschoben. Ist recursive auf true gesetzt, wird auch sein gesamter Inhalt gelöscht. Ein bereits nicht mehr vorhandener Ordner gilt als Erfolg. Eine Datei wird nie gelöscht; verwenden Sie dafür FileDelete.

Parameter

• path: Text — Vollständiger Pfad des zu löschenden Ordners.
• recursive: Bool — true, um den Ordner samt gesamtem Inhalt zu löschen; false, um ihn nur zu löschen, wenn er leer ist.

Rückgabe

true, wenn der Ordner nicht mehr vorhanden ist; false, wenn der Pfad eine Datei ist, der Ordner nicht leer ist und recursive false ist oder etwas darin gesperrt oder geschützt ist.

FolderEnumerateAll

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

Listet die Dateien und Unterordner eines Ordners auf und gibt ihre Anzahl zurück. Lesen Sie jeden vollständigen Pfad mit FolderGetEnumeratedPathAt. Unterordner ohne Zugriff werden übersprungen.

Parameter

• path: Text — Vollständiger Pfad des aufzulistenden Ordners.
• recursive: Bool — true, um auch den gesamten Inhalt aller Unterordner aufzulisten; false nur für den direkten Inhalt des Ordners.

Rückgabe

Die Anzahl der gefundenen Einträge oder -1, wenn der Ordner nicht existiert oder nicht gelesen werden kann.

1 Beispiel: Dateitypen in einem Ordner zählen

FolderExists

FolderExists(path: Text) → Bool

Prüft, ob unter einem Pfad ein Ordner existiert. Eine Datei unter diesem Pfad zählt nicht; verwenden Sie FileExists für Dateien.

Parameter

• path: Text — Vollständiger Pfad des zu prüfenden Ordners.

Rückgabe

true, wenn dort ein Ordner existiert; false, wenn dort nichts existiert oder es eine Datei ist.

FolderGetEnumeratedPathAt

FolderGetEnumeratedPathAt(index: Integer) → Text

Gibt einen vollständigen Pfad aus der Liste zurück, die der letzte Aufruf von FolderEnumerateAll in diesem Skriptlauf erstellt hat.

Parameter

• index: Integer — Position in der Liste, von 0 bis zu der von FolderEnumerateAll zurückgegebenen Anzahl minus 1.

Rückgabe

Der vollständige Pfad einer Datei oder eines Ordners oder leerer Text, wenn index außerhalb des Bereichs liegt oder FolderEnumerateAll nicht aufgerufen wurde.

1 Beispiel: Dateitypen in einem Ordner zählen

FolderRename

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

Benennt einen Ordner um und belässt ihn samt Inhalt in seinem aktuellen übergeordneten Ordner. Auch eine reine Änderung der Groß-/Kleinschreibung funktioniert.

Parameter

• path: Text — Vollständiger Pfad des umzubenennenden Ordners.
• newName: Text — Nur der neue Ordnername. Ein Name mit einem Schrägstrich oder umgekehrten Schrägstrich beendet das Skript mit einem Fehler.

Rückgabe

true, wenn der Ordner umbenannt wurde; false, wenn er nicht existiert, bereits eine andere Datei oder ein Ordner mit dem neuen Namen existiert oder das Umbenennen fehlgeschlagen ist, etwa weil eine Datei darin geöffnet ist.

FolderWatchCreate

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

Beginnt mit der Überwachung eines Ordners und führt für jede von Windows gemeldete Änderung ein Skript aus, etwa wenn eine Datei erstellt, geändert, umbenannt oder gelöscht wird. Die Überwachung läuft nach dem Ende dieses Skripts weiter.

Parameter

• name: Text — Ein Name für die Überwachung. Wird eine Überwachung mit einem bereits verwendeten Namen erstellt, ersetzt sie die bisherige. Bei Namen wird die Groß-/Kleinschreibung beachtet.
• path: Text — Vollständiger Pfad des zu überwachenden Ordners.
• recursive: Bool — true, um auch alle Unterordner zu überwachen; false, um nur den Ordner selbst zu überwachen.
• filterMask: Integer — Welche Arten von Änderungen gemeldet werden: mit | kombinierte FileNotify-Konstanten, etwa FileNotify.FileName | FileNotify.LastWrite.
• script: Text — Das für jede Änderung auszuführende Skript als Text. Es liest die Änderung mit ContextGetWatchAction (created, deleted, modified, renamed-old-name, renamed-new-name oder overflow) und ContextGetWatchPath.

Rückgabe

true, wenn die Überwachung läuft; false, wenn der Ordner nicht existiert, nicht geöffnet werden kann oder filterMask 0 ist.

1 Beispiel: Einen Ordner überwachen

FolderWatchDelete

FolderWatchDelete(name: Text) → Bool

Beendet eine mit FolderWatchCreate erstellte Ordnerüberwachung, sodass ihr Skript nicht mehr ausgeführt wird.

Parameter

• name: Text — Der an FolderWatchCreate übergebene Name. Bei Namen wird die Groß-/Kleinschreibung beachtet.

Rückgabe

true, wenn eine Überwachung mit diesem Namen gefunden und beendet wurde; false, wenn es keine gab.

1 Beispiel: Einen Ordner überwachen

FolderWatchDeleteAll

FolderWatchDeleteAll() → Bool

Beendet alle mit FolderWatchCreate erstellten Ordnerüberwachungen, sodass keines ihrer Skripte mehr ausgeführt wird.

Parameter

Keine Parameter.

Rückgabe

Immer true.

FolderWatchGetCount

FolderWatchGetCount() → Integer

Gibt zurück, wie viele Ordnerüberwachungen laufen, und erstellt eine Momentaufnahme ihrer Namen für FolderWatchGetEnumeratedNameAt.

Parameter

Keine Parameter.

Rückgabe

Die Anzahl der laufenden Ordnerüberwachungen oder 0, wenn keine läuft.

FolderWatchGetEnumeratedNameAt

FolderWatchGetEnumeratedNameAt(index: Integer) → Text

Gibt einen Überwachungsnamen aus der Momentaufnahme zurück, die der letzte Aufruf von FolderWatchGetCount in diesem Skriptlauf erstellt hat.

Parameter

• index: Integer — Position in der Momentaufnahme, von 0 bis zur Anzahl minus 1. Die Reihenfolge hat keine Bedeutung.

Rückgabe

Der Überwachungsname oder leerer Text, wenn index außerhalb des Bereichs liegt oder FolderWatchGetCount nicht aufgerufen wurde.

GestureProfile

GestureProfileEnumerateAll

GestureProfileEnumerateAll() → Integer

Erstellt eine Liste aller Gestenprofile in der Konfiguration und gibt ihre Anzahl zurück. Lesen Sie jedes mit GestureProfileGetEnumeratedIdAt und GestureProfileGetEnumeratedNameAt.

Parameter

Keine Parameter.

Rückgabe

Die Anzahl der Gestenprofile oder 0, wenn es keine gibt.

1 Beispiel: Zum nächsten Gestenprofil wechseln

GestureProfileGetActiveId

GestureProfileGetActiveId() → Text

Gibt die ID des gerade aktiven Gestenprofils zurück.

Parameter

Keine Parameter.

Rückgabe

Die ID des aktiven Profils oder leerer Text, wenn kein Profil aktiv ist.

2 Beispiele: Eine Windows-Benachrichtigung, Zum nächsten Gestenprofil wechseln

GestureProfileGetEnumeratedIdAt

GestureProfileGetEnumeratedIdAt(index: Integer) → Text

Gibt die ID eines Profils aus der Liste zurück, die GestureProfileEnumerateAll zuletzt in diesem Skript erstellt hat. Übergeben Sie die ID an GestureProfileSwitch.

Parameter

• index: Integer — Nullbasierte Position in der Liste, von 0 bis zur Anzahl minus 1.

Rückgabe

Die ID des Profils oder leerer Text, wenn index außerhalb des Bereichs liegt oder GestureProfileEnumerateAll nicht aufgerufen wurde.

1 Beispiel: Zum nächsten Gestenprofil wechseln

GestureProfileGetEnumeratedNameAt

GestureProfileGetEnumeratedNameAt(index: Integer) → Text

Gibt den Anzeigenamen eines Profils aus der Liste zurück, die GestureProfileEnumerateAll zuletzt in diesem Skript erstellt hat.

Parameter

• index: Integer — Nullbasierte Position in der Liste, von 0 bis zur Anzahl minus 1.

Rückgabe

Der Name des Profils oder leerer Text, wenn index außerhalb des Bereichs liegt oder GestureProfileEnumerateAll nicht aufgerufen wurde.

1 Beispiel: Zum nächsten Gestenprofil wechseln

GestureProfileSwitch

GestureProfileSwitch(profileId: Text) → Bool · Einfach

Wechselt zu einem anderen Gestenprofil, genau wie die Auswahl im Infobereichsmenü, und merkt sich die Wahl über einen Neustart hinaus. Der Wechsel erfolgt direkt nach der Rückkehr des Aufrufs.

Parameter

• profileId: Text — Die ID des Profils, zu dem gewechselt werden soll, etwa eine von GestureProfileGetEnumeratedIdAt, oder leerer Text für kein Profil.

Rückgabe

true, wenn die Anforderung gesendet wurde; false für eine ID, die kein Profil hat, und es ändert sich nichts. Der Wechsel erfolgt kurz nach der Rückkehr des Aufrufs; bestätigen Sie ihn mit GestureProfileGetActiveId.

1 Beispiel: Zum nächsten Gestenprofil wechseln

Keyboard

KeyboardGetKeyState

KeyboardGetKeyState(key: Integer) → Integer

Gibt den rohen Windows-Zustand einer Taste zurück, wie er gerade ist. Solange ein anderer Desktop, etwa eine UAC-Abfrage oder der Sperrbildschirm, im Vordergrund ist, gilt jede Taste als nicht gedrückt. Für ein einfaches Ja oder Nein verwenden Sie KeyboardIsKeyDown oder KeyboardIsKeyToggled.

Parameter

• key: Integer — Eine VirtualKey-Konstante wie VirtualKey.CapsLock oder ein virtueller Tastencode von 0 bis 255. Jeder andere Wert beendet das Skript mit einem Fehler.

Rückgabe

Ein roher Integer: negativ (höchstes Bit gesetzt), wenn die Taste gedrückt ist, und ungerade (niedrigstes Bit gesetzt), wenn eine Sperrtaste wie die Feststelltaste eingeschaltet ist.

1 Beispiel: Bits des Tastenzustands

KeyboardGetKeyStateAsync

KeyboardGetKeyStateAsync(key: Integer) → Integer

Gibt den rohen Windows-Zustand einer Taste genau in diesem Moment zurück, unabhängig davon, welches Fenster den Fokus hat.

Parameter

• key: Integer — Eine VirtualKey-Konstante wie VirtualKey.ShiftKey oder ein virtueller Tastencode von 0 bis 255. Jeder andere Wert beendet das Skript mit einem Fehler.

Rückgabe

Ein roher Integer: negativ (höchstes Bit gesetzt), wenn die Taste gerade gedrückt ist. Das niedrigste Bit kann gesetzt sein, wenn die Taste seit einer früheren Abfrage gedrückt wurde, was Windows jedoch nicht garantiert.

KeyboardIsKeyDown

KeyboardIsKeyDown(key: Integer) → Bool

Prüft, ob eine Taste gerade gedrückt gehalten wird. Solange ein anderer Desktop, etwa eine UAC-Abfrage oder der Sperrbildschirm, im Vordergrund ist, gilt jede Taste als nicht gedrückt.

Parameter

• key: Integer — Eine VirtualKey-Konstante wie VirtualKey.ControlKey oder ein virtueller Tastencode von 0 bis 255. Jeder andere Wert beendet das Skript mit einem Fehler.

Rückgabe

true, wenn die Taste gedrückt ist; false, wenn sie losgelassen ist.

2 Beispiele: Bits des Tastenzustands, Verhalten ändern, solange Strg gedrückt ist

KeyboardIsKeyToggled

KeyboardIsKeyToggled(key: Integer) → Bool

Prüft, ob eine Sperrtaste wie die Feststelltaste eingeschaltet ist. Nur sinnvoll für VirtualKey.CapsLock, VirtualKey.NumLock und VirtualKey.Scroll.

Parameter

• key: Integer — Eine VirtualKey-Konstante wie VirtualKey.CapsLock oder ein virtueller Tastencode von 0 bis 255. Jeder andere Wert beendet das Skript mit einem Fehler.

Rückgabe

true, wenn die Taste eingeschaltet ist; false, wenn sie ausgeschaltet ist.

1 Beispiel: Bits des Tastenzustands

KeyboardKeyDown

KeyboardKeyDown(key: Integer) → Bool

Drückt eine Taste und hält sie gedrückt, bis KeyboardKeyUp sie loslässt. Ist die Einstellung Medien- und Browsertasten als Befehle senden eingeschaltet, sendet eine Medien-, Lautstärke- oder Browsertaste stattdessen ihren Befehl.

Parameter

• key: Integer — Eine VirtualKey-Konstante wie VirtualKey.ShiftKey oder ein virtueller Tastencode von 0 bis 255. Jeder andere Wert beendet das Skript mit einem Fehler.

Rückgabe

true, wenn der Tastendruck gesendet wurde; false, wenn Windows ihn blockiert hat oder, bei einer als Befehl gesendeten Taste, kein Fenster den Fokus hat.

1 Beispiel: Umschalt-Klick

KeyboardKeyUp

KeyboardKeyUp(key: Integer) → Bool

Lässt eine mit KeyboardKeyDown gedrückte Taste los. Bei einer als Befehl gesendeten Medien-, Lautstärke- oder Browsertaste bewirkt dies nichts, da der Befehl bereits beim Drücken gesendet wurde.

Parameter

• key: Integer — Eine VirtualKey-Konstante wie VirtualKey.ShiftKey oder ein virtueller Tastencode von 0 bis 255. Jeder andere Wert beendet das Skript mit einem Fehler.

Rückgabe

true, wenn das Loslassen gesendet wurde, und immer true für eine als Befehl gesendete Taste; false, wenn Windows es blockiert hat.

1 Beispiel: Umschalt-Klick

KeyboardPressKey

KeyboardPressKey(key: Integer) → Bool · Einfach

Drückt eine Taste und lässt sie wieder los; das kann jede Taste sein, für die Windows einen Code hat, einschließlich Medientasten. Ist die Einstellung Medien- und Browsertasten als Befehle senden eingeschaltet, senden diese Tasten stattdessen ihren Befehl.

Parameter

• key: Integer — Eine VirtualKey-Konstante wie VirtualKey.MediaPlayPause oder ein virtueller Tastencode von 0 bis 255. Jeder andere Wert beendet das Skript mit einem Fehler.

Rückgabe

true, wenn der Tastendruck gesendet wurde; false, wenn Windows ihn blockiert hat oder, bei einer als Befehl gesendeten Taste, kein Fenster den Fokus hat.

3 Beispiele: Benannte Konstanten statt bloßer Zahlen, Medientasten, Tasten eines seriellen Geräts Medientasten zuordnen

KeyboardPressKeyCombo

KeyboardPressKeyCombo(combo: Text) → Bool · Einfach

Drückt eine Tastenkombination wie Strg+C: hält die Zusatztasten, drückt die Taste und lässt sie los und lässt dann die Zusatztasten los. Sendet eine Kombination pro Aufruf.

Parameter

• combo: Text — Optionale Zusatztastensymbole (^ für Strg, + für Umschalt, @ für Windows, das Prozentzeichen für Alt), gefolgt von einem Buchstaben oder einer Ziffer oder von einem Tastennamen in geschweiften Klammern wie {ENTER}, {F5} oder {LEFT}, in beliebiger Groß-/Kleinschreibung. Beispiel: '^c' ist Strg+C.

Rückgabe

true, wenn die Tastenanschläge gesendet wurden; false, wenn Windows sie blockiert hat. Eine nicht verstandene Kombination beendet das Skript mit einem Fehler.

4 Beispiele: Tastenkombinationen, Eine Signatur tippen, Den markierten Text in Großbuchstaben umwandeln, Im Web nach der Markierung suchen

KeyboardTypeText

KeyboardTypeText(text: Text) → Bool · Einfach

Tippt Text Zeichen für Zeichen in das fokussierte Fenster, in jeder Sprache und einschließlich Emojis, unabhängig vom Tastaturlayout. Wartet vor jedem Zeichen die in der Einstellung Tippverzögerung festgelegte Zeit.

Parameter

• text: Text — Der zu tippende Text. Jeder Zeilenumbruch wird als ein Druck auf die Eingabetaste gesendet. Im Skript einer Texterweiterung wird die Taste, die den Auslöser abgeschlossen hat, danach getippt.

Rückgabe

true, wenn jedes Zeichen gesendet wurde oder der Text leer ist; false, wenn Windows einige davon blockiert hat.

3 Beispiele: Ein Programm starten, auf sein Fenster warten, darauf reagieren, Das heutige Datum und ein Dateiname mit Zeitstempel, Eine Signatur tippen

Macro

MacroClearTemporary

MacroClearTemporary() → Bool

Verwirft das mit MacroRecordTemporary aufgezeichnete Makro.

Parameter

Keine Parameter.

Rückgabe

true, wenn ein aufgezeichnetes Makro zum Verwerfen vorhanden war; false, wenn keines vorhanden war.

MacroExpectFocusedWindow

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

Wartet, bis das Vordergrundfenster zum angegebenen Programm und zur angegebenen Fensterklasse gehört, höchstens so lange wie die Wartezeit für die Makrowiedergabe in den Einstellungen (standardmäßig 2 Sekunden). Passt es nie, wird eine Benachrichtigung angezeigt und das Skript beendet.

Parameter

• exeName: Text — Der Dateiname des Programms, etwa notepad.exe. Groß-/Kleinschreibung wird nicht beachtet; leerer Text passt zu jedem Programm.
• windowClass: Text — Der Klassenname des Fensters der obersten Ebene, etwa Notepad. Groß-/Kleinschreibung wird nicht beachtet; leerer Text passt zu jeder Klasse.

Rückgabe

true, sobald das Fenster passt; false, wenn das Skript während des Wartens zum Beenden aufgefordert wurde.

MacroExpectWindowAt

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

Wartet, bis das Fenster der obersten Ebene an einem Bildschirmpunkt zum angegebenen Programm und zur angegebenen Fensterklasse gehört, höchstens so lange wie die Wartezeit für die Makrowiedergabe in den Einstellungen (standardmäßig 2 Sekunden). Passt es nie, wird eine Benachrichtigung angezeigt und das Skript beendet.

Parameter

• x: Integer — Zu prüfende horizontale Bildschirmposition, in Pixeln des virtuellen Bildschirms.
• y: Integer — Zu prüfende vertikale Bildschirmposition, in Pixeln des virtuellen Bildschirms.
• exeName: Text — Der Dateiname des Programms, etwa notepad.exe. Groß-/Kleinschreibung wird nicht beachtet; leerer Text passt zu jedem Programm.
• windowClass: Text — Der Klassenname des Fensters der obersten Ebene, etwa Notepad. Groß-/Kleinschreibung wird nicht beachtet; leerer Text passt zu jeder Klasse.

Rückgabe

true, sobald das Fenster passt; false, wenn das Skript während des Wartens zum Beenden aufgefordert wurde.

MacroGetTemporaryScript

MacroGetTemporaryScript() → Text

Gibt das mit MacroRecordTemporary aufgezeichnete Makro als Skripttext im Modus Schritte zurück, damit ein Skript es speichern oder untersuchen kann.

Parameter

Keine Parameter.

Rückgabe

Der Schritte-Text der letzten abgeschlossenen Aufzeichnung oder leerer Text, wenn nichts aufgezeichnet oder die Aufzeichnung verworfen wurde. Während eine neue Aufzeichnung läuft, wird weiterhin die vorherige zurückgegeben.

MacroPlayTemporary

MacroPlayTemporary(timeoutSeconds: Integer) → Bool

Spielt das mit MacroRecordTemporary aufgezeichnete Makro ab und wartet, bis es fertig ist oder das Zeitlimit abläuft. Die echten Maus- und Tastatureingaben des Benutzers werden während der Wiedergabe zurückgehalten.

Parameter

• timeoutSeconds: Integer — Die maximale Wartezeit in Sekunden; 1 oder mehr, sonst wird das Skript mit einem Fehler beendet. Ein Makro, das danach noch läuft, wird fortgesetzt, aber echte Eingaben werden nicht mehr zurückgehalten.

Rückgabe

true, wenn das Makro rechtzeitig bis zum Ende abgespielt wurde; false, wenn nichts aufgezeichnet wurde, ein Schritt oder eine Fensterprüfung fehlgeschlagen ist, die Wiedergabe beendet wurde oder sie beim Zeitlimit noch lief.

MacroRecordTemporary

MacroRecordTemporary() → Bool

Beginnt, Maus- und Tastatureingaben in ein temporäres Makro im Arbeitsspeicher aufzuzeichnen; drücken Sie Strg+Pause zum Beenden. Kehrt sofort zurück, bevor die Aufzeichnung beginnt. Zuvor kann ein Bestätigungsfenster erscheinen.

Parameter

Keine Parameter.

Rückgabe

true, wenn die Aufzeichnungsanforderung gesendet wurde; false, wenn bereits eine Aufzeichnung läuft, startet oder angefordert ist oder die Engine noch nicht vollständig gestartet ist.

Math

MathAbs

MathAbs(value: Any) → Any

Gibt den Absolutbetrag einer Zahl zurück, also die Zahl ohne ihr Minuszeichen. Funktioniert mit Integer- und Real-Werten.

Parameter

• value: Any — Die Integer- oder Real-Zahl.

Rückgabe

Der Absolutbetrag, von derselben Art wie value (Integer oder Real); 0.0 für ein Real, das NaN oder unendlich ist. Ein Wert, der keine Zahl ist, beendet die Aktion mit einem Fehler.

2 Beispiele: Einen Wert auf einen Bereich begrenzen, In welche Richtung ging der Strich?

MathAtan2

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

Gibt den Winkel in Bogenmaß vom Ursprung zum Punkt (x, y) zurück. Die y-Achse des Bildschirms wächst nach unten; übergeben Sie für einen Strichwinkel in der üblichen mathematischen Richtung daher die vertikale Änderung negiert.

Parameter

• y: Any — Die vertikale Koordinate des Punkts. Integer oder Real. Beachten Sie, dass y zuerst kommt.
• x: Any — Die horizontale Koordinate des Punkts. Integer oder Real.

Rückgabe

Der Winkel in Bogenmaß, von -pi bis pi, als Real; 0.0, wenn eines der Argumente NaN oder unendlich ist. Argumente, die keine Zahlen sind, beenden die Aktion mit einem Fehler.

MathCeil

MathCeil(value: Real) → Integer

Rundet eine Zahl auf die nächste ganze Zahl auf. MathCeil(2.1) ergibt 3; MathCeil(-2.1) ergibt -2.

Parameter

• value: Real — Die aufzurundende Zahl. Ein Integer wird unverändert akzeptiert.

Rückgabe

Der gerundete Wert als Integer. 0, wenn value NaN oder unendlich ist; ein Wert außerhalb des Integer-Bereichs ergibt den größten bzw. kleinsten Integer.

1 Beispiel: Runden und Real-Math-Funktionen

MathClamp

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

Hält eine Zahl innerhalb eines Bereichs: gibt min zurück, wenn value darunter liegt, max, wenn value darüber liegt, und sonst value. Funktioniert mit Integer- und Real-Werten.

Parameter

• value: Any — Die Zahl, die im Bereich gehalten werden soll.
• min: Any — Der kleinste zulässige Wert. Darf nicht größer als max sein.
• max: Any — Der größte zulässige Wert.

Rückgabe

Der gewählte Wert von value, min oder max, in seiner eigenen Art (Integer oder Real); 0.0, wenn eines der Argumente NaN oder unendlich ist. Nicht-Zahlen oder ein min größer als max beenden die Aktion mit einem Fehler.

1 Beispiel: Einen Wert auf einen Bereich begrenzen

MathCos

MathCos(radians: Real) → Real

Gibt den Kosinus eines in Bogenmaß angegebenen Winkels zurück. Um Grad umzurechnen, multiplizieren Sie mit MathGetPi() und dividieren durch 180.

Parameter

• radians: Real — Der Winkel in Bogenmaß. Ein Integer wird unverändert akzeptiert.

Rückgabe

Der Kosinus, von -1 bis 1, als Real; 0.0, wenn radians NaN oder unendlich ist.

1 Beispiel: Die Maus im Kreis bewegen

MathFloor

MathFloor(value: Real) → Integer

Rundet eine Zahl auf die nächste ganze Zahl ab. MathFloor(2.9) ergibt 2; MathFloor(-2.1) ergibt -3.

Parameter

• value: Real — Die abzurundende Zahl. Ein Integer wird unverändert akzeptiert.

Rückgabe

Der gerundete Wert als Integer. 0, wenn value NaN oder unendlich ist; ein Wert außerhalb des Integer-Bereichs ergibt den größten bzw. kleinsten Integer.

1 Beispiel: Runden und Real-Math-Funktionen

MathGetE

MathGetE() → Real

Gibt die mathematische Konstante e (etwa 2,71828) zurück, die Basis des natürlichen Logarithmus.

Parameter

Keine Parameter.

Rückgabe

Der Wert von e als Real.

MathGetPi

MathGetPi() → Real

Gibt die mathematische Konstante pi (etwa 3,14159) zurück. Verwenden Sie sie zur Umrechnung zwischen Grad und Bogenmaß.

Parameter

Keine Parameter.

Rückgabe

Der Wert von pi als Real.

1 Beispiel: Die Maus im Kreis bewegen

MathLog

MathLog(value: Real) → Real

Gibt den natürlichen Logarithmus (Basis e) einer Zahl zurück. Dividieren Sie durch MathLog(10.0), um einen Logarithmus zur Basis 10 zu erhalten.

Parameter

• value: Real — Die Zahl, größer als 0. Ein Integer wird unverändert akzeptiert.

Rückgabe

Der natürliche Logarithmus als Real oder 0, wenn value 0, negativ, NaN oder unendlich ist.

MathMax

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

Gibt die größere von zwei Zahlen zurück. Funktioniert mit Integer- und Real-Werten.

Parameter

• a: Any — Die erste Zahl.
• b: Any — Die zweite Zahl.

Rückgabe

Der größere Wert von a oder b, in seiner eigenen Art; a, wenn beide gleich sind; 0.0, wenn einer davon NaN oder unendlich ist. Argumente, die keine Zahlen sind, beenden die Aktion mit einem Fehler.

MathMin

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

Gibt die kleinere von zwei Zahlen zurück. Funktioniert mit Integer- und Real-Werten.

Parameter

• a: Any — Die erste Zahl.
• b: Any — Die zweite Zahl.

Rückgabe

Der kleinere Wert von a oder b, in seiner eigenen Art; a, wenn beide gleich sind; 0.0, wenn einer davon NaN oder unendlich ist. Argumente, die keine Zahlen sind, beenden die Aktion mit einem Fehler.

1 Beispiel: Lauter mit Bildschirmanzeige

MathMod

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

Gibt den Rest der Division von value durch divisor zurück. Das Ergebnis hat das Vorzeichen des Divisors, sodass MathMod(-30, 360) 330 ergibt: richtig, um einen Winkel umlaufen zu lassen oder einen Index zyklisch durchzuschalten.

Parameter

• value: Any — Die zu teilende Zahl. Integer oder Real.
• divisor: Any — Die Zahl, durch die geteilt wird. Integer oder Real.

Rückgabe

Der Rest: ein Integer, wenn beide Argumente Integer sind, sonst ein Real. 0, wenn divisor 0 ist oder eines der Argumente NaN oder unendlich ist. Argumente, die keine Zahlen sind, beenden die Aktion mit einem Fehler.

MathPow

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

Potenziert eine Zahl, etwa zum Quadrat oder zur dritten Potenz. MathPow(2.0, 10.0) ergibt 1024.

Parameter

• base: Real — Die zu potenzierende Zahl. Ein Integer wird unverändert akzeptiert.
• exponent: Real — Der Exponent. Darf negativ oder gebrochen sein; 0.5 ergibt die Quadratwurzel.

Rückgabe

Das Ergebnis als Real oder 0, wenn ein Argument NaN oder unendlich ist oder es kein endliches Ergebnis gibt, etwa bei 0 hoch einem negativen Exponenten oder einem zu großen Ergebnis.

MathRandom

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

Gibt eine zufällige ganze Zahl zwischen min und max zurück, beide eingeschlossen. MathRandom(1, 6) würfelt.

Parameter

• min: Integer — Das kleinstmögliche Ergebnis.
• max: Integer — Das größtmögliche Ergebnis. Darf nicht kleiner als min sein.

Rückgabe

Ein zufälliger Integer von min bis max. Ein min größer als max beendet die Aktion mit einem Fehler.

2 Beispiele: while (true) mit einem Ende-Flag, Zufallszahlen und ein Münzwurf

MathRound

MathRound(value: Real) → Integer

Rundet eine Zahl auf die nächste ganze Zahl. Halbe Werte werden von null weg gerundet: 2.5 wird zu 3 und -2.5 zu -3.

Parameter

• value: Real — Die zu rundende Zahl. Um zwei Nachkommastellen als ganze Zahl zu erhalten, runden Sie value mal 100.

Rückgabe

Der gerundete Wert als Integer. 0, wenn value NaN oder unendlich ist; ein Wert außerhalb des Integer-Bereichs ergibt den größten bzw. kleinsten Integer.

5 Beispiele: Runden und Real-Math-Funktionen, Länge eines Gestenstrichs, Die Maus im Kreis bewegen, Einen Real ohne sechs Nachkommastellen formatieren, Lauter mit Bildschirmanzeige

MathSin

MathSin(radians: Real) → Real

Gibt den Sinus eines in Bogenmaß angegebenen Winkels zurück. Um Grad umzurechnen, multiplizieren Sie mit MathGetPi() und dividieren durch 180.

Parameter

• radians: Real — Der Winkel in Bogenmaß. Ein Integer wird unverändert akzeptiert.

Rückgabe

Der Sinus, von -1 bis 1, als Real; 0.0, wenn radians NaN oder unendlich ist.

1 Beispiel: Die Maus im Kreis bewegen

MathSqrt

MathSqrt(value: Real) → Real

Gibt die Quadratwurzel einer Zahl zurück. MathSqrt(dx * dx + dy * dy) ist der Abstand zwischen zwei Punkten.

Parameter

• value: Real — Die Zahl, 0 oder größer. Ein Integer wird unverändert akzeptiert.

Rückgabe

Die Quadratwurzel als Real oder 0, wenn value negativ, NaN oder unendlich ist.

2 Beispiele: Runden und Real-Math-Funktionen, Länge eines Gestenstrichs

MathTan

MathTan(radians: Real) → Real

Gibt den Tangens eines in Bogenmaß angegebenen Winkels zurück. In der Nähe eines rechten Winkels wird das Ergebnis sehr groß.

Parameter

• radians: Real — Der Winkel in Bogenmaß. Ein Integer wird unverändert akzeptiert.

Rückgabe

Der Tangens als Real; 0.0, wenn radians NaN oder unendlich ist.

Mouse

MouseButtonDown

MouseButtonDown(button: Integer) → Bool

Drückt eine Maustaste an der aktuellen Mauszeigerposition und hält sie gedrückt bis MouseButtonUp. Kombinieren Sie dies mit MouseMoveTo, um ein Ziehen zu skripten.

Parameter

• button: Integer — Eine MouseButton-Konstante wie MouseButton.Primary. Primary und Secondary folgen der Windows-Einstellung zum Vertauschen der Tasten; Left und Right sind die physischen Tasten.

Rückgabe

true, wenn der Tastendruck gesendet wurde; false, wenn Windows ihn blockiert hat. Eine unbekannte Taste beendet das Skript mit einem Fehler.

1 Beispiel: Ein per Skript gesteuertes Ziehen

MouseButtonUp

MouseButtonUp(button: Integer) → Bool

Lässt eine Maustaste an der aktuellen Mauszeigerposition los, typischerweise eine mit MouseButtonDown gedrückte.

Parameter

• button: Integer — Eine MouseButton-Konstante wie MouseButton.Primary. Primary und Secondary folgen der Windows-Einstellung zum Vertauschen der Tasten; Left und Right sind die physischen Tasten.

Rückgabe

true, wenn das Loslassen gesendet wurde; false, wenn Windows es blockiert hat. Eine unbekannte Taste beendet das Skript mit einem Fehler.

1 Beispiel: Ein per Skript gesteuertes Ziehen

MouseClick

MouseClick(x: Integer, y: Integer, button: Integer) → Bool · Einfach

Bewegt den Mauszeiger zu einem Bildschirmpunkt und klickt dort mit einer Maustaste. Der Mauszeiger bleibt danach an diesem Punkt.

Parameter

• x: Integer — Horizontale Bildschirmposition des Klicks, in Pixeln.
• y: Integer — Vertikale Bildschirmposition des Klicks, in Pixeln.
• button: Integer — Eine MouseButton-Konstante wie MouseButton.Primary. Primary und Secondary folgen der Windows-Einstellung zum Vertauschen der Tasten; Left und Right sind die physischen Tasten.

Rückgabe

true, wenn der Klick gesendet wurde; false, wenn der Mauszeiger nicht an den Punkt bewegt werden konnte (dann wird nichts geklickt) oder Windows den Klick blockiert hat. Eine unbekannte Taste beendet das Skript mit einem Fehler.

2 Beispiele: Irgendwo klicken und dann den Mauszeiger zurücksetzen, Umschalt-Klick

MouseClickAtClientPoint

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

Klickt mit einer Maustaste an einem Punkt, gemessen von der oberen linken Ecke des Clientbereichs eines Fensters (das Innere, ohne Titelleiste und Rahmen). Der Mauszeiger bewegt sich dorthin und bleibt dort.

Parameter

• window: Window — Das Fenster, von dessen Clientbereich aus x und y gemessen werden.
• x: Integer — Abstand vom linken Rand des Clientbereichs, in den eigenen Pixeln dieses Fensters, die bei einem Fenster, das Windows für DPI skaliert, von Bildschirmpixeln abweichen können.
• y: Integer — Abstand vom oberen Rand des Clientbereichs, in den eigenen Pixeln dieses Fensters, die bei einem Fenster, das Windows für DPI skaliert, von Bildschirmpixeln abweichen können.
• button: Integer — Eine MouseButton-Konstante wie MouseButton.Primary. Primary und Secondary folgen der Windows-Einstellung zum Vertauschen der Tasten; Left und Right sind die physischen Tasten.

Rückgabe

true, wenn der Klick gesendet wurde; false, wenn das Fenster ungültig oder nicht mehr vorhanden ist oder der Mauszeiger nicht an den Punkt bewegt werden konnte (dann wird nichts geklickt) oder Windows den Klick blockiert hat. Eine unbekannte Taste beendet das Skript mit einem Fehler.

1 Beispiel: Auf einen Punkt in einem Fenster klicken

MouseDoubleClick

MouseDoubleClick(x: Integer, y: Integer, button: Integer) → Bool · Einfach

Bewegt den Mauszeiger zu einem Bildschirmpunkt und doppelklickt dort mit einer Maustaste. Der Mauszeiger bleibt danach an diesem Punkt.

Parameter

• x: Integer — Horizontale Bildschirmposition des Doppelklicks, in Pixeln.
• y: Integer — Vertikale Bildschirmposition des Doppelklicks, in Pixeln.
• button: Integer — Eine MouseButton-Konstante wie MouseButton.Primary. Primary und Secondary folgen der Windows-Einstellung zum Vertauschen der Tasten; Left und Right sind die physischen Tasten.

Rückgabe

true, wenn beide Klicks gesendet wurden; false, wenn der Mauszeiger nicht an den Punkt bewegt werden konnte (dann wird nichts geklickt) oder Windows die Klicks blockiert hat. Eine unbekannte Taste beendet das Skript mit einem Fehler.

MouseGetCursorX

MouseGetCursorX() → Integer

Gibt die horizontale Bildschirmposition des Mauszeigers zurück.

Parameter

Keine Parameter.

Rückgabe

Die x-Position des Mauszeigers in Bildschirmpixeln; negativ auf einem Monitor links vom primären Monitor.

8 Beispiele: else-if-Kette, Die Maus im Kreis bewegen, Die Pixelfarbe unter dem Mauszeiger lesen, Ein Fenster in eine Zelle eines 3×2-Rasters unter dem Mauszeiger einpassen, Beschreiben, was sich unter dem Mauszeiger befindet, Irgendwo klicken und dann den Mauszeiger zurücksetzen, Ein per Skript gesteuertes Ziehen, Umschalt-Klick

MouseGetCursorY

MouseGetCursorY() → Integer

Gibt die vertikale Bildschirmposition des Mauszeigers zurück.

Parameter

Keine Parameter.

Rückgabe

Die y-Position des Mauszeigers in Bildschirmpixeln; negativ auf einem Monitor oberhalb des primären Monitors.

8 Beispiele: else-if-Kette, Die Maus im Kreis bewegen, Die Pixelfarbe unter dem Mauszeiger lesen, Ein Fenster in eine Zelle eines 3×2-Rasters unter dem Mauszeiger einpassen, Beschreiben, was sich unter dem Mauszeiger befindet, Irgendwo klicken und dann den Mauszeiger zurücksetzen, Ein per Skript gesteuertes Ziehen, Umschalt-Klick

MouseIsButtonDown

MouseIsButtonDown(button: Integer) → Bool

Prüft, ob eine Maustaste in diesem Moment gedrückt gehalten wird.

Parameter

• button: Integer — Eine MouseButton-Konstante wie MouseButton.Primary. Primary und Secondary folgen der Windows-Einstellung zum Vertauschen der Tasten; Left und Right sind die physischen Tasten.

Rückgabe

true, wenn die Taste gedrückt ist; false, wenn sie losgelassen ist. Eine unbekannte Taste beendet das Skript mit einem Fehler.

MouseLockToRect

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

Beschränkt den Mauszeiger auf ein Bildschirmrechteck. Die Sperre überdauert das Skript, bis MouseUnlock aufgerufen wird oder ein anderes Programm sie ändert; heben Sie sie daher immer auf, wenn Sie fertig sind.

Parameter

• x: Integer — Linker Rand des Rechtecks, in Bildschirmpixeln.
• y: Integer — Oberer Rand des Rechtecks, in Bildschirmpixeln.
• width: Integer — Breite des Rechtecks, in Pixeln. Muss größer als 0 sein.
• height: Integer — Höhe des Rechtecks, in Pixeln. Muss größer als 0 sein.

Rückgabe

true, wenn der Mauszeiger jetzt beschränkt ist; false, wenn width oder height nicht positiv ist oder Windows abgelehnt hat.

1 Beispiel: Den Mauszeiger 5 Sekunden lang auf ein Fenster beschränken

MouseMoveTo

MouseMoveTo(x: Integer, y: Integer) → Bool · Einfach

Bewegt den Mauszeiger zu einem Bildschirmpunkt auf einem beliebigen Monitor, als hätte der Benutzer die Maus bewegt.

Parameter

• x: Integer — Horizontale Bildschirmposition, in Pixeln.
• y: Integer — Vertikale Bildschirmposition, in Pixeln.

Rückgabe

true, wenn die Bewegung gesendet wurde; false, wenn Windows sie blockiert hat.

3 Beispiele: Die Maus im Kreis bewegen, Irgendwo klicken und dann den Mauszeiger zurücksetzen, Ein per Skript gesteuertes Ziehen

MouseScrollHorizontal

MouseScrollHorizontal(amount: Integer) → Bool · Einfach

Dreht das horizontale Mausrad an der aktuellen Mauszeigerposition. Verwenden Sie zuerst MouseMoveTo, um an einer anderen Stelle zu scrollen.

Parameter

• amount: Integer — Raddistanz, wobei 120 eine Raste ist: positiv scrollt nach rechts, negativ nach links. Kleinere Werte scrollen in Apps, die dies unterstützen, feiner.

Rückgabe

true, wenn der Bildlauf gesendet wurde; false, wenn Windows ihn blockiert hat.

1 Beispiel: Um Rasterstufen scrollen

MouseScrollVertical

MouseScrollVertical(amount: Integer) → Bool · Einfach

Dreht das vertikale Mausrad an der aktuellen Mauszeigerposition. Verwenden Sie zuerst MouseMoveTo, um an einer anderen Stelle zu scrollen.

Parameter

• amount: Integer — Raddistanz, wobei 120 eine Raste ist: positiv scrollt nach oben, negativ nach unten. Kleinere Werte scrollen in Apps, die dies unterstützen, feiner.

Rückgabe

true, wenn der Bildlauf gesendet wurde; false, wenn Windows ihn blockiert hat.

1 Beispiel: Um Rasterstufen scrollen

MouseUnlock

MouseUnlock() → Bool

Hebt jede Beschränkung des Mauszeigers auf, ob durch MouseLockToRect oder durch ein anderes Programm gesetzt.

Parameter

Keine Parameter.

Rückgabe

true, wenn der Mauszeiger frei ist; false, wenn Windows abgelehnt hat.

1 Beispiel: Den Mauszeiger 5 Sekunden lang auf ein Fenster beschränken

Multimedia

MultimediaGetMute

MultimediaGetMute(endpoint: Integer) → Bool

Gibt an, ob das durch endpoint gewählte Standardwiedergabegerät oder Mikrofon in Windows stummgeschaltet ist.

Parameter

• endpoint: Integer — Welches Gerät geprüft wird: AudioEndpoint.Playback (Standardlautsprecher oder -kopfhörer), AudioEndpoint.Capture (Standardmikrofon) oder AudioEndpoint.Communications (das Mikrofon, das Windows für Anrufe verwendet). Jeder andere Wert beendet die Aktion mit einem Fehler.

Rückgabe

true, wenn das Gerät stummgeschaltet ist; false, wenn es nicht stummgeschaltet ist oder nicht existiert (etwa wenn kein Mikrofon angeschlossen ist).

1 Beispiel: Die Stummschaltung des Mikrofons umschalten

MultimediaGetVolume

MultimediaGetVolume(endpoint: Integer) → Real

Gibt die Gesamtlautstärke des durch endpoint gewählten Standardwiedergabegeräts oder Mikrofons als Real von 0.0 bis 1.0 zurück.

Parameter

• endpoint: Integer — Welches Gerät gelesen wird: AudioEndpoint.Playback (Standardlautsprecher oder -kopfhörer), AudioEndpoint.Capture (Standardmikrofon) oder AudioEndpoint.Communications (das Mikrofon, das Windows für Anrufe verwendet). Jeder andere Wert beendet die Aktion mit einem Fehler.

Rückgabe

Die Lautstärke von 0.0 (stumm) bis 1.0 (voll), dieselbe Skala wie bei MultimediaSetVolume; 0.0, wenn das Gerät nicht existiert.

1 Beispiel: Lauter mit Bildschirmanzeige

MultimediaPlayMp3File

MultimediaPlayMp3File(path: Text) → Bool · Einfach

Startet die Wiedergabe einer MP3-Datei und kehrt sofort zurück, während sie abgespielt wird. Das Starten einer weiteren MP3-Datei beendet die noch laufende.

Parameter

• path: Text — Vollständiger Pfad der .mp3-Datei, etwa C:/Music/done.mp3.

Rückgabe

true, wenn die Wiedergabe gestartet wurde; false, wenn die Datei fehlt, Windows sie nicht innerhalb von 10 Sekunden öffnen oder abspielen kann oder „Alle Aktionen beenden“ das Warten beendet hat.

MultimediaPlayWavFile

MultimediaPlayWavFile(path: Text) → Bool · Einfach

Startet die Wiedergabe einer .wav-Sounddatei und kehrt sofort zurück, während sie abgespielt wird. Das Starten einer weiteren WAV-Datei beendet die noch laufende. Nur .wav-Dateien funktionieren; verwenden Sie für MP3 MultimediaPlayMp3File.

Parameter

• path: Text — Vollständiger Pfad der .wav-Datei, etwa C:/Windows/Media/chimes.wav.

Rückgabe

true, wenn die Datei existiert und die Wiedergabe gestartet wurde; false, wenn unter diesem Pfad keine Datei vorhanden ist. Eine vorhandene Datei, die keine abspielbare WAV-Datei ist, gibt true zurück und spielt nichts ab.

1 Beispiel: Einen Sound abspielen

MultimediaSetMute

MultimediaSetMute(endpoint: Integer, muted: Bool) → Bool · Einfach

Schaltet das durch endpoint gewählte Standardwiedergabegerät oder Mikrofon stumm oder hebt die Stummschaltung auf, wie die Stummschalttaste der Windows-Lautstärkeregelung.

Parameter

• endpoint: Integer — Welches Gerät geändert wird: AudioEndpoint.Playback (Standardlautsprecher oder -kopfhörer), AudioEndpoint.Capture (Standardmikrofon) oder AudioEndpoint.Communications (das Mikrofon, das Windows für Anrufe verwendet). Jeder andere Wert beendet die Aktion mit einem Fehler.
• muted: Bool — true, um das Gerät stummzuschalten; false, um die Stummschaltung aufzuheben.

Rückgabe

true, wenn der Stummschaltungszustand gesetzt wurde; false, wenn das Gerät nicht existiert oder die Änderung abgelehnt hat.

1 Beispiel: Ein Umschalter, der zwischen Ausführungen erhalten bleibt

MultimediaSetVolume

MultimediaSetVolume(endpoint: Integer, level: Real) → Bool · Einfach

Setzt die Gesamtlautstärke des durch endpoint gewählten Standardwiedergabegeräts oder Mikrofons auf einen exakten Wert.

Parameter

• endpoint: Integer — Welches Gerät geändert wird: AudioEndpoint.Playback (Standardlautsprecher oder -kopfhörer), AudioEndpoint.Capture (Standardmikrofon) oder AudioEndpoint.Communications (das Mikrofon, das Windows für Anrufe verwendet). Jeder andere Wert beendet die Aktion mit einem Fehler.
• level: Real — Die neue Lautstärke von 0.0 (stumm) bis 1.0 (voll); 0.5 entspricht 50 auf dem Windows-Lautstärkeregler. Werte außerhalb von 0.0 bis 1.0 werden begrenzt.

Rückgabe

true, wenn die Lautstärke gesetzt wurde; false, wenn das Gerät nicht existiert oder die Änderung abgelehnt hat.

2 Beispiele: Lauter mit Bildschirmanzeige, Einen Arduino-Drehknopf zum Lautstärkeregler machen

MultimediaToggleMute

MultimediaToggleMute(endpoint: Integer) → Bool · Einfach

Schaltet das durch endpoint gewählte Standardwiedergabegerät oder Mikrofon stumm, wenn es nicht stummgeschaltet ist, oder hebt die Stummschaltung auf, wenn es stummgeschaltet ist. Rufen Sie danach MultimediaGetMute auf, um den neuen Zustand zu erfahren.

Parameter

• endpoint: Integer — Welches Gerät umgeschaltet wird: AudioEndpoint.Playback (Standardlautsprecher oder -kopfhörer), AudioEndpoint.Capture (Standardmikrofon) oder AudioEndpoint.Communications (das Mikrofon, das Windows für Anrufe verwendet). Jeder andere Wert beendet die Aktion mit einem Fehler.

Rückgabe

true, wenn der Stummschaltungszustand umgeschaltet wurde; false, wenn das Gerät nicht existiert oder die Änderung abgelehnt hat. Dies ist nicht der neue Stummschaltungszustand.

1 Beispiel: Die Stummschaltung des Mikrofons umschalten

Plugin

PluginSendMessage

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

Sendet eine Textnachricht an ein laufendes Plug-in, das Befehle annimmt, und wartet auf seine Antwort. Ein Plug-in verarbeitet jeweils eine Nachricht; Nachrichten, die gesendet werden, während es beschäftigt ist, warten in einer Warteschlange.

Parameter

• pluginName: Text — Der Anzeigename des Plug-ins, exakt abgeglichen, einschließlich Groß-/Kleinschreibung.
• message: Text — Der zu sendende Text. Was er bedeutet, bestimmt das Plug-in.
• timeoutSeconds: Integer — Wie lange auf die Antwort gewartet wird, in Sekunden, von 0 bis 10; jeder andere Wert beendet das Skript mit einem Fehler. Mit 0 kehrt der Aufruf sofort mit leerem Text zurück.

Rückgabe

Die Antwort des Plug-ins oder leerer Text, wenn es nicht rechtzeitig geantwortet hat. Ein nicht laufendes Plug-in, eine volle Warteschlange oder eine zu lange Nachricht beendet das Skript mit einem Fehler.

1 Beispiel: Mit einem Plug-in kommunizieren

Region

RegionGetCellIndexAt

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

Teilt ein Rechteck in ein Raster aus Spalten und Zeilen und gibt zurück, welche Zelle einen Punkt enthält. Die Zellen sind ab 0 nummeriert, von links nach rechts, dann von oben nach unten.

Parameter

• rectX: Integer — Linker Rand des zu teilenden Rechtecks, in Pixeln.
• rectY: Integer — Oberer Rand des zu teilenden Rechtecks, in Pixeln.
• rectWidth: Integer — Breite des Rechtecks, in Pixeln. Muss größer als 0 sein.
• rectHeight: Integer — Höhe des Rechtecks, in Pixeln. Muss größer als 0 sein.
• columns: Integer — Anzahl der Spalten im Raster. Muss größer als 0 sein. Übrige Pixel gehen einzeln an die ersten Spalten.
• rows: Integer — Anzahl der Zeilen im Raster. Muss größer als 0 sein. Übrige Pixel gehen einzeln an die ersten Zeilen.
• pointX: Integer — Horizontale Position des gesuchten Punkts, in denselben Pixeln wie rectX.
• pointY: Integer — Vertikale Position des gesuchten Punkts, in denselben Pixeln wie rectY.

Rückgabe

Die Zellennummer (Zeile mal Spaltenanzahl plus Spalte) oder -1, wenn der Punkt außerhalb des Rechtecks liegt oder rectWidth, rectHeight, columns oder rows nicht positiv ist.

1 Beispiel: Ein Fenster in eine Zelle eines 3×2-Rasters unter dem Mauszeiger einpassen

RegionGetHeight

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

Gibt die Höhe einer Zelle zurück, wenn ein Rechteck in ein Raster aus Spalten und Zeilen geteilt wird. Übrige Pixel gehen einzeln an die ersten Zeilen.

Parameter

• rectX: Integer — Linker Rand des zu teilenden Rechtecks, in Pixeln.
• rectY: Integer — Oberer Rand des zu teilenden Rechtecks, in Pixeln.
• rectWidth: Integer — Breite des Rechtecks, in Pixeln. Muss größer als 0 sein.
• rectHeight: Integer — Höhe des Rechtecks, in Pixeln. Muss größer als 0 sein.
• columns: Integer — Anzahl der Spalten im Raster. Muss größer als 0 sein.
• rows: Integer — Anzahl der Zeilen im Raster. Muss größer als 0 sein.
• index: Integer — Nullbasierte Zellennummer, gezählt von links nach rechts, dann von oben nach unten, von 0 bis columns mal rows minus 1.

Rückgabe

Die Höhe der Zelle in Pixeln oder -1, wenn index außerhalb des Bereichs liegt oder rectWidth, rectHeight, columns oder rows nicht positiv ist.

1 Beispiel: Ein Fenster in eine Zelle eines 3×2-Rasters unter dem Mauszeiger einpassen

RegionGetWidth

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

Gibt die Breite einer Zelle zurück, wenn ein Rechteck in ein Raster aus Spalten und Zeilen geteilt wird. Übrige Pixel gehen einzeln an die ersten Spalten.

Parameter

• rectX: Integer — Linker Rand des zu teilenden Rechtecks, in Pixeln.
• rectY: Integer — Oberer Rand des zu teilenden Rechtecks, in Pixeln.
• rectWidth: Integer — Breite des Rechtecks, in Pixeln. Muss größer als 0 sein.
• rectHeight: Integer — Höhe des Rechtecks, in Pixeln. Muss größer als 0 sein.
• columns: Integer — Anzahl der Spalten im Raster. Muss größer als 0 sein.
• rows: Integer — Anzahl der Zeilen im Raster. Muss größer als 0 sein.
• index: Integer — Nullbasierte Zellennummer, gezählt von links nach rechts, dann von oben nach unten, von 0 bis columns mal rows minus 1.

Rückgabe

Die Breite der Zelle in Pixeln oder -1, wenn index außerhalb des Bereichs liegt oder rectWidth, rectHeight, columns oder rows nicht positiv ist.

1 Beispiel: Ein Fenster in eine Zelle eines 3×2-Rasters unter dem Mauszeiger einpassen

RegionGetX

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

Gibt den linken Rand einer Zelle zurück, wenn ein Rechteck in ein Raster aus Spalten und Zeilen geteilt wird. Übrige Pixel gehen einzeln an die ersten Spalten.

Parameter

• rectX: Integer — Linker Rand des zu teilenden Rechtecks, in Pixeln.
• rectY: Integer — Oberer Rand des zu teilenden Rechtecks, in Pixeln.
• rectWidth: Integer — Breite des Rechtecks, in Pixeln. Muss größer als 0 sein.
• rectHeight: Integer — Höhe des Rechtecks, in Pixeln. Muss größer als 0 sein.
• columns: Integer — Anzahl der Spalten im Raster. Muss größer als 0 sein.
• rows: Integer — Anzahl der Zeilen im Raster. Muss größer als 0 sein.
• index: Integer — Nullbasierte Zellennummer, gezählt von links nach rechts, dann von oben nach unten, von 0 bis columns mal rows minus 1.

Rückgabe

Der linke Rand der Zelle oder -1, wenn index außerhalb des Bereichs liegt oder rectWidth, rectHeight, columns oder rows nicht positiv ist. Eine echte Zelle kann auch bei -1 beginnen; prüfen Sie daher zuerst index.

1 Beispiel: Ein Fenster in eine Zelle eines 3×2-Rasters unter dem Mauszeiger einpassen

RegionGetY

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

Gibt den oberen Rand einer Zelle zurück, wenn ein Rechteck in ein Raster aus Spalten und Zeilen geteilt wird. Übrige Pixel gehen einzeln an die ersten Zeilen.

Parameter

• rectX: Integer — Linker Rand des zu teilenden Rechtecks, in Pixeln.
• rectY: Integer — Oberer Rand des zu teilenden Rechtecks, in Pixeln.
• rectWidth: Integer — Breite des Rechtecks, in Pixeln. Muss größer als 0 sein.
• rectHeight: Integer — Höhe des Rechtecks, in Pixeln. Muss größer als 0 sein.
• columns: Integer — Anzahl der Spalten im Raster. Muss größer als 0 sein.
• rows: Integer — Anzahl der Zeilen im Raster. Muss größer als 0 sein.
• index: Integer — Nullbasierte Zellennummer, gezählt von links nach rechts, dann von oben nach unten, von 0 bis columns mal rows minus 1.

Rückgabe

Der obere Rand der Zelle oder -1, wenn index außerhalb des Bereichs liegt oder rectWidth, rectHeight, columns oder rows nicht positiv ist. Eine echte Zelle kann auch bei -1 beginnen; prüfen Sie daher zuerst index.

1 Beispiel: Ein Fenster in eine Zelle eines 3×2-Rasters unter dem Mauszeiger einpassen

Serial

SerialClosePort

SerialClosePort(port: Text) → Bool

Schließt einen mit SerialOpenPort geöffneten COM-Anschluss und gibt ihn für andere Programme wie die Arduino IDE frei. Noch nicht gelesene empfangene Zeilen werden verworfen.

Parameter

• port: Text — Der an SerialOpenPort übergebene Anschlussname, etwa COM3. Groß-/Kleinschreibung spielt keine Rolle.

Rückgabe

true, wenn der Anschluss geöffnet war und jetzt geschlossen ist; false, wenn er nicht geöffnet war oder ein serieller Monitor ihn belegt (verwenden Sie SerialMonitorDelete).

1 Beispiel: Ein serielles Gerät etwas fragen

SerialEnumeratePorts

SerialEnumeratePorts() → Integer

Sucht die seriellen Anschlüsse (COM) auf diesem Computer, etwa einen über USB angeschlossenen Arduino, ESP32 oder USB-Seriell-Adapter, und gibt ihre Anzahl zurück. Lesen Sie jeden Namen mit SerialGetEnumeratedPortAt.

Parameter

Keine Parameter.

Rückgabe

Die Anzahl der gefundenen COM-Anschlüsse oder 0, wenn keine vorhanden sind.

1 Beispiel: Die COM-Anschlüsse auflisten

SerialGetEnumeratedPortAt

SerialGetEnumeratedPortAt(index: Integer) → Text

Gibt einen Anschlussnamen, etwa COM3, aus der Liste zurück, die der letzte Aufruf von SerialEnumeratePorts in diesem Skriptlauf erstellt hat. Im Geräte-Manager sehen Sie, welches Gerät an welchem Anschluss hängt.

Parameter

• index: Integer — Position in der Liste, von 0 bis zur Anzahl minus 1. Die Namen sind nach Nummer sortiert, daher kommt COM3 vor COM10.

Rückgabe

Der Anschlussname oder leerer Text, wenn index außerhalb des Bereichs liegt oder SerialEnumeratePorts nicht aufgerufen wurde.

1 Beispiel: Die COM-Anschlüsse auflisten

SerialGetTextLine

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

Wartet auf die nächste vollständige Zeile von einem COM-Anschluss und gibt sie zurück, etwa einen Sensorwert, einen Barcode-Scan oder die Antwort eines Geräts. Blockiert das Skript bis zu timeoutSeconds lang; „Alle Aktionen beenden“ bricht das Warten ab.

Parameter

• port: Text — Der Anschlussname, etwa COM3. Öffnen Sie ihn zuerst mit SerialOpenPort, um die Einstellungen zu wählen und früh eintreffende Zeilen zu behalten; andernfalls wird er nur für dieses Warten mit baudRate geöffnet.
• timeoutSeconds: Integer — Maximale Wartezeit in Sekunden. 0 wartet, bis eine Zeile eintrifft oder das Skript beendet wird. Ein negativer Wert beendet das Skript mit einem Fehler.
• baudRate: Integer — Geschwindigkeit in Bit pro Sekunde, nur verwendet, wenn dieser Aufruf den Anschluss selbst öffnet, etwa 9600 oder 115200; ignoriert bei einem mit SerialOpenPort geöffneten Anschluss. 0 oder weniger beendet das Skript mit einem Fehler.

Rückgabe

Die Zeile ohne Zeilenabschluss oder leerer Text, wenn keine Zeile rechtzeitig eingetroffen ist, der Anschluss nicht geöffnet werden konnte oder das Gerät getrennt wurde. Beendet das Skript mit einem Fehler, wenn ein serieller Monitor den Anschluss belegt.

2 Beispiele: Ein serielles Gerät etwas fragen, Den Anschluss eines Arduino offen halten und ihm Befehle senden

SerialMonitorCreate

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

Öffnet einen COM-Anschluss und führt für jede Zeile, die das Gerät sendet, ein Skript aus, etwa um eine Arduino-Tastenbox oder ein Makro-Pad in Tastenkürzel zu verwandeln. Der Monitor läuft nach dem Ende dieses Skripts weiter. „Alle Aktionen beenden“ beendet das Skript, das gerade für eine Zeile läuft, und verwirft wartende Zeilen; der Monitor läuft weiter.

Parameter

• name: Text — Ein Name für den Monitor. Wird der Name des aktuellen Monitors dieses Anschlusses erneut verwendet, wird dieser ersetzt; ein Name, der bereits einen anderen Anschluss überwacht, beendet das Skript mit einem Fehler. Groß-/Kleinschreibung spielt keine Rolle.
• port: Text — Der Anschlussname, etwa COM3. Im Geräte-Manager sehen Sie, an welchem Anschluss ein Board hängt.
• baudRate: Integer — Geschwindigkeit in Bit pro Sekunde. Sie muss zum Gerät passen, etwa die 9600 oder 115200 in Serial.begin eines Arduino-Sketches.
• parity: Integer — Eine SerialParity-Konstante. Die meisten Geräte, auch Arduino-Boards, verwenden SerialParity.None.
• dataBits: Integer — Bits pro Zeichen, als einfache Zahl. Fast jedes Gerät verwendet 8.
• stopBits: Integer — Eine SerialStopBits-Konstante, meist SerialStopBits.One. Verwenden Sie die Konstante: Die einfache Zahl 1 bedeutet eineinhalb Stoppbits.
• terminator: Text — Der Text, der jede Zeile beendet: Er wird aus empfangenen Zeilen entfernt und an jede Zeile angehängt, die SerialWriteTextLine sendet. Leerer Text bedeutet CR LF, was Serial.println von Arduino sendet. Verwenden Sie '\n' bei Geräten, die Zeilen nur mit LF beenden, oder '\r' nur für CR.
• script: Text — Das für jede empfangene Zeile auszuführende Skript als Text. Es liest die Zeile mit ContextGetSerialTextLine. Die Zeilen laufen nacheinander in der Reihenfolge ihres Eintreffens; bis zu 256 Zeilen warten, während das Skript läuft, darüber hinaus werden die ältesten verworfen.

Rückgabe

true, sobald der Monitor läuft; false, wenn der Anschluss fehlt, getrennt ist oder von einem anderen Programm verwendet wird. Beendet das Skript mit einem Fehler, wenn der Anschluss mit SerialOpenPort geöffnet ist oder unter einem anderen Namen überwacht wird oder dieser Name bereits einen anderen Anschluss überwacht. Das Trennen des Geräts beendet den Monitor und schreibt eine Zeile in die Registerkarte System der Konsole.

2 Beispiele: Tasten eines seriellen Geräts Medientasten zuordnen, Einen Arduino-Drehknopf zum Lautstärkeregler machen

SerialMonitorDelete

SerialMonitorDelete(name: Text) → Bool

Beendet einen mit SerialMonitorCreate erstellten seriellen Monitor und schließt seinen COM-Anschluss, sodass andere Programme den Anschluss wieder verwenden können. Noch nicht verarbeitete Zeilen werden verworfen; ein bereits laufendes Skript läuft zu Ende.

Parameter

• name: Text — Der an SerialMonitorCreate übergebene Name. Groß-/Kleinschreibung spielt keine Rolle.

Rückgabe

true, wenn ein Monitor mit diesem Namen gefunden und beendet wurde; false, wenn es keinen gab.

SerialMonitorDeleteAll

SerialMonitorDeleteAll() → Bool

Beendet alle seriellen Monitore und schließt ihre COM-Anschlüsse. Mit SerialOpenPort geöffnete Anschlüsse bleiben geöffnet.

Parameter

Keine Parameter.

Rückgabe

Immer true.

SerialMonitorGetCount

SerialMonitorGetCount() → Integer

Gibt zurück, wie viele serielle Monitore laufen, und erstellt eine Momentaufnahme ihrer Namen für SerialMonitorGetEnumeratedNameAt.

Parameter

Keine Parameter.

Rückgabe

Die Anzahl der laufenden seriellen Monitore oder 0, wenn keiner läuft.

SerialMonitorGetEnumeratedNameAt

SerialMonitorGetEnumeratedNameAt(index: Integer) → Text

Gibt einen Monitornamen aus der Momentaufnahme zurück, die der letzte Aufruf von SerialMonitorGetCount in diesem Skriptlauf erstellt hat.

Parameter

• index: Integer — Position in der Momentaufnahme, von 0 bis zur Anzahl minus 1. Die Reihenfolge hat keine Bedeutung.

Rückgabe

Der Monitorname oder leerer Text, wenn index außerhalb des Bereichs liegt oder SerialMonitorGetCount nicht aufgerufen wurde.

SerialOpenPort

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

Öffnet einen COM-Anschluss und hält ihn bis SerialClosePort offen, wobei jede empfangene Zeile für SerialGetTextLine gesammelt wird. Das Öffnen schaltet die Signale DTR und RTS ein, wodurch viele Arduino-Boards neu starten, genau wie bei der Arduino IDE; öffnen Sie ihn daher einmal und verwenden Sie ihn weiter.

Parameter

• port: Text — Der Anschlussname, etwa COM3. Der Geräte-Manager oder SerialEnumeratePorts zeigt ihn an. Leerer Text beendet das Skript mit einem Fehler.
• baudRate: Integer — Geschwindigkeit in Bit pro Sekunde. Sie muss zum Gerät passen, etwa die 9600 oder 115200 in Serial.begin eines Arduino-Sketches.
• parity: Integer — Eine SerialParity-Konstante. Die meisten Geräte, auch Arduino-Boards, verwenden SerialParity.None.
• dataBits: Integer — Bits pro Zeichen, als einfache Zahl. Fast jedes Gerät verwendet 8.
• stopBits: Integer — Eine SerialStopBits-Konstante, meist SerialStopBits.One. Verwenden Sie die Konstante: Die einfache Zahl 1 bedeutet eineinhalb Stoppbits.
• terminator: Text — Der Text, der jede Zeile beendet: Er wird aus empfangenen Zeilen entfernt und an jede Zeile angehängt, die SerialWriteTextLine sendet. Leerer Text bedeutet CR LF, was Serial.println von Arduino sendet. Verwenden Sie '\n' bei Geräten, die Zeilen nur mit LF beenden, oder '\r' nur für CR.

Rückgabe

true, wenn der Anschluss geöffnet ist; false, wenn er fehlt, getrennt ist, von einem anderen Programm wie einem seriellen Monitor verwendet wird oder die Einstellungen abgelehnt hat. Beendet das Skript mit einem Fehler, wenn Input.Observer den Anschluss bereits geöffnet hat oder ein serieller Monitor ihn belegt.

2 Beispiele: Ein serielles Gerät etwas fragen, Den Anschluss eines Arduino offen halten und ihm Befehle senden

SerialWriteTextLine

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

Sendet eine Textzeile plus das Zeilenende des Anschlusses an einen COM-Anschluss, etwa einen Befehl für einen Arduino oder eine G-Code-Zeile für einen 3D-Drucker. Funktioniert mit einem mit SerialOpenPort geöffneten oder von einem seriellen Monitor belegten Anschluss, sodass das Skript eines Monitors seinem Gerät antworten kann. Ein nicht geöffneter Anschluss wird nur für diesen Schreibvorgang mit baudRate, 8-N-1 geöffnet.

Parameter

• port: Text — Der Anschlussname, etwa COM3. Öffnen Sie ihn zuerst mit SerialOpenPort, um die Einstellungen zu wählen und zu vermeiden, dass Boards neu starten, die sich beim Öffnen des Anschlusses zurücksetzen.
• text: Text — Die zu sendende Zeile, codiert als UTF-8. Fügen Sie kein Zeilenende hinzu: Angehängt wird das Zeilenende (terminator), mit dem der Anschluss geöffnet wurde, oder CR LF, wenn dieser Aufruf den Anschluss selbst öffnet.
• baudRate: Integer — Geschwindigkeit in Bit pro Sekunde, nur verwendet, wenn dieser Aufruf den Anschluss selbst öffnet, etwa 9600 oder 115200; ignoriert bei einem bereits geöffneten oder überwachten Anschluss. 0 oder weniger beendet das Skript mit einem Fehler.

Rückgabe

true, wenn die Zeile gesendet wurde; false, wenn der Anschluss nicht geöffnet werden konnte oder das Schreiben fehlschlug oder eine Zeitüberschreitung auftrat.

2 Beispiele: Ein serielles Gerät etwas fragen, Den Anschluss eines Arduino offen halten und ihm Befehle senden

Shell

ShellEmptyRecycleBins

ShellEmptyRecycleBins() → Bool · Einfach

Löscht endgültig alles im Papierkorb auf allen Laufwerken, ohne Bestätigung. Dies kann nicht rückgängig gemacht werden.

Parameter

Keine Parameter.

Rückgabe

true, wenn die Papierkörbe geleert wurden oder bereits leer waren; andernfalls false.

ShellEnumerateProcessIdsByExeRegex

ShellEnumerateProcessIdsByExeRegex(pattern: Text) → Integer

Sucht alle laufenden Prozesse, deren Programmdateiname, etwa notepad.exe, einem regulären Ausdruck entspricht, und gibt ihre Anzahl zurück. Lesen Sie jede Prozess-ID mit ShellGetEnumeratedProcessIdAt.

Parameter

• pattern: Text — Ein regulärer Ausdruck, ohne Beachtung der Groß-/Kleinschreibung nur mit dem Dateinamen abgeglichen, nicht mit dem vollständigen Pfad. Verwenden Sie ^ und $, um den ganzen Namen abzugleichen, etwa ^notepad[.]exe$.

Rückgabe

Die Anzahl der passenden Prozesse oder 0, wenn keiner passt. Ein ungültiges Muster beendet das Skript mit einem Fehler.

1 Beispiel: Vom Prozess zum Fenster

ShellExpandEnvironmentVariables

ShellExpandEnvironmentVariables(text: Text) → Text

Ersetzt jede Umgebungsvariable im Text, geschrieben als Name zwischen zwei Prozentzeichen wie USERPROFILE oder TEMP, durch ihren Wert. Nützlich, um Pfade zu bilden, die auf jedem PC funktionieren.

Parameter

• text: Text — Text mit Namen von Umgebungsvariablen zwischen Prozentzeichen, etwa ein Pfad im Profilordner des Benutzers.

Rückgabe

Der Text mit allen bekannten Variablen ersetzt; unbekannte Variablen bleiben wie geschrieben. Leerer Text, wenn die Erweiterung fehlschlägt.

8 Beispiele: Das heutige Datum und ein Dateiname mit Zeitstempel, Einen Screenshot des umkreisten Bereichs erstellen, Ein kopiertes Bild in einer Datei speichern, An eine Protokolldatei anhängen, Dateitypen in einem Ordner zählen, Eine Datei vor dem Bearbeiten sichern, Einen Ordner überwachen, Umgebungsvariablen erweitern

ShellGetEnumeratedProcessIdAt

ShellGetEnumeratedProcessIdAt(index: Integer) → Integer

Gibt eine Prozess-ID aus der Liste zurück, die der letzte Aufruf von ShellEnumerateProcessIdsByExeRegex in diesem Skriptlauf erstellt hat.

Parameter

• index: Integer — Position in der Liste, von 0 bis zur Anzahl minus 1.

Rückgabe

Die Prozess-ID oder 0, wenn index außerhalb des Bereichs liegt oder ShellEnumerateProcessIdsByExeRegex nicht aufgerufen wurde.

1 Beispiel: Vom Prozess zum Fenster

ShellGetSystemMetricsByIndex

ShellGetSystemMetricsByIndex(index: Integer) → Integer

Gibt einen Windows-Systemmesswert oder eine Einstellung über ihren GetSystemMetrics-Index zurück, etwa 0 für die Breite des primären Bildschirms oder 80 für die Anzahl der Monitore.

Parameter

• index: Integer — Eine Windows-SM_-Indexnummer, etwa 0 (SM_CXSCREEN) oder 1 (SM_CYSCREEN). Dafür gibt es keine benannten Konstanten.

Rückgabe

Der von Windows gemeldete Wert, oft in Pixeln, oder 0 für einen unbekannten Index.

ShellRun

ShellRun(command: Text) → Bool · Einfach

Führt ein Programm aus oder öffnet eine Datei, einen Ordner oder eine Webadresse, als würden Sie es in das Windows-Dialogfeld Ausführen (Win+R) eingeben. Wartet nicht, bis das Programm beendet ist.

Parameter

• command: Text — Ein Programmname wie notepad.exe, ein Pfad oder eine Webadresse, optional gefolgt von Argumenten. Setzen Sie einen Pfad mit Leerzeichen in einfache Anführungszeichen, wenn Argumente folgen.

Rückgabe

true, wenn Windows es gestartet hat; false, wenn es nicht gefunden oder gestartet werden konnte. Bei einem Fehler wird kein Windows-Fehlerfenster angezeigt.

4 Beispiele: while-Schleife: mit Zeitlimit auf ein Fenster warten, Ein Programm starten, auf sein Fenster warten, darauf reagieren, Im Web nach dem markierten Text suchen, Im Web nach der Markierung suchen

ShellRunOrActivate

ShellRunOrActivate(exeName: Text) → Bool · Einfach

Holt das Fenster eines Programms in den Vordergrund, wenn das Programm bereits läuft, oder führt andernfalls den Befehl aus. Nützlich für eine Geste, die Sie immer zum selben Programm bringt.

Parameter

• exeName: Text — Der Dateiname des Programms, etwa notepad oder notepad.exe, oder sein vollständiger Pfad, optional gefolgt von Argumenten, die nur beim Starten verwendet werden. Laufende Fenster werden über den Dateinamen des ersten Worts zugeordnet, wobei .exe ergänzt wird, wenn es keine Erweiterung hat; setzen Sie einen Pfad mit Leerzeichen in einfache Anführungszeichen.

Rückgabe

true, wenn ein Fenster in den Vordergrund geholt oder das Programm gestartet wurde; false, wenn Windows das Hervorholen des Fensters abgelehnt hat oder der Start fehlgeschlagen ist.

1 Beispiel: Eine App starten oder zu ihr wechseln

ShellRunProgram

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

Führt ein Programm aus oder öffnet eine Datei mit einer gewählten Aktion (Verb) und einem Fensterstil und kann warten, bis es geschlossen wird. Verwenden Sie ShellVerb.RunAs, um ein Programm als Administrator auszuführen.

Parameter

• path: Text — Das zu öffnende Programm, Dokument oder der zu öffnende Ordner, etwa notepad.exe oder ein vollständiger Dateipfad.
• arguments: Text — Befehlszeilenargumente für das Programm oder leerer Text für keine.
• verb: Any — Eine ShellVerb-Konstante wie ShellVerb.Open oder ShellVerb.Print oder ein beliebiges vom Dateityp unterstütztes Verb als Text. Leerer Text verwendet die Standardaktion.
• windowStyle: Integer — Eine WindowStyle-Konstante: WindowStyle.Normal, WindowStyle.Minimized, WindowStyle.Maximized oder WindowStyle.Hidden. Jeder andere Wert beendet das Skript mit einem Fehler. Manche Programme ignorieren ihn.
• waitForExit: Bool — true, um das Skript zu blockieren, bis das Programm geschlossen wird; „Alle Aktionen beenden“ beendet das Warten und lässt das Programm weiterlaufen. false, um sofort fortzufahren.

Rückgabe

true, wenn Windows es gestartet hat (und es mit waitForExit geschlossen wurde); false, wenn es nicht starten konnte, die Administratorabfrage abgelehnt wurde oder „Alle Aktionen beenden“ das Warten beendet hat. Bei einem Fehler wird kein Windows-Fehlerfenster angezeigt.

2 Beispiele: Ein Programm mit Verb und Fensterstil ausführen, Ausführen und auf das Ende warten

ShellRunStoreApp

ShellRunStoreApp(packageName: Text) → Bool · Einfach

Startet eine installierte Microsoft Store-App über ihren Paketnamen, einen Teil davon oder ihren Namen im Startmenü, etwa Microsoft.WindowsCalculator oder Rechner. Normale Desktopprogramme werden nicht gefunden; verwenden Sie dafür ShellRun.

Parameter

• packageName: Text — Der Paketfamilienname der App oder ein Teil davon oder ihr genauer Name im Startmenü, ohne Beachtung der Groß-/Kleinschreibung abgeglichen. Ein genauer Paketfamilienname hat Vorrang, dann ein genauer Startmenüname, dann die erste App, deren Paketfamilienname den Text enthält.

Rückgabe

true, wenn die App gestartet wurde; false, wenn packageName leer ist, keine installierte Store-App passt oder der Start fehlgeschlagen ist.

ShellShowToast

ShellShowToast(title: Text, message: Text) → Bool · Einfach

Zeigt eine Windows-Benachrichtigung (Popup) mit Titel und Nachricht an. Wartet nur, bis Windows sie annimmt, nicht bis sie geschlossen wird.

Parameter

• title: Text — Die erste, fett gedruckte Zeile der Benachrichtigung.
• message: Text — Der unter dem Titel angezeigte Text.

Rückgabe

true, wenn die Benachrichtigung angezeigt wurde; false, wenn Benachrichtigungen in den allgemeinen Einstellungen ausgeschaltet sind, Windows sie abgelehnt hat oder „Alle Aktionen beenden“ das Warten beendet hat.

9 Beispiele: Ein Fenster im Vordergrund fixieren, Einen Screenshot des umkreisten Bereichs erstellen, Ein kopiertes Bild in einer Datei speichern, Ein Umschalter, der zwischen Ausführungen erhalten bleibt, Eine Windows-Benachrichtigung, Die Stummschaltung des Mikrofons umschalten, Ausführen und auf das Ende warten, Zum nächsten Gestenprofil wechseln, Zustand der Engine

ShellTerminateProcess

ShellTerminateProcess(processId: Integer) → Bool

Beendet einen Prozess sofort, wie Task beenden im Task-Manager. Nicht gespeicherte Arbeit in diesem Programm geht verloren.

Parameter

• processId: Integer — Die Prozess-ID, etwa von WindowGetProcessId oder ShellGetEnumeratedProcessIdAt. 0 oder weniger, der eigene Prozess von Input.Observer und Windows-Systemprozesse beenden das Skript mit einem Fehler.

Rückgabe

true, wenn der Prozess beendet wurde; false, wenn er bereits beendet war oder Windows den Zugriff verweigert hat, etwa bei einem als Administrator ausgeführten Programm.

Snippet

SnippetExecuteScript

SnippetExecuteScript(name: Text) → Bool · Einfach

Führt das Snippet mit diesem Namen aus und wartet, bis es fertig ist. Das Snippet sieht den Auslöserkontext des Aufrufers, hat aber eigene Variablen.

Parameter

• name: Text — Der Name des Snippets, exakt abgeglichen, einschließlich Groß-/Kleinschreibung.

Rückgabe

true, wenn das Snippet bis zum Ende gelaufen ist; false, wenn kein Snippet diesen Namen hat oder das Snippet leer ist, einen Fehler hat oder beendet wurde.

1 Beispiel: Snippets als wiederverwendbare Funktionen

SnippetGetScript

SnippetGetScript(name: Text) → Text

Gibt den Skripttext des Snippets mit diesem Namen zurück, ohne es auszuführen, etwa um ihn an TimerCreate zu übergeben.

Parameter

• name: Text — Der Name des Snippets, exakt abgeglichen, einschließlich Groß-/Kleinschreibung.

Rückgabe

Der Skripttext des Snippets oder leerer Text, wenn kein Snippet diesen Namen hat.

1 Beispiel: Timerskript aus einem Snippet, ohne Escapes

Storage

StorageClearAll

StorageClearAll() → Bool

Entfernt alle mit StorageSetValue gespeicherten Werte für alle Aktionen. Dauerhafte Werte sind nicht betroffen.

Parameter

Keine Parameter.

Rückgabe

Immer true.

StorageClearAllPersistent

StorageClearAllPersistent() → Bool

Entfernt alle dauerhaften Werte und löscht sie aus storage.toml, sodass keiner davon nach einem Neustart zurückkehrt. Mit StorageSetValue gespeicherte Werte sind nicht betroffen.

Parameter

Keine Parameter.

Rückgabe

Immer true.

StorageClearPersistentValue

StorageClearPersistentValue(key: Text) → Bool

Entfernt einen dauerhaften Wert und löscht ihn aus storage.toml. Ist der Schlüssel nicht gespeichert, geschieht nichts.

Parameter

• key: Text — Der Name des zu entfernenden Werts. Groß- und Kleinschreibung werden unterschieden.

Rückgabe

Immer true, unabhängig davon, ob der Schlüssel gespeichert war.

StorageClearValue

StorageClearValue(key: Text) → Bool

Entfernt einen mit StorageSetValue gespeicherten Wert. Ist der Schlüssel nicht gespeichert, geschieht nichts.

Parameter

• key: Text — Der Name des zu entfernenden Werts. Groß- und Kleinschreibung werden unterschieden.

Rückgabe

Immer true, unabhängig davon, ob der Schlüssel gespeichert war.

StorageGetPersistentValue

StorageGetPersistentValue(key: Text) → Any

Liest einen mit StorageSetPersistentValue gespeicherten Wert, auch einen, der vor dem letzten Neustart von Input.Observer gespeichert wurde.

Parameter

• key: Text — Der Name, unter dem der Wert gespeichert wurde. Groß- und Kleinschreibung werden unterschieden.

Rückgabe

Der gespeicherte Wert mit seiner Art (Bool, Integer, Real oder Text) oder Integer 0, wenn der Schlüssel nicht gespeichert ist. Mit StorageHasPersistentValue unterscheiden Sie einen fehlenden Schlüssel von einer gespeicherten 0.

1 Beispiel: Ein Zähler, der einen Neustart übersteht

StorageGetValue

StorageGetValue(key: Text) → Any

Liest einen Wert, der seit dem Start von Input.Observer von dieser oder einer anderen Aktion mit StorageSetValue gespeichert wurde.

Parameter

• key: Text — Der Name, unter dem der Wert gespeichert wurde. Groß- und Kleinschreibung werden unterschieden.

Rückgabe

Der gespeicherte Wert mit seiner Art (Bool, Integer, Real, Text oder Window) oder Integer 0, wenn der Schlüssel nicht gespeichert ist. Mit StorageHasValue unterscheiden Sie einen fehlenden Schlüssel von einer gespeicherten 0.

5 Beispiele: && und || werten beide Seiten aus, Ein wiederholender Timer, der zählt, Ein Umschalter, der zwischen Ausführungen erhalten bleibt, Eine in Storage gehaltene Liste, Snippets als wiederverwendbare Funktionen

StorageHasPersistentValue

StorageHasPersistentValue(key: Text) → Bool

Prüft, ob unter einem Namen ein dauerhafter Wert gespeichert ist. Damit unterscheiden Sie einen fehlenden Schlüssel von einer gespeicherten 0, false oder leerem Text.

Parameter

• key: Text — Der gesuchte Name. Groß- und Kleinschreibung werden unterschieden.

Rückgabe

true, wenn unter key ein dauerhafter Wert gespeichert ist; andernfalls false.

StorageHasValue

StorageHasValue(key: Text) → Bool

Prüft, ob unter einem Namen ein Wert mit StorageSetValue gespeichert ist. Damit unterscheiden Sie einen fehlenden Schlüssel von einer gespeicherten 0, false oder leerem Text.

Parameter

• key: Text — Der gesuchte Name. Groß- und Kleinschreibung werden unterschieden.

Rückgabe

true, wenn unter key ein Wert gespeichert ist; andernfalls false.

StorageSetPersistentValue

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

Speichert einen Wert unter einem Namen, der einen Neustart übersteht, in storage.toml neben der Konfigurationsdatei. Die Datei ist reiner Text und nie verschlüsselt: Bewahren Sie dort keine Kennwörter oder andere Geheimnisse auf.

Parameter

• key: Text — Der Name, unter dem gespeichert wird, bis zu 256 Zeichen. Groß- und Kleinschreibung werden unterschieden. Ersetzt einen bereits darunter gespeicherten Wert.
• value: Any — Der zu speichernde Wert: ein Bool, Integer, Real oder Text (bis zu 32.768 Zeichen). Er kommt mit derselben Art zurück. Ein Window kann nicht gespeichert werden.

Rückgabe

true, sobald der Wert gespeichert ist. false, wenn storage.toml beim Start vorhanden war, aber nicht gelesen werden konnte: Das Speichern ist dann bis zum nächsten Start aus, und der Wert bleibt nur erhalten, bis Input.Observer beendet wird. Ein Window-Wert, ein Schlüssel mit mehr als 256 Zeichen, Text mit mehr als 32.768 Zeichen oder ein neuer Schlüssel über 1.024 gespeicherte Werte hinaus beendet die Aktion mit einem Fehler.

1 Beispiel: Ein Zähler, der einen Neustart übersteht

StorageSetValue

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

Speichert einen Wert unter einem Namen, damit spätere Läufe dieser oder einer anderen Aktion ihn lesen können. Werte bleiben erhalten, bis Input.Observer beendet wird; verwenden Sie StorageSetPersistentValue, um einen Wert über Neustarts hinweg zu behalten.

Parameter

• key: Text — Der Name, unter dem gespeichert wird, bis zu 256 Zeichen. Groß- und Kleinschreibung werden unterschieden. Ersetzt einen bereits darunter gespeicherten Wert, unabhängig von seiner Art.
• value: Any — Der zu speichernde Wert: ein Bool, Integer, Real, Text (bis zu 32.768 Zeichen) oder Window. Er kommt mit derselben Art zurück.

Rückgabe

true, sobald der Wert gespeichert ist. Ein Schlüssel mit mehr als 256 Zeichen, Text mit mehr als 32.768 Zeichen oder ein neuer Schlüssel über 1.024 gespeicherte Werte hinaus beendet die Aktion mit einem Fehler.

5 Beispiele: && und || werten beide Seiten aus, Ein wiederholender Timer, der zählt, Ein Umschalter, der zwischen Ausführungen erhalten bleibt, Eine in Storage gehaltene Liste, Snippets als wiederverwendbare Funktionen

String

StringContains

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

Prüft, ob ein Text an beliebiger Stelle einen anderen Text enthält. Groß- und Kleinschreibung müssen übereinstimmen; verwenden Sie StringToLower für beide, um ohne Beachtung der Groß-/Kleinschreibung zu prüfen.

Parameter

• text: Text — Der zu durchsuchende Text.
• search: Text — Der gesuchte Text.

Rückgabe

true, wenn search in text vorkommt oder search leer ist; andernfalls false.

1 Beispiel: Vergleiche ohne Beachtung der Groß-/Kleinschreibung

StringEndsWith

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

Prüft, ob ein Text mit einem bestimmten Text endet, etwa einer Dateierweiterung. Groß- und Kleinschreibung müssen übereinstimmen.

Parameter

• text: Text — Der zu prüfende Text.
• suffix: Text — Das gesuchte Ende, etwa '.pdf'.

Rückgabe

true, wenn text mit suffix endet oder suffix leer ist; andernfalls false.

1 Beispiel: Dateitypen in einem Ordner zählen

StringFormat

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

Bildet Text, indem jedes {0} in format durch value0 und jedes {1} durch value1 ersetzt wird. So wandeln Sie eine Zahl, einen Bool-Wert oder ein Fenster in Text um.

Parameter

• format: Text — Der Text mit den Platzhaltern {0} und {1}. Es gibt kein {2}; verschachteln Sie Aufrufe für weitere Werte. {0} wird zuerst ersetzt, daher wird auch ein {1} innerhalb von value0 ersetzt.
• value0: Any — Der Wert für {0}, beliebiger Art.
• value1: Any — Der Wert für {1}, beliebiger Art. Übergeben Sie leeren Text, wenn format kein {1} enthält.

Rückgabe

Der Formattext mit ersetzten Platzhaltern. Ein Real wird mit sechs Nachkommastellen angezeigt; true und false werden als Wörter angezeigt.

50 Beispiele: Die fünf Werttypen, Zählschleifen: aufwärts, abwärts und in Schritten, Verschachtelte Schleifen: ein Einmaleins, while (true) mit einem Ende-Flag, Überraschungen bei der Rangfolge, && und || werten beide Seiten aus, Gleichheit über Typen hinweg, Arithmetik mit gemischten Typen ergibt 0, Kommentare, leere Anweisungen und Blöcke, Integer- und Real-Division sowie Division durch null, Rest ohne %, Runden und Real-Math-Funktionen, Einen Wert auf einen Bereich begrenzen, Zufallszahlen und ein Münzwurf, Länge eines Gestenstrichs, Einen Real ohne sechs Nachkommastellen formatieren, Flag-Masken: setzen, löschen, umschalten, prüfen, Die Pixelfarbe unter dem Mauszeiger lesen, Die gesetzten Bits zählen, Grenzfälle beim Verschieben, Zwei Integer vertauschen, Bits des Tastenzustands, Mehr als zwei Werte formatieren, Aufteilen und durchlaufen, Verschachteltes Aufteilen: Schlüssel=Wert-Paare, Letzter Index: eine Dateierweiterung, Eine Zahl mit Nullen auffüllen, Wörter in der Zwischenablage zählen, Textreihenfolge ist ordinal, Benannte Konstanten statt bloßer Zahlen, Sichtbare Fenster der obersten Ebene auflisten, Alle Fenster einer App minimieren, Fenster nach Titelmuster schließen, nach Bestätigung, Die untergeordneten Steuerelemente eines Fensters untersuchen, Vom Prozess zum Fenster, Beschreiben, was sich unter dem Mauszeiger befindet, Alles, was der Auslöserkontext weiß, An eine Protokolldatei anhängen, Eine Datei lesen und ihre Zeilen zählen, Dateitypen in einem Ordner zählen, Ein wiederholender Timer, der zählt, Ein Zähler, der einen Neustart übersteht, Eine in Storage gehaltene Liste, Lauter mit Bildschirmanzeige, Eine sich laufend aktualisierende Anzeigemeldung, Eine Windows-Benachrichtigung, Monitore auflisten, Zustand der Engine, Snippets als wiederverwendbare Funktionen, Den Anschluss eines Arduino offen halten und ihm Befehle senden

StringFromNumber

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

Wandelt eine Zahl in Text um, entweder im regionalen Format des Benutzers mit Zifferngruppierung zur Anzeige oder in einem festen Maschinenformat für Dateien und Geräte.

Parameter

• number: Any — Der umzuwandelnde Integer oder Real.
• decimals: Integer — Wie viele Stellen nach dem Dezimaltrennzeichen, 0 bis 15, gerundet; oder -1 für so viele, wie der Wert benötigt (keine bei einem Integer).
• invariantCulture: Bool — true für Maschinentext: ein Punkt als Dezimaltrennzeichen, keine Gruppierung, mit StringToNumber(text, true) wieder lesbar. false für das regionale Format des Benutzers.

Rückgabe

Die Zahl als Text, etwa 1.234,50 oder 1234.5. Leerer Text, wenn ein Real keine endliche Zahl ist. Ein Wert, der keine Zahl ist, oder ein decimals außerhalb des Bereichs beendet die Aktion mit einem Fehler.

1 Beispiel: Eine eingegebene Zahl lesen

StringGetIndexOf

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

Findet, wo ein Text zum ersten Mal in einem anderen vorkommt. Groß- und Kleinschreibung müssen übereinstimmen. Positionen beginnen bei 0.

Parameter

• text: Text — Der zu durchsuchende Text.
• search: Text — Der gesuchte Text.

Rückgabe

Die nullbasierte Position des ersten Vorkommens, 0, wenn search leer ist, oder -1, wenn search nicht in text vorkommt.

1 Beispiel: && und || werten beide Seiten aus

StringGetLength

StringGetLength(text: Text) → Integer

Gibt die Anzahl der Zeichen in text zurück, einschließlich Leerzeichen und Zeilenumbrüchen. Die von StringGetSubstring verwendeten Positionen zählen auf dieselbe Weise.

Parameter

• text: Text — Der zu messende Text.

Rückgabe

Die Zeichenanzahl oder 0 für leeren Text. Manche Emojis und seltene Zeichen zählen als 2.

3 Beispiele: Letzter Index: eine Dateierweiterung, Eine Zahl mit Nullen auffüllen, Text umkehren

StringGetSplitPartAt

StringGetSplitPartAt(index: Integer) → Text

Gibt einen Teil aus dem letzten Aufruf von StringSplit in diesem Skriptlauf zurück.

Parameter

• index: Integer — Die nullbasierte Teilnummer, von 0 bis zu der von StringSplit zurückgegebenen Anzahl minus 1.

Rückgabe

Der Text des Teils oder leerer Text, wenn index außerhalb des Bereichs liegt oder StringSplit in diesem Lauf nicht aufgerufen wurde.

6 Beispiele: break und continue, Aufteilen und durchlaufen, Verschachteltes Aufteilen: Schlüssel=Wert-Paare, Wörter in der Zwischenablage zählen, Zeilen der Zwischenablage zu einer Zeile verbinden, Eine Datei lesen und ihre Zeilen zählen

StringGetSubstring

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

Gibt einen Teil von text zurück: bis zu length Zeichen ab Position start. Positionen beginnen bei 0.

Parameter

• text: Text — Der Text, aus dem der Teil entnommen wird.
• start: Integer — Die nullbasierte Position des ersten zu entnehmenden Zeichens. Darf nicht negativ sein.
• length: Integer — Die Höchstzahl der zu entnehmenden Zeichen. Darf nicht negativ sein.

Rückgabe

Der angeforderte Teil, kürzer, wenn text vorher endet, oder leerer Text, wenn start am oder hinter dem Ende liegt. Ein negativer Wert für start oder length beendet die Aktion mit einem Fehler.

4 Beispiele: && und || werten beide Seiten aus, Integer in Hex-Text, Letzter Index: eine Dateierweiterung, Text umkehren

StringIsNumber

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

Prüft, ob text eine Zahl ist, die StringToNumber lesen kann, etwa eine Eingabe des Benutzers in UIShowInputBox. Leerzeichen um die Zahl werden ignoriert.

Parameter

• text: Text — Der zu prüfende Text.
• invariantCulture: Bool — true für Maschinentext: ein Punkt als Dezimaltrennzeichen und keine Zifferngruppierung. false für das regionale Format des Benutzers, wie ein Mensch es eingeben würde; Zifferngruppen müssen dann den Gruppengrößen dieses Formats folgen.

Rückgabe

true, wenn text eine Zahl im gewählten Format ist; andernfalls false, auch bei leerem Text.

2 Beispiele: Eine eingegebene Zahl lesen, Einen Arduino-Drehknopf zum Lautstärkeregler machen

StringRegexGetGroupAt

StringRegexGetGroupAt(index: Integer) → Text

Gibt die gesamte Übereinstimmung oder eine Erfassungsgruppe aus dem letzten erfolgreichen Aufruf von StringRegexMatch in diesem Skriptlauf zurück.

Parameter

• index: Integer — 0 für die gesamte Übereinstimmung; 1 und höher für die Erfassungsgruppen, in der Reihenfolge ihrer öffnenden Klammern. Benannte Gruppen werden ebenfalls nummeriert.

Rückgabe

Der übereinstimmende Text oder leerer Text, wenn index außerhalb des Bereichs liegt, die Gruppe an der Übereinstimmung nicht beteiligt war oder das letzte StringRegexMatch keine Übereinstimmung gefunden hat.

1 Beispiel: Mit einem regulären Ausdruck einen Wert aus kopiertem Text holen

StringRegexMatch

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

Prüft, ob ein regulärer Ausdruck (PCRE2-Syntax) an beliebiger Stelle in text passt, und merkt sich die Übereinstimmung und ihre Gruppen für StringRegexGetGroupAt.

Parameter

• text: Text — Der zu durchsuchende Text.
• pattern: Text — Der reguläre Ausdruck. Groß-/Kleinschreibung wird beachtet; beginnen Sie ihn mit (?i), um sie zu ignorieren. Zeichenklassen wie Wort und Ziffer folgen Unicode.

Rückgabe

true, wenn das Muster passt; andernfalls false. Ein ungültiges Muster oder eines, das für diesen Text zu viele Schritte benötigt, beendet die Aktion mit einem Fehler.

1 Beispiel: Mit einem regulären Ausdruck einen Wert aus kopiertem Text holen

StringRegexReplace

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

Ersetzt jede Übereinstimmung eines regulären Ausdrucks (PCRE2-Syntax) in text durch einen Ersatz, der die übereinstimmenden Gruppen enthalten kann.

Parameter

• text: Text — Der zu ändernde Text.
• pattern: Text — Der reguläre Ausdruck. Groß-/Kleinschreibung wird beachtet; beginnen Sie ihn mit (?i), um sie zu ignorieren.
• replacement: Text — Der Text, der an die Stelle jeder Übereinstimmung tritt. $1 oder ${1} fügt Gruppe 1 ein, ${name} eine benannte Gruppe, $0 die gesamte Übereinstimmung und $$ ein literales Dollarzeichen.

Rückgabe

Der Text mit allen Übereinstimmungen ersetzt oder text unverändert, wenn nichts passt. Ein ungültiges Muster oder ein ungültiger Ersatz, zu viele Schritte oder ein Ergebnis mit mehr als 16 Millionen Zeichen beendet die Aktion mit einem Fehler.

1 Beispiel: Mit einem regulären Ausdruck einen Wert aus kopiertem Text holen

StringReplace

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

Ersetzt jedes Vorkommen eines Textes durch einen anderen. Groß- und Kleinschreibung müssen übereinstimmen. Die Suche ist literaler Text, kein Muster.

Parameter

• text: Text — Der zu ändernde Text.
• search: Text — Der zu suchende Text. Darf nicht leer sein.
• replacement: Text — Der Text, der an seine Stelle tritt. Darf leer sein, um jedes Vorkommen zu entfernen.

Rückgabe

Der Text mit allen Vorkommen ersetzt oder text unverändert, wenn search nicht vorkommt. Ein leeres search beendet die Aktion mit einem Fehler.

3 Beispiele: Wörter in der Zwischenablage zählen, Eine Vorlage füllen und einfügen, Im Web nach der Markierung suchen

StringSplit

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

Teilt text an jedem Vorkommen eines Trennzeichens in Teile und merkt sich die Teile für StringGetSplitPartAt. Aufeinanderfolgende Trennzeichen oder eines an einem der Enden ergeben leere Teile.

Parameter

• text: Text — Der zu teilende Text.
• delimiter: Text — Der literale Text, an dem geteilt wird, etwa ',' oder ein Zeilenumbruch. Darf nicht leer sein.

Rückgabe

Die Anzahl der Teile, mindestens 1. Ein leeres Trennzeichen beendet die Aktion mit einem Fehler.

6 Beispiele: break und continue, Aufteilen und durchlaufen, Verschachteltes Aufteilen: Schlüssel=Wert-Paare, Wörter in der Zwischenablage zählen, Zeilen der Zwischenablage zu einer Zeile verbinden, Eine Datei lesen und ihre Zeilen zählen

StringStartsWith

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

Prüft, ob ein Text mit einem bestimmten Text beginnt. Groß- und Kleinschreibung müssen übereinstimmen.

Parameter

• text: Text — Der zu prüfende Text.
• prefix: Text — Der gesuchte Anfang.

Rückgabe

true, wenn text mit prefix beginnt oder prefix leer ist; andernfalls false.

2 Beispiele: break und continue, Eine Datei lesen und ihre Zeilen zählen

StringToLower

StringToLower(text: Text) → Text

Wandelt Text in Kleinbuchstaben um und folgt dabei den Regeln des regionalen Windows-Formats des Benutzers (etwa dem türkischen i mit und ohne Punkt).

Parameter

• text: Text — Der umzuwandelnde Text.

Rückgabe

Der Text in Kleinbuchstaben oder text unverändert, wenn Windows ihn nicht umwandeln kann.

4 Beispiele: Vergleiche ohne Beachtung der Groß-/Kleinschreibung, Textreihenfolge ist ordinal, Eine nicht erkannte Zeichnung durchlassen, Dateitypen in einem Ordner zählen

StringToNumber

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

Liest eine Zahl aus Text, etwa aus einer Benutzereingabe, einer Datei oder einem seriellen Gerät. Leerzeichen um die Zahl werden ignoriert; ein Exponent wie 1.5e3 ist zulässig.

Parameter

• text: Text — Der zu lesende Text.
• invariantCulture: Bool — true für Maschinentext: ein Punkt als Dezimaltrennzeichen und keine Zifferngruppierung, daher ist '1,5' keine Zahl. false für das regionale Format des Benutzers, wie ein Mensch es eingeben würde; Zifferngruppen müssen dann diesem Format folgen, daher wird '1.234,5' unter Deutsch (Deutschland) gelesen, '1.5' aber nicht.

Rückgabe

Ein Integer, wenn der Text kein Dezimaltrennzeichen und keinen Exponenten hat und in den Wertebereich passt, andernfalls ein Real. 0, wenn der Text keine Zahl ist; prüfen Sie zuerst mit StringIsNumber.

2 Beispiele: Eine eingegebene Zahl lesen, Einen Arduino-Drehknopf zum Lautstärkeregler machen

StringToUpper

StringToUpper(text: Text) → Text

Wandelt Text in Großbuchstaben um und folgt dabei den Regeln des regionalen Windows-Formats des Benutzers (etwa dem türkischen i mit und ohne Punkt).

Parameter

• text: Text — Der umzuwandelnde Text.

Rückgabe

Der Text in Großbuchstaben oder text unverändert, wenn Windows ihn nicht umwandeln kann.

2 Beispiele: Den markierten Text in Großbuchstaben umwandeln, Eine Datei vor dem Bearbeiten sichern

StringTrim

StringTrim(text: Text) → Text

Entfernt Leerzeichen, Tabulatoren, Zeilenumbrüche und anderen Leerraum am Anfang und Ende von text. Leerraum innerhalb des Textes bleibt erhalten.

Parameter

• text: Text — Der zu kürzende Text.

Rückgabe

Der gekürzte Text oder leerer Text, wenn text nur aus Leerraum bestand.

6 Beispiele: Wörter in der Zwischenablage zählen, Zeilen der Zwischenablage zu einer Zeile verbinden, Im Web nach dem markierten Text suchen, Im Web nach der Markierung suchen, Eine Datei lesen und ihre Zeilen zählen, Tasten eines seriellen Geräts Medientasten zuordnen

StringUrlEncode

StringUrlEncode(text: Text) → Text · Einfach

Codiert Text so, dass er in einer Webadresse stehen kann, etwa ein aus dem markierten Text gebildeter Suchbegriff. Codieren Sie nur den Wert, nicht die ganze Adresse.

Parameter

• text: Text — Der zu codierende Text, etwa ein Suchbegriff.

Rückgabe

Der codierte Text: Buchstaben, Ziffern und - . _ ~ bleiben unverändert; jedes andere Byte des UTF-8-Textes wird zu einer Prozent-Escapesequenz mit zwei Hexadezimalziffern. Ein Leerzeichen wird zu einem Prozentzeichen gefolgt von 20, nicht zu einem Pluszeichen.

1 Beispiel: Im Web nach dem markierten Text suchen

Style

StyleGetCurrent

StyleGetCurrent() → Text · Einfach

Gibt den Schlüssel des Spurstils zurück, den das Renderer-Plug-in gerade zeichnet, etwa neonglow, oder shuffle, wenn Zufallsmix ausgewählt ist.

Parameter

Keine Parameter.

Rückgabe

Der Schlüssel des Stils, der Standardstil des Renderers, wenn nichts Verwendbares ausgewählt ist, oder leerer Text, wenn kein Renderer läuft oder er seine Stile noch nicht gemeldet hat.

StyleNext

StyleNext() → Bool · Einfach

Wählt den nächsten freigeschalteten Spurstil in der Liste des Renderers aus und beginnt am Ende wieder von vorn. Der neue Stil wird ab der nächsten Geste gezeichnet.

Parameter

Keine Parameter.

Rückgabe

true, wenn ein Stilwechsel angefordert wurde; false, wenn kein Renderer läuft oder kein anderer Stil zur Auswahl steht.

StyleSet

StyleSet(key: Text) → Bool · Einfach

Wählt den Spurstil des Renderers mit diesem Schlüssel aus, gezeichnet ab der nächsten Geste. Eine Zeichentaste mit eigenem Stil behält diesen.

Parameter

• key: Text — Der Schlüssel des Stils, etwa neonglow oder auto; Groß-/Kleinschreibung wird nicht beachtet. Verwenden Sie shuffle für einen anderen Stil bei jeder Geste.

Rückgabe

true, wenn der Stilwechsel angefordert wurde; false, wenn kein Renderer läuft, kein Stil diesen Schlüssel hat oder der Stil gesperrt ist.

System

SystemHibernate

SystemHibernate() → Bool · Einfach

Versetzt den Computer ohne Rückfrage in den Ruhezustand. Das Skript wartet hier und wird fortgesetzt, nachdem der Computer wieder eingeschaltet wurde. Bewirkt nichts, wenn der Ruhezustand in Windows ausgeschaltet ist.

Parameter

Keine Parameter.

Rückgabe

true, nachdem der Computer im Ruhezustand war und fortgesetzt wurde; false, wenn der Ruhezustand nicht verfügbar ist oder Windows abgelehnt hat.

SystemLock

SystemLock() → Bool · Einfach

Sperrt den Computer und zeigt den Windows-Anmeldebildschirm an, wie Windows+L. Apps laufen weiter.

Parameter

Keine Parameter.

Rückgabe

true, wenn Windows den Computer gesperrt hat; false, wenn Windows abgelehnt hat, etwa weil eine Richtlinie das Sperren deaktiviert.

SystemMonitorOff

SystemMonitorOff() → Bool · Einfach

Schaltet die Monitore aus. Die nächste Mausbewegung oder der nächste Tastendruck schaltet sie wieder ein; ein durch eine Geste gestartetes Skript sollte daher zuerst UtilityWait(500) aufrufen.

Parameter

Keine Parameter.

Rückgabe

true, sobald die Anforderung an Windows gesendet wurde; false, wenn sie nicht gesendet werden konnte.

SystemRestart

SystemRestart(force: Bool) → Bool · Einfach

Startet den Computer ohne Bestätigung neu; Windows schließt zuerst die laufenden Apps. Zeigen Sie vorher UIShowMessageBox an, wenn Sie eine Bestätigung wünschen.

Parameter

• force: Bool — false lässt Apps nachfragen, ob nicht gespeicherte Arbeit gespeichert werden soll (nur nicht reagierende Apps werden zwangsweise geschlossen); true schließt alle Apps sofort, und nicht gespeicherte Arbeit geht verloren.

Rückgabe

true, wenn Windows die Neustartanforderung angenommen hat (sie läuft dann selbstständig weiter); false, wenn Windows sie abgelehnt hat.

SystemShutDown

SystemShutDown(force: Bool) → Bool · Einfach

Fährt den Computer ohne Bestätigung herunter und schaltet ihn aus. Zeigen Sie vorher UIShowMessageBox an, wenn Sie eine Bestätigung wünschen.

Parameter

• force: Bool — false lässt Apps nachfragen, ob nicht gespeicherte Arbeit gespeichert werden soll (nur nicht reagierende Apps werden zwangsweise geschlossen); true schließt alle Apps sofort, und nicht gespeicherte Arbeit geht verloren.

Rückgabe

true, wenn Windows die Anforderung zum Herunterfahren angenommen hat (sie läuft dann selbstständig weiter); false, wenn Windows sie abgelehnt hat.

SystemSignOut

SystemSignOut(force: Bool) → Bool · Einfach

Meldet den aktuellen Benutzer ohne Bestätigung von Windows ab und schließt dabei alle Apps und auch Input.Observer.

Parameter

• force: Bool — false lässt Apps nachfragen, ob nicht gespeicherte Arbeit gespeichert werden soll (nur nicht reagierende Apps werden zwangsweise geschlossen); true schließt alle Apps sofort, und nicht gespeicherte Arbeit geht verloren.

Rückgabe

true, wenn Windows die Abmeldeanforderung angenommen hat (sie läuft dann selbstständig weiter); false, wenn Windows sie abgelehnt hat.

SystemSleep

SystemSleep() → Bool · Einfach

Versetzt den Computer ohne Rückfrage in den Energiesparmodus. Das Skript wartet hier und wird fortgesetzt, nachdem der Computer reaktiviert wurde. Auf einem Computer mit Modern Standby bewirkt dies nichts; verwenden Sie dort SystemMonitorOff.

Parameter

Keine Parameter.

Rückgabe

true, nachdem der Computer im Energiesparmodus war und reaktiviert wurde; false, wenn dieser Computer keinen Energiesparzustand hat, den ein Programm auslösen kann, oder Windows abgelehnt hat.

Timer

TimerCreate

TimerCreate(name: Text, startDelayMs: Integer, intervalMs: Integer, repeatCount: Integer, script: Text) → Bool

Erstellt einen benannten Timer, der Skripttext nach einer Verzögerung und danach in festem Intervall ausführt, oder ersetzt den Timer mit diesem Namen. Timer laufen nach dem Ende des Skripts weiter, bis sie gelöscht werden oder die Engine beendet wird.

Parameter

• name: Text — Ein Name für den Timer, der von TimerDelete verwendet wird. Groß-/Kleinschreibung wird beachtet; ein vorhandener Timer mit diesem Namen wird ersetzt.
• startDelayMs: Integer — Verzögerung vor der ersten Ausführung, in Millisekunden; 0 oder mehr.
• intervalMs: Integer — Zeit zwischen den Ausführungen, in Millisekunden; 1 oder mehr. Eine Ausführung wartet nicht, bis die vorherige fertig ist.
• repeatCount: Integer — Wie oft insgesamt ausgeführt wird; 0 wiederholt, bis der Timer gelöscht wird.
• script: Text — Der bei jedem Takt auszuführende Skripttext. Er läuft eigenständig, ohne Auslöserkontext und ohne die Variablen dieses Skripts.

Rückgabe

true, sobald der Timer eingerichtet ist. Ein negativer Wert für startDelayMs oder repeatCount oder ein intervalMs unter 1 beendet das Skript mit einem Fehler.

2 Beispiele: Ein wiederholender Timer, der zählt, Timerskript aus einem Snippet, ohne Escapes

TimerDelete

TimerDelete(name: Text) → Bool

Entfernt den Timer mit diesem Namen, sodass er nicht erneut ausgeführt wird.

Parameter

• name: Text — Der Name des Timers, wie er an TimerCreate übergeben wurde. Groß-/Kleinschreibung wird beachtet.

Rückgabe

true, wenn der Timer existierte und entfernt wurde; false, wenn es keinen Timer mit diesem Namen gab.

1 Beispiel: Timer auflisten und beenden

TimerDeleteAll

TimerDeleteAll() → Bool

Entfernt alle mit TimerCreate erstellten Timer, sodass keiner davon erneut ausgeführt wird.

Parameter

Keine Parameter.

Rückgabe

Immer true.

1 Beispiel: Timer auflisten und beenden

TimerEnumerateAll

TimerEnumerateAll() → Integer

Erstellt eine Liste der Namen aller aktuellen Timer und gibt ihre Anzahl zurück. Lesen Sie jeden Namen mit TimerGetEnumeratedNameAt.

Parameter

Keine Parameter.

Rückgabe

Die Anzahl der Timer oder 0, wenn es keine gibt.

1 Beispiel: Timer auflisten und beenden

TimerGetEnumeratedNameAt

TimerGetEnumeratedNameAt(index: Integer) → Text

Gibt einen Timernamen aus der Liste zurück, die TimerEnumerateAll zuletzt in diesem Skript erstellt hat.

Parameter

• index: Integer — Nullbasierte Position in der Liste, von 0 bis zur Anzahl minus 1. Die Reihenfolge hat keine Bedeutung.

Rückgabe

Der Name des Timers oder leerer Text, wenn index außerhalb des Bereichs liegt oder TimerEnumerateAll nicht aufgerufen wurde.

1 Beispiel: Timer auflisten und beenden

Tray

TrayMinimizeWindow

TrayMinimizeWindow(window: Window) → Bool

Blendet ein Fenster aus und zeigt dafür ein Symbol im Infobereich mit dem eigenen Symbol und Titel des Fensters an. Ein Klick auf das Symbol stellt das Fenster an seiner bisherigen Stelle wieder her. Bei einem Steuerelement wird dessen Fenster der obersten Ebene ausgeblendet.

Parameter

• window: Window — Das auszublendende Fenster, etwa ContextGetWindow().

Rückgabe

true, wenn die Anforderung angenommen wurde; false für ein Null-Fenster oder ein Fenster, das nicht mehr existiert.

1 Beispiel: Ein Fenster im Infobereich verstecken

TrayRestoreAllWindows

TrayRestoreAllWindows() → Bool

Stellt alle mit TrayMinimizeWindow ausgeblendeten Fenster wieder her und entfernt ihre Symbole aus dem Infobereich.

Parameter

Keine Parameter.

Rückgabe

true, wenn die Anforderung gesendet wurde; false, wenn die Engine noch nicht vollständig gestartet ist.

UI

UIClearPrintLog

UIClearPrintLog() → Bool

Leert die Registerkarte Benutzer der Diagnosekonsole, auf der die Ausgabe von UtilityPrint erscheint, einschließlich der Ausgabe, die bei geschlossener Konsole gespeichert wurde.

Parameter

Keine Parameter.

Rückgabe

Immer true.

UICloseDisplayMessage

UICloseDisplayMessage(sessionId: Integer) → Bool

Schließt eine mit UIShowDisplayMessage geöffnete Bildschirmmeldung. Bewirkt nichts, wenn diese Meldung bereits geschlossen ist.

Parameter

• sessionId: Integer — Die ID, die UIShowDisplayMessage für die zu schließende Meldung zurückgegeben hat.

Rückgabe

Immer true, auch wenn die Meldung bereits geschlossen war.

1 Beispiel: Eine sich laufend aktualisierende Anzeigemeldung

UIGetCulture

UIGetCulture() → Text

Gibt die Sprache und Region zurück, die Input.Observer für seine eigenen Texte verwendet (Infobereichsmenü, Meldungen, Fehlertexte), wie durch UISetCulture, die Spracheinstellung oder Windows festgelegt.

Parameter

Keine Parameter.

Rückgabe

Der Kulturname, wie er gesetzt wurde, etwa en-US oder de-AT, auch wenn die Übersetzung einer anderen Region stellvertretend verwendet wird.

UISetCulture

UISetCulture(culture: Text) → Bool

Wechselt die Sprache, die Input.Observer für seine eigenen Texte verwendet (Infobereichsmenü, Meldungen, Fehlertexte), bis es beendet wird oder sich die Spracheinstellung ändert. Ändert weder das Einstellungsfenster noch die gespeicherte Einstellung.

Parameter

• culture: Text — Ein Kulturname wie en-US, de-DE oder es-MX.

Rückgabe

true, wenn die Kultur angewendet wurde; false, und die Sprache bleibt unverändert, wenn culture keine Windows bekannte Kultur ist oder Input.Observer keine Übersetzung in ihrer Sprache hat. Eine andere Region einer übersetzten Sprache, etwa de-AT, wird akzeptiert.

UIShowConsole

UIShowConsole() → Bool

Öffnet die Diagnosekonsole oder holt sie in den Vordergrund, wenn sie bereits geöffnet ist, und wartet, bis sie geöffnet ist. Ist die Konfiguration kennwortgeschützt, wird gewartet, während das Kennwort abgefragt wird. Nur die eigene Schließen-Schaltfläche der Konsole schließt sie.

Parameter

Keine Parameter.

Rückgabe

true, sobald die Konsole geöffnet ist; false, wenn sie nicht geöffnet wurde, etwa weil die Kennwortabfrage abgebrochen wurde oder der gespeicherte Zustand der Konsole nicht gelesen werden kann.

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 · Einfach

Zeigt ein Feld mit einer Titelzeile und einer Meldungszeile an einer festen Stelle auf dem Bildschirm an und kehrt sofort zurück. Mehrere können gleichzeitig geöffnet sein; behalten Sie die zurückgegebene ID, um dieses Feld zu aktualisieren oder zu schließen.

Parameter

• title: Text — Text der oberen Zeile, gezeichnet in der Titelschriftart. Leerer Text lässt die Zeile weg.
• message: Text — Text der zweiten Zeile, gezeichnet in der Meldungsschriftart. Langer Text wird auf weitere Zeilen umbrochen. Leerer Text lässt die Zeile weg.
• durationMs: Integer — Wie lange das Feld angezeigt bleibt, in Millisekunden. 0 oder weniger behält es, bis UICloseDisplayMessage es schließt (das integrierte Feld schließt sich auch bei einem Doppelklick).
• opacity: Real — Wie deckend das Feld ist, von 0.05 (fast unsichtbar) bis 1.0 (vollständig deckend). Werte außerhalb dieses Bereichs werden begrenzt.
• location: Any — Wo es angezeigt wird: eine Location-Konstante wie Location.BottomCenter (innerhalb des nicht von der Taskleiste verdeckten Bildschirmbereichs platziert) oder Text 'x,y' ohne Leerzeichen für die obere linke Ecke des Felds in Bildschirmpixeln, etwa '100,200'. Alles andere beendet die Aktion mit einem Fehler.
• titleFontFamily: Text — Schriftartname für die Titelzeile, etwa Segoe UI.
• titleFontSizePt: Integer — Schriftgröße des Titels in Punkt. Werte unter 1 zählen als 1.
• titleBold: Bool — true, um die Titelzeile fett zu zeichnen.
• titleItalic: Bool — true, um die Titelzeile kursiv zu zeichnen.
• messageFontFamily: Text — Schriftartname für die Meldungszeile, etwa Segoe UI.
• messageFontSizePt: Integer — Schriftgröße der Meldung in Punkt. Werte unter 1 zählen als 1.
• messageBold: Bool — true, um die Meldungszeile fett zu zeichnen.
• messageItalic: Bool — true, um die Meldungszeile kursiv zu zeichnen.
• foreColor: Text — Textfarbe für beide Zeilen: ein Farbname wie white oder black, '#RRGGBB' oder 'R,G,B' mit jeder Zahl von 0 bis 255 und ohne Leerzeichen. Alles andere beendet die Aktion mit einem Fehler.
• backColor: Text — Hintergrundfarbe, in denselben Formen wie foreColor, etwa '#F7F7F5'. Verwenden Sie opacity, nicht die Farbe, um das Feld durchsichtig zu machen.
• paddingPx: Integer — Leerraum um den Text, in Pixeln bei 100 Prozent Anzeigeskalierung; er wächst mit der Anzeigeskalierung. Werte unter 0 zählen als 0.
• usePrimaryScreen: Bool — true, um eine Location auf dem primären Monitor zu platzieren; false, um den Monitor zu verwenden, auf dem sich der Mauszeiger gerade befindet. Wird bei einer 'x,y'-Position ignoriert.
• titleAlign: Integer — Wie die Titelzeile ausgerichtet wird: TextAlign.Left, TextAlign.Center oder TextAlign.Right. Jeder andere Wert beendet die Aktion mit einem Fehler.
• messageAlign: Integer — Wie die Meldungszeile ausgerichtet wird: TextAlign.Left, TextAlign.Center oder TextAlign.Right. Jeder andere Wert beendet die Aktion mit einem Fehler.

Rückgabe

Die Sitzungs-ID der Meldung, immer größer als 0, für UIUpdateDisplayMessage und UICloseDisplayMessage. Eine ID wird auch zurückgegeben, wenn Meldungen in den Einstellungen ausgeschaltet sind und nichts erscheint.

2 Beispiele: Lauter mit Bildschirmanzeige, Eine sich laufend aktualisierende Anzeigemeldung

UIShowInputBox

UIShowInputBox(prompt: Text, title: Text, defaultText: Text) → Text · Einfach

Zeigt ein Dialogfeld an, in das der Benutzer eine Textzeile eingeben soll, mit den Schaltflächen OK und Abbrechen. Blockiert das Skript, bis das Dialogfeld geschlossen wird, und gibt dann den Fokus an das Fenster zurück, das ihn hatte.

Parameter

• prompt: Text — Die über dem Textfeld angezeigte Frage. Text mit mehr als 2000 Zeichen wird abgeschnitten.
• title: Text — In der Titelleiste des Dialogfelds angezeigter Titel.
• defaultText: Text — Text, der beim Öffnen des Dialogfelds bereits im Feld steht, markiert, sodass Tippen ihn ersetzt. Verwenden Sie leeren Text für ein leeres Feld.

Rückgabe

Der eingegebene Text, wenn der Benutzer auf OK klickt (bis zu 4096 Zeichen), oder leerer Text bei Abbrechen, Esc oder der Schließen-Schaltfläche. Ein leeres OK gibt ebenfalls leeren Text zurück.

2 Beispiele: Eine eingegebene Zahl lesen, Eine Geste, mehrere Möglichkeiten

UIShowMenu

UIShowMenu(items: Text) → Integer · Einfach

Zeigt ein Popupmenü am Mauszeiger an, sodass eine Geste oder ein Hotkey mehrere Auswahlmöglichkeiten bieten kann. Blockiert das Skript, bis der Benutzer ein Element wählt oder das Menü schließt.

Parameter

• items: Text — Die Menüelemente, eines pro Zeile. Eine Zeile, die nur - enthält, ist eine Trennlinie; leere Zeilen werden übersprungen. 1 bis 100 Elemente, sonst wird die Aktion mit einem Fehler beendet; ein Element mit mehr als 260 Zeichen wird abgeschnitten. Setzen Sie & vor einen Buchstaben, um ihn zur Zugriffstaste des Elements zu machen; && zeigt ein einzelnes & an.

Rückgabe

Die nullbasierte Position des gewählten Elements, wobei nur Elemente gezählt werden (keine Trennlinien), oder -1, wenn das Menü geschlossen wurde oder nicht angezeigt werden konnte.

1 Beispiel: Eine Geste, mehrere Möglichkeiten

UIShowMessageBox

UIShowMessageBox(message: Text, title: Text, buttons: Text, icon: Text) → Text · Einfach

Zeigt ein Standard-Meldungsfeld von Windows vor anderen Fenstern an und wartet, bis der Benutzer eine Schaltfläche drückt. Blockiert das Skript, bis das Meldungsfeld geschlossen wird.

Parameter

• message: Text — Der im Meldungsfeld angezeigte Meldungstext.
• title: Text — In der Titelleiste des Meldungsfelds angezeigter Titel.
• buttons: Text — Welche Schaltflächen angezeigt werden, genau so geschrieben: OK, OKCancel, YesNo, YesNoCancel, RetryCancel oder AbortRetryIgnore. Alles andere beendet die Aktion mit einem Fehler.
• icon: Text — Welches Symbol angezeigt wird, genau so geschrieben: None, Information, Warning, Error oder Question. Alles andere beendet die Aktion mit einem Fehler.

Rückgabe

Die gedrückte Schaltfläche: OK, Cancel, Yes, No, Retry, Abort oder Ignore (Schließen mit Esc oder der Schließen-Schaltfläche gibt Cancel zurück, wenn es eine Abbrechen-Schaltfläche gibt). Leerer Text, wenn das Meldungsfeld nicht angezeigt werden konnte.

3 Beispiele: Eine eingegebene Zahl lesen, Fenster nach Titelmuster schließen, nach Bestätigung, Eine Frage stellen

UIShowSettings

UIShowSettings() → Bool · Einfach

Öffnet das Einstellungsfenster von Input.Observer oder holt es in den Vordergrund, wenn es bereits geöffnet ist. Kehrt zurück, ohne zu warten, bis das Fenster fertig geladen ist.

Parameter

Keine Parameter.

Rückgabe

true, wenn das Einstellungsfenster in den Vordergrund geholt oder gestartet wurde; false, wenn Input.Observer.UI.exe fehlt, nicht gestartet werden konnte oder die Engine nicht innerhalb von 3 Sekunden geantwortet hat.

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

Ersetzt alle Eigenschaften eines geöffneten UIShowDisplayMessage-Felds (Text, Position, Schriftarten, Farben und Dauer) durch neue Werte. Die Dauer beginnt mit diesem Aufruf neu.

Parameter

• sessionId: Integer — Die ID, die UIShowDisplayMessage für die zu ändernde Meldung zurückgegeben hat.
• title: Text — Neuer Text der oberen Zeile, gezeichnet in der Titelschriftart. Leerer Text lässt die Zeile weg.
• message: Text — Neuer Text der zweiten Zeile, gezeichnet in der Meldungsschriftart. Langer Text wird auf weitere Zeilen umbrochen. Leerer Text lässt die Zeile weg.
• durationMs: Integer — Wie lange das Feld ab jetzt angezeigt bleibt, in Millisekunden. 0 oder weniger behält es, bis UICloseDisplayMessage es schließt (das integrierte Feld schließt sich auch bei einem Doppelklick).
• opacity: Real — Wie deckend das Feld ist, von 0.05 (fast unsichtbar) bis 1.0 (vollständig deckend). Werte außerhalb dieses Bereichs werden begrenzt.
• location: Any — Wo es angezeigt wird: eine Location-Konstante wie Location.BottomCenter (innerhalb des nicht von der Taskleiste verdeckten Bildschirmbereichs platziert) oder Text 'x,y' ohne Leerzeichen für die obere linke Ecke des Felds in Bildschirmpixeln, etwa '100,200'. Alles andere beendet die Aktion mit einem Fehler.
• titleFontFamily: Text — Schriftartname für die Titelzeile, etwa Segoe UI.
• titleFontSizePt: Integer — Schriftgröße des Titels in Punkt. Werte unter 1 zählen als 1.
• titleBold: Bool — true, um die Titelzeile fett zu zeichnen.
• titleItalic: Bool — true, um die Titelzeile kursiv zu zeichnen.
• messageFontFamily: Text — Schriftartname für die Meldungszeile, etwa Segoe UI.
• messageFontSizePt: Integer — Schriftgröße der Meldung in Punkt. Werte unter 1 zählen als 1.
• messageBold: Bool — true, um die Meldungszeile fett zu zeichnen.
• messageItalic: Bool — true, um die Meldungszeile kursiv zu zeichnen.
• foreColor: Text — Textfarbe für beide Zeilen: ein Farbname wie white oder black, '#RRGGBB' oder 'R,G,B' mit jeder Zahl von 0 bis 255 und ohne Leerzeichen. Alles andere beendet die Aktion mit einem Fehler.
• backColor: Text — Hintergrundfarbe, in denselben Formen wie foreColor, etwa '#F7F7F5'. Verwenden Sie opacity, nicht die Farbe, um das Feld durchsichtig zu machen.
• paddingPx: Integer — Leerraum um den Text, in Pixeln bei 100 Prozent Anzeigeskalierung; er wächst mit der Anzeigeskalierung. Werte unter 0 zählen als 0.
• usePrimaryScreen: Bool — true, um eine Location auf dem primären Monitor zu platzieren; false, um den Monitor zu verwenden, auf dem sich der Mauszeiger gerade befindet. Wird bei einer 'x,y'-Position ignoriert.
• titleAlign: Integer — Wie die Titelzeile ausgerichtet wird: TextAlign.Left, TextAlign.Center oder TextAlign.Right. Jeder andere Wert beendet die Aktion mit einem Fehler.
• messageAlign: Integer — Wie die Meldungszeile ausgerichtet wird: TextAlign.Left, TextAlign.Center oder TextAlign.Right. Jeder andere Wert beendet die Aktion mit einem Fehler.

Rückgabe

Immer true, auch wenn die Meldung bereits geschlossen war (der Aufruf bewirkt dann nichts).

1 Beispiel: Eine sich laufend aktualisierende Anzeigemeldung

Utility

UtilityGetTickCount

UtilityGetTickCount() → Integer

Gibt die Anzahl der Millisekunden seit dem Start von Windows zurück. Ziehen Sie zwei Messwerte voneinander ab, um eine verstrichene Zeit zu messen, etwa um eine doppelte Auslösung zu erkennen. Dies ist keine Uhr; verwenden Sie DateTimeGetNow für die Uhrzeit.

Parameter

Keine Parameter.

Rückgabe

Millisekunden seit dem Start von Windows, als Integer.

UtilityLockAcquire

UtilityLockAcquire(name: Text, timeoutSeconds: Integer) → Integer

Belegt eine benannte Sperre, sodass jeweils nur eine Aktion einen Skriptabschnitt ausführt. Blockiert das Skript, bis die Sperre frei ist oder timeoutSeconds abläuft. Die Sperre wird beim Ende des Skripts automatisch freigegeben.

Parameter

• name: Text — Der Name der Sperre, 1 bis 255 Zeichen, gemeinsam für alle Aktionen; Groß- und Kleinschreibung werden nicht unterschieden. Eine Sperre, die dieses Skript bereits hält, erneut zu belegen, ist zulässig und erfordert ein weiteres UtilityLockRelease.
• timeoutSeconds: Integer — Die maximale Wartezeit in Sekunden. 0 oder mehr als 24 Tage wartet, bis die Sperre frei ist oder die Aktion beendet wird. Ein negativer Wert beendet die Aktion mit einem Fehler.

Rückgabe

LockResult.Acquired, LockResult.TimedOut (auch wenn die Aktion während des Wartens beendet wird) oder sofort LockResult.Pinned, wenn die Sperre fixiert ist.

1 Beispiel: Nur eine Aktion gleichzeitig einen Abschnitt ausführen lassen

UtilityLockAcquirePinned

UtilityLockAcquirePinned(name: Text, timeoutSeconds: Integer) → Integer

Belegt eine benannte Sperre und fixiert sie, sodass sie nach dem Ende des Skripts belegt bleibt. Nur UtilityLockRelease aus demselben Skriptlauf oder ein Neuladen der Konfiguration gibt sie frei. Blockiert wie UtilityLockAcquire.

Parameter

• name: Text — Der Name der Sperre, 1 bis 255 Zeichen, gemeinsam für alle Aktionen; Groß- und Kleinschreibung werden nicht unterschieden. Eine Sperre, die dieses Skript bereits hält, wird fixiert.
• timeoutSeconds: Integer — Die maximale Wartezeit in Sekunden. 0 oder mehr als 24 Tage wartet, bis die Sperre frei ist oder die Aktion beendet wird. Ein negativer Wert beendet die Aktion mit einem Fehler.

Rückgabe

LockResult.Acquired, LockResult.TimedOut (auch wenn die Aktion während des Wartens beendet wird) oder sofort LockResult.Pinned, wenn die Sperre bereits fixiert ist.

UtilityLockGetState

UtilityLockGetState(name: Text) → Integer

Gibt an, ob eine benannte Sperre frei ist, von diesem Skript gehalten wird, von einer anderen Aktion gehalten wird oder fixiert ist. Wartet nie.

Parameter

• name: Text — Der Name der Sperre, 1 bis 255 Zeichen; Groß- und Kleinschreibung werden nicht unterschieden.

Rückgabe

LockState.Free, LockState.HeldByMe, LockState.HeldByOther oder LockState.Pinned. Eine fixierte Sperre meldet LockState.Pinned auch dem Skript, das sie fixiert hat.

UtilityLockRelease

UtilityLockRelease(name: Text) → Bool

Gibt eine benannte Sperre frei, die dieses Skript hält, oder hebt ihre Fixierung auf. Eine mehrfach belegte Sperre ist nach derselben Anzahl von Freigaben frei.

Parameter

• name: Text — Der Name der Sperre, 1 bis 255 Zeichen; Groß- und Kleinschreibung werden nicht unterschieden.

Rückgabe

true, wenn dieses Skript die Sperre gehalten hat; false, ohne etwas zu tun, wenn niemand sie hält oder eine andere Aktion sie hält.

1 Beispiel: Nur eine Aktion gleichzeitig einen Abschnitt ausführen lassen

UtilityPrint

UtilityPrint(text: Text) → Bool

Schreibt eine Textzeile in den Bereich Benutzer der Diagnosekonsole oder in die Ausgabe des Bereichs Skript, wenn das Skript von dort ausgeführt wird. Bei geschlossener Konsole ausgegebene Zeilen erscheinen, wenn sie das nächste Mal geöffnet wird.

Parameter

• text: Text — Der zu schreibende Text. Wandeln Sie eine Zahl zuerst mit StringFormat oder StringFromNumber in Text um.

Rückgabe

Immer true.

70 Beispiele: Hallo, Konsole, Die fünf Werttypen, Wahrheitswert jedes Typs, else-if-Kette, Zählschleifen: aufwärts, abwärts und in Schritten, Verschachtelte Schleifen: ein Einmaleins, while-Schleife: mit Zeitlimit auf ein Fenster warten, while (true) mit einem Ende-Flag, break und continue, Überraschungen bei der Rangfolge, && und || werten beide Seiten aus, Gleichheit über Typen hinweg, Arithmetik mit gemischten Typen ergibt 0, Kommentare, leere Anweisungen und Blöcke, Integer- und Real-Division sowie Division durch null, Rest ohne %, Runden und Real-Math-Funktionen, Einen Wert auf einen Bereich begrenzen, Zufallszahlen und ein Münzwurf, Länge eines Gestenstrichs, Einen Real ohne sechs Nachkommastellen formatieren, Flag-Masken: setzen, löschen, umschalten, prüfen, Die Pixelfarbe unter dem Mauszeiger lesen, Integer in Hex-Text, Die gesetzten Bits zählen, Grenzfälle beim Verschieben, Zwei Integer vertauschen, Bits des Tastenzustands, Escapesequenzen und Windows-Pfade, Mehr als zwei Werte formatieren, Aufteilen und durchlaufen, Verschachteltes Aufteilen: Schlüssel=Wert-Paare, Letzter Index: eine Dateierweiterung, Eine eingegebene Zahl lesen, Ein Programm starten, auf sein Fenster warten, darauf reagieren, Mit einem regulären Ausdruck einen Wert aus kopiertem Text holen, Eine Zahl mit Nullen auffüllen, Text umkehren, Wörter in der Zwischenablage zählen, Vergleiche ohne Beachtung der Groß-/Kleinschreibung, Textreihenfolge ist ordinal, Das heutige Datum und ein Dateiname mit Zeitstempel, Benannte Konstanten statt bloßer Zahlen, Sichtbare Fenster der obersten Ebene auflisten, Alle Fenster einer App minimieren, Die untergeordneten Steuerelemente eines Fensters untersuchen, Vom Prozess zum Fenster, Beschreiben, was sich unter dem Mauszeiger befindet, Alles, was der Auslöserkontext weiß, In welche Richtung ging der Strich?, Nach der Maustaste des Strichs verzweigen, Ein kopiertes Bild in einer Datei speichern, Eine Datei lesen und ihre Zeilen zählen, Dateitypen in einem Ordner zählen, Einen Ordner überwachen, Ein wiederholender Timer, der zählt, Timer auflisten und beenden, Ein Zähler, der einen Neustart übersteht, Eine in Storage gehaltene Liste, Nur eine Aktion gleichzeitig einen Abschnitt ausführen lassen, Eine Frage stellen, Umgebungsvariablen erweitern, An AutoHotkey übergeben, Monitore auflisten, Zustand der Engine, Snippets als wiederverwendbare Funktionen, Mit einem Plug-in kommunizieren, Ein serielles Gerät etwas fragen, Die COM-Anschlüsse auflisten, Den Anschluss eines Arduino offen halten und ihm Befehle senden

UtilityWait

UtilityWait(milliseconds: Integer) → Bool · Einfach

Hält das Skript für eine Anzahl von Millisekunden an, etwa damit ein Fenster oder die Zwischenablage nachziehen kann. Das Warten endet vorzeitig, wenn die Aktion beendet wird.

Parameter

• milliseconds: Integer — Wie lange gewartet wird, in Millisekunden, von 0 bis 60000 (eine Minute). Größere Werte warten eine Minute; negative Werte warten nicht.

Rückgabe

Immer true.

10 Beispiele: while-Schleife: mit Zeitlimit auf ein Fenster warten, Die Maus im Kreis bewegen, Eine Vorlage füllen und einfügen, Irgendwo klicken und dann den Mauszeiger zurücksetzen, Ein per Skript gesteuertes Ziehen, Den Mauszeiger 5 Sekunden lang auf ein Fenster beschränken, Medientasten, Den markierten Text in Großbuchstaben umwandeln, Im Web nach der Markierung suchen, Eine sich laufend aktualisierende Anzeigemeldung

Window

WindowCenterToScreen

WindowCenterToScreen(window: Window) → Bool · Einfach

Verschiebt ein Fenster so, dass es im Arbeitsbereich (dem Bildschirm ohne die Taskleiste) seines Monitors zentriert ist, und behält seine Größe bei.

Parameter

• window: Window — Das zu zentrierende Fenster.

Rückgabe

true, wenn das Fenster verschoben wurde; false, wenn das Fenster null oder geschlossen ist oder das Verschieben abgelehnt hat.

2 Beispiele: while-Schleife: mit Zeitlimit auf ein Fenster warten, Die Position eines Fensters merken und wiederherstellen

WindowClipToScreen

WindowClipToScreen(window: Window) → Bool

Verkleinert und verschiebt ein Fenster gerade so weit, dass kein Rand über den Arbeitsbereich (den Bildschirm ohne die Taskleiste) seines Monitors hinausragt. Ein Fenster, das ganz außerhalb des Arbeitsbereichs liegt, wird zuerst in seiner aktuellen Größe auf ihn verschoben.

Parameter

• window: Window — Das auf den Arbeitsbereich zu beschränkende Fenster.

Rückgabe

true, wenn das Fenster platziert wurde, auch wenn es bereits innerhalb des Arbeitsbereichs lag; false, wenn das Fenster null oder geschlossen ist oder die Änderung abgelehnt hat.

WindowClose

WindowClose(window: Window) → Bool · Einfach

Fordert ein Fenster zum Schließen auf, als hätte der Benutzer auf seine Schließen-Schaltfläche geklickt. Das Programm kann nachfragen, ob Änderungen gespeichert werden sollen, oder ablehnen; verwenden Sie WindowWaitClose, um zu warten, bis es verschwunden ist.

Parameter

• window: Window — Das zu schließende Fenster.

Rückgabe

true, wenn die Schließanforderung gesendet wurde, was nicht bedeutet, dass das Fenster geschlossen ist; false, wenn das Fenster null oder geschlossen ist oder zu einem Programm mit höheren Rechten gehört, etwa einem als Administrator ausgeführten.

3 Beispiele: Fenster nach Titelmuster schließen, nach Bestätigung, Nach der Maustaste des Strichs verzweigen, Verhalten ändern, solange Strg gedrückt ist

WindowContainsTitle

WindowContainsTitle(window: Window, text: Text) → Bool

Prüft, ob der Titel eines Fensters einen Text enthält, ohne Beachtung der Groß-/Kleinschreibung.

Parameter

• window: Window — Das Fenster, dessen Titel geprüft wird.
• text: Text — Der Text, der an beliebiger Stelle im Titel gesucht wird. Groß-/Kleinschreibung wird ignoriert.

Rückgabe

true, wenn der Titel text enthält, und immer true, wenn text leer ist; andernfalls false, auch für ein Null-Fenster oder ein geschlossenes Fenster.

WindowControlFromPoint

WindowControlFromPoint(x: Integer, y: Integer) → Window

Gibt das innerste Fenster an einem Bildschirmpunkt zurück, etwa eine Schaltfläche, ein Textfeld oder ein anderes Steuerelement im Fenster eines Programms. Ausgeblendete und deaktivierte Fenster werden übersprungen.

Parameter

• x: Integer — Horizontale Bildschirmposition, in Pixeln des virtuellen Bildschirms.
• y: Integer — Vertikale Bildschirmposition, in Pixeln des virtuellen Bildschirms.

Rückgabe

Das Steuerelement oder Fenster unter dem Punkt oder ein Null-Fenster, wenn keines vorhanden ist.

1 Beispiel: Beschreiben, was sich unter dem Mauszeiger befindet

WindowEnsureVisible

WindowEnsureVisible(window: Window) → Bool

Schiebt ein Fenster vollständig in den Arbeitsbereich seines Monitors, ohne seine Größe zu ändern. Ein Fenster, das größer als der Arbeitsbereich ist, wird an der oberen linken Ecke des Arbeitsbereichs ausgerichtet.

Parameter

• window: Window — Das vollständig auf den Bildschirm zu holende Fenster.

Rückgabe

true, wenn das Fenster platziert wurde, auch wenn es bereits vollständig sichtbar war; false, wenn das Fenster null oder geschlossen ist oder das Verschieben abgelehnt hat.

WindowFindAllByModuleRegex

WindowFindAllByModuleRegex(pattern: Text) → Integer

Sucht alle Fenster der obersten Ebene, auch ausgeblendete, deren Programmdateipfad einem regulären Ausdruck entspricht, und behält die Liste für WindowGetEnumeratedAt. Ersetzt eine frühere Fensterliste.

Parameter

• pattern: Text — Ein regulärer Ausdruck, der ohne Beachtung der Groß-/Kleinschreibung mit dem vollständigen Pfad des Programms abgeglichen wird, dem das jeweilige Fenster gehört, etwa 'notepad[.]exe$'.

Rückgabe

Die Anzahl der passenden Fenster oder 0, wenn keines passt. Ein ungültiges Muster beendet die Aktion mit einem Fehler.

1 Beispiel: Alle Fenster einer App minimieren

WindowFindAllByTitleRegex

WindowFindAllByTitleRegex(pattern: Text) → Integer

Sucht alle Fenster der obersten Ebene, auch ausgeblendete, deren Titel einem regulären Ausdruck entspricht, und behält die Liste für WindowGetEnumeratedAt. Ersetzt eine frühere Fensterliste.

Parameter

• pattern: Text — Ein regulärer Ausdruck, der ohne Beachtung der Groß-/Kleinschreibung mit dem Titel jedes Fensters abgeglichen wird. Er passt an beliebiger Stelle im Titel, sofern er nicht mit ^ oder $ verankert ist.

Rückgabe

Die Anzahl der passenden Fenster oder 0, wenn keines passt. Ein ungültiges Muster beendet die Aktion mit einem Fehler.

1 Beispiel: Fenster nach Titelmuster schließen, nach Bestätigung

WindowFindByClassName

WindowFindByClassName(className: Text) → Window

Sucht das vorderste sichtbare Fenster der obersten Ebene, dessen Klassenname den angegebenen Text enthält, ohne Beachtung der Groß-/Kleinschreibung.

Parameter

• className: Text — Im Klassennamen zu suchender Text, etwa 'Notepad'. Ein Teil eines Namens genügt; leerer Text passt zum vordersten sichtbaren Fenster.

Rückgabe

Das gefundene Fenster oder ein Null-Fenster, wenn kein sichtbares Fenster der obersten Ebene passt.

WindowFindByTitle

WindowFindByTitle(title: Text) → Window

Sucht das vorderste sichtbare Fenster der obersten Ebene, dessen Titel den angegebenen Text enthält, ohne Beachtung der Groß-/Kleinschreibung.

Parameter

• title: Text — Text, der an beliebiger Stelle im Titel gesucht wird. Groß-/Kleinschreibung wird ignoriert; leerer Text passt zum vordersten sichtbaren Fenster.

Rückgabe

Das gefundene Fenster oder ein Null-Fenster, wenn kein sichtbares Fenster der obersten Ebene passt.

4 Beispiele: Wahrheitswert jedes Typs, while-Schleife: mit Zeitlimit auf ein Fenster warten, Gleichheit über Typen hinweg, Auf einen Punkt in einem Fenster klicken

WindowFitToScreen

WindowFitToScreen(window: Window) → Bool · Einfach

Ändert Größe und Position eines Fensters so, dass seine sichtbaren Ränder den Arbeitsbereich (den Bildschirm ohne die Taskleiste) seines Monitors ausfüllt, ohne es zu maximieren.

Parameter

• window: Window — Das an den Arbeitsbereich anzupassende Fenster.

Rückgabe

true, wenn die Größe des Fensters geändert wurde; false, wenn das Fenster null oder geschlossen ist oder die Änderung abgelehnt hat.

WindowFromPoint

WindowFromPoint(x: Integer, y: Integer) → Window

Gibt das Fenster der obersten Ebene an einem Bildschirmpunkt zurück, etwa das Programmfenster unter der Maus, statt des Steuerelements darin.

Parameter

• x: Integer — Horizontale Bildschirmposition, in Pixeln des virtuellen Bildschirms.
• y: Integer — Vertikale Bildschirmposition, in Pixeln des virtuellen Bildschirms.

Rückgabe

Das Fenster der obersten Ebene unter dem Punkt oder ein Null-Fenster, wenn keines vorhanden ist.

WindowFromProcessId

WindowFromProcessId(processId: Integer) → Window

Gibt das Hauptfenster eines laufenden Programms zurück: das vorderste sichtbare Fenster der obersten Ebene, das diesem Prozess gehört.

Parameter

• processId: Integer — Die Prozess-ID, wie sie WindowGetProcessId oder ShellGetEnumeratedProcessIdAt zurückgibt.

Rückgabe

Das Fenster oder ein Null-Fenster, wenn der Prozess kein sichtbares Fenster der obersten Ebene hat oder processId 0 ist.

1 Beispiel: Vom Prozess zum Fenster

WindowGetActive

WindowGetActive() → Window

Gibt das Vordergrundfenster zurück: das Fenster der obersten Ebene, in dem der Benutzer gerade arbeitet.

Parameter

Keine Parameter.

Rückgabe

Das aktive Fenster oder ein Null-Fenster, wenn in diesem Moment kein Fenster aktiv ist, etwa während eines Fokuswechsels.

4 Beispiele: Die fünf Werttypen, Mehr als zwei Werte formatieren, Vergleiche ohne Beachtung der Groß-/Kleinschreibung, Das aktive Fenster an der linken Hälfte seines Monitors ausrichten

WindowGetAllChildren

WindowGetAllChildren(window: Window, directOnly: Bool) → Integer

Listet die untergeordneten Fenster (Steuerelemente) in einem Fenster auf und behält die Liste für WindowGetEnumeratedAt. Ersetzt eine frühere Fensterliste.

Parameter

• window: Window — Das Fenster, dessen untergeordnete Fenster aufgelistet werden.
• directOnly: Bool — true nur für die direkten untergeordneten Fenster; false für alle Nachfahren in jeder Tiefe.

Rückgabe

Die Anzahl der gefundenen untergeordneten Fenster oder 0, wenn keine vorhanden sind oder das Fenster null ist.

1 Beispiel: Die untergeordneten Steuerelemente eines Fensters untersuchen

WindowGetAllProps

WindowGetAllProps(window: Window) → Integer

Listet alle Eigenschaften auf, die an einem Fenster gespeichert sind, ob von dieser Engine, vom Programm selbst oder von anderer Software, und behält die Liste für WindowGetEnumeratedPropNameAt und WindowGetEnumeratedPropValueAt.

Parameter

• window: Window — Das Fenster, dessen Eigenschaften aufgelistet werden.

Rückgabe

Die Anzahl der gefundenen Eigenschaften oder 0, wenn keine vorhanden sind oder das Fenster null ist.

WindowGetAllTopLevel

WindowGetAllTopLevel() → Integer

Listet alle Fenster der obersten Ebene auf dem Desktop von vorn nach hinten auf, einschließlich ausgeblendeter und verhüllter (cloaked) Fenster, und behält die Liste für WindowGetEnumeratedAt. Ersetzt eine frühere Fensterliste.

Parameter

Keine Parameter.

Rückgabe

Die Anzahl der gefundenen Fenster der obersten Ebene.

1 Beispiel: Sichtbare Fenster der obersten Ebene auflisten

WindowGetAlpha

WindowGetAlpha(window: Window) → Integer

Gibt die Transparenzstufe eines Fensters zurück, wie sie WindowSetAlpha oder das Programm selbst festgelegt hat.

Parameter

• window: Window — Das zu lesende Fenster.

Rückgabe

Ein Wert von 0 (vollständig transparent) bis 255 (vollständig deckend). 255 für ein Fenster ohne festgelegte Transparenz sowie für ein Null-Fenster oder ein geschlossenes Fenster.

1 Beispiel: Fenstertransparenz durchschalten

WindowGetClassName

WindowGetClassName(window: Window) → Text

Gibt den Klassennamen eines Fensters zurück, den Typnamen, den Windows dafür verwendet, etwa 'Notepad' oder 'Button'. Nützlich, um Fenster zu erkennen, deren Titel sich ändern.

Parameter

• window: Window — Das zu lesende Fenster.

Rückgabe

Der Klassenname oder leerer Text, wenn das Fenster null oder geschlossen ist.

2 Beispiele: Die untergeordneten Steuerelemente eines Fensters untersuchen, Beschreiben, was sich unter dem Mauszeiger befindet

WindowGetControlText

WindowGetControlText(window: Window) → Text

Liest den Text eines Steuerelements in einem beliebigen Programm, etwa eines Textfelds, einer Statusleiste oder einer Dialogmeldung. Funktioniert nur mit klassischen Windows-Steuerelementen. Blockiert das Skript bis zu 2 Sekunden, wenn das Programm nicht reagiert.

Parameter

• window: Window — Das zu lesende Steuerelement oder Fenster, etwa von WindowControlFromPoint oder WindowGetEnumeratedAt.

Rückgabe

Der Text des Steuerelements, bis zu etwa einer Million Zeichen, oder leerer Text, wenn es keinen hat, das Fenster null oder geschlossen ist oder das Programm nicht reagiert hat. Das Kennwortfeld eines anderen Programms liefert leeren Text.

WindowGetDpi

WindowGetDpi(window: Window) → Integer

Gibt den DPI-Wert des Monitors zurück, auf dem sich ein Fenster befindet: 96 bei 100 Prozent Anzeigeskalierung, 144 bei 150 Prozent.

Parameter

• window: Window — Das zu prüfende Fenster.

Rückgabe

Der DPI-Wert oder 0, wenn das Fenster null oder geschlossen ist.

WindowGetEnabled

WindowGetEnabled(window: Window) → Bool

Prüft, ob ein Fenster Maus- und Tastatureingaben annimmt. Ein deaktiviertes Fenster oder Steuerelement wird meist abgeblendet dargestellt.

Parameter

• window: Window — Das zu prüfende Fenster.

Rückgabe

true, wenn das Fenster aktiviert ist; false, wenn es deaktiviert, null oder geschlossen ist.

WindowGetEnumeratedAt

WindowGetEnumeratedAt(index: Integer) → Window

Gibt ein Fenster aus der Liste zurück, die der letzte Aufruf von WindowGetAllTopLevel, WindowGetAllChildren, WindowFindAllByTitleRegex oder WindowFindAllByModuleRegex erstellt hat.

Parameter

• index: Integer — Position in der Liste, von 0 bis zu der vom auflistenden Aufruf zurückgegebenen Anzahl minus 1.

Rückgabe

Das Fenster an dieser Position oder ein Null-Fenster, wenn index außerhalb des Bereichs liegt.

4 Beispiele: Sichtbare Fenster der obersten Ebene auflisten, Alle Fenster einer App minimieren, Fenster nach Titelmuster schließen, nach Bestätigung, Die untergeordneten Steuerelemente eines Fensters untersuchen

WindowGetEnumeratedPropNameAt

WindowGetEnumeratedPropNameAt(index: Integer) → Text

Gibt den Namen einer Eigenschaft aus der Liste zurück, die der letzte Aufruf von WindowGetAllProps erstellt hat.

Parameter

• index: Integer — Position in der Liste, von 0 bis zu der von WindowGetAllProps zurückgegebenen Anzahl minus 1.

Rückgabe

Der Name der Eigenschaft oder leerer Text, wenn index außerhalb des Bereichs liegt.

WindowGetEnumeratedPropValueAt

WindowGetEnumeratedPropValueAt(index: Integer) → Integer

Gibt den rohen ganzzahligen Wert einer Eigenschaft aus der Liste zurück, die der letzte Aufruf von WindowGetAllProps erstellt hat. Eine mit WindowSetPropertyText gesetzte Eigenschaft zeigt hier eine interne Zahl, nicht ihren Text.

Parameter

• index: Integer — Position in der Liste, von 0 bis zu der von WindowGetAllProps zurückgegebenen Anzahl minus 1.

Rückgabe

Der Wert der Eigenschaft oder 0, wenn index außerhalb des Bereichs liegt.

WindowGetExecutableFolder

WindowGetExecutableFolder(window: Window) → Text

Gibt den Ordner zurück, der das Programm enthält, dem ein Fenster gehört, ohne Dateinamen und ohne abschließendes Trennzeichen. Verwenden Sie WindowGetExecutableName für den Dateinamen oder WindowGetExecutableFullPath für beides.

Parameter

• window: Window — Das Fenster, dessen Programm gesucht werden soll.

Rückgabe

Der Ordnerpfad oder leerer Text, wenn das Fenster null oder geschlossen ist oder das Programm nicht abgefragt werden kann.

WindowGetExecutableFullPath

WindowGetExecutableFullPath(window: Window) → Text

Gibt den vollständigen Pfad des Programms zurück, dem ein Fenster gehört, Ordner und Dateiname zusammen, etwa den Pfad von notepad.exe im Windows-Ordner. Verwenden Sie WindowGetExecutableFolder oder WindowGetExecutableName für einen der beiden Teile.

Parameter

• window: Window — Das Fenster, dessen Programm gesucht werden soll.

Rückgabe

Der vollständige Pfad oder leerer Text, wenn das Fenster null oder geschlossen ist oder das Programm nicht abgefragt werden kann.

WindowGetExecutableName

WindowGetExecutableName(window: Window) → Text

Gibt den Dateinamen des Programms zurück, dem ein Fenster gehört, etwa 'notepad.exe'.

Parameter

• window: Window — Das Fenster, dessen Programm ermittelt werden soll.

Rückgabe

Der Dateiname des Programms oder leerer Text, wenn das Fenster null oder geschlossen ist oder das Programm nicht abgefragt werden kann.

2 Beispiele: Vergleiche ohne Beachtung der Groß-/Kleinschreibung, Sichtbare Fenster der obersten Ebene auflisten

WindowGetHeight

WindowGetHeight(window: Window) → Integer

Gibt die sichtbare Höhe eines Fensters zurück, ohne den unsichtbaren Rahmen zur Größenänderung, den Windows um die meisten Fenster legt.

Parameter

• window: Window — Das zu messende Fenster.

Rückgabe

Die Höhe in Pixeln oder 0, wenn das Fenster null oder geschlossen ist.

3 Beispiele: Mehr als zwei Werte formatieren, Das aktive Fenster an der linken Hälfte seines Monitors ausrichten, Den Mauszeiger 5 Sekunden lang auf ein Fenster beschränken

WindowGetLastFocus

WindowGetLastFocus() → Window

Gibt das Fenster oder Steuerelement zurück, das zuletzt irgendwo auf dem Desktop den Tastaturfokus erhalten hat. Oft ein Steuerelement wie ein Textfeld statt seines Fensters der obersten Ebene.

Parameter

Keine Parameter.

Rückgabe

Das zuletzt fokussierte Fenster oder Steuerelement oder ein Null-Fenster, wenn sich der Fokus seit dem Start der Engine nicht geändert hat.

WindowGetMovableAncestor

WindowGetMovableAncestor(window: Window) → Window

Gibt das nächstgelegene Fenster zurück, das verschoben werden kann: das Fenster selbst oder das erste übergeordnete Fenster darüber, das ein Systemmenü hat. Macht aus einem Steuerelement unter der Maus das zu verschiebende Fenster.

Parameter

• window: Window — Das Fenster oder Steuerelement, bei dem begonnen wird.

Rückgabe

Das Fenster selbst oder das erste übergeordnete Fenster mit Systemmenü oder ein Null-Fenster, wenn keines eines hat oder das Fenster null ist.

WindowGetParent

WindowGetParent(window: Window) → Window

Gibt das Fenster zurück, das ein Steuerelement enthält. Bei einem Popupfenster wie einem Dialogfeld kann dies das besitzende Fenster sein.

Parameter

• window: Window — Das Fenster oder Steuerelement, dessen übergeordnetes Fenster ermittelt werden soll.

Rückgabe

Das übergeordnete oder besitzende Fenster oder ein Null-Fenster, wenn keines vorhanden ist oder das Fenster null oder geschlossen ist.

WindowGetProcessId

WindowGetProcessId(window: Window) → Integer

Gibt die ID des Prozesses (des laufenden Programms) zurück, dem ein Fenster gehört, dieselbe Zahl, die der Task-Manager anzeigt.

Parameter

• window: Window — Das Fenster, dessen Prozess ermittelt werden soll.

Rückgabe

Die Prozess-ID oder 0, wenn das Fenster null oder geschlossen ist.

WindowGetPropertyInteger

WindowGetPropertyInteger(window: Window, name: Text) → Integer

Liest eine an einem Fenster gespeicherte benannte Ganzzahl, etwa eine zuvor mit WindowSetPropertyInteger gespeicherte, um sich etwas über dieses Fenster zu merken.

Parameter

• window: Window — Das Fenster, aus dem gelesen wird.
• name: Text — Der Name der Eigenschaft.

Rückgabe

Der gespeicherte Wert oder 0, wenn die Eigenschaft nicht existiert oder das Fenster null ist. Eine gespeicherte 0 sieht genauso aus wie eine fehlende Eigenschaft.

2 Beispiele: Ein Fenster im Vordergrund fixieren, Die Position eines Fensters merken und wiederherstellen

WindowGetPropertyText

WindowGetPropertyText(window: Window, name: Text) → Text

Liest einen benannten Textwert, den diese Engine mit WindowSetPropertyText an einem Fenster gespeichert hat.

Parameter

• window: Window — Das Fenster, aus dem gelesen wird.
• name: Text — Der Name der Eigenschaft.

Rückgabe

Der gespeicherte Text oder leerer Text, wenn die Eigenschaft nicht existiert, nicht von dieser Engine als Text gespeichert wurde, inzwischen überschrieben wurde oder das Fenster null ist.

WindowGetRoot

WindowGetRoot(window: Window) → Window

Gibt das Fenster der obersten Ebene zurück, das ein Fenster oder Steuerelement enthält, etwa das Programmfenster um eine Schaltfläche.

Parameter

• window: Window — Das Fenster oder Steuerelement, bei dem begonnen wird.

Rückgabe

Das Fenster der obersten Ebene, also das Fenster selbst, wenn es bereits auf oberster Ebene liegt; ein Null-Fenster, wenn das Fenster null oder geschlossen ist.

1 Beispiel: Beschreiben, was sich unter dem Mauszeiger befindet

WindowGetTitle

WindowGetTitle(window: Window) → Text

Gibt den Text in der Titelleiste eines Fensters zurück. Bei Steuerelementen in anderen Programmen ist er meist leer; verwenden Sie dafür WindowGetControlText.

Parameter

• window: Window — Das zu lesende Fenster.

Rückgabe

Der Titel oder leerer Text, wenn das Fenster keinen hat oder null oder geschlossen ist.

9 Beispiele: Vergleiche ohne Beachtung der Groß-/Kleinschreibung, Eine Geste, mehrere Möglichkeiten, Ein Fenster im Vordergrund fixieren, Sichtbare Fenster der obersten Ebene auflisten, Die untergeordneten Steuerelemente eines Fensters untersuchen, Vom Prozess zum Fenster, Beschreiben, was sich unter dem Mauszeiger befindet, Alles, was der Auslöserkontext weiß, Eine in Storage gehaltene Liste

WindowGetVisible

WindowGetVisible(window: Window) → Bool

Prüft, ob ein Fenster auf Anzeigen gesetzt ist. Ein sichtbares Fenster kann trotzdem minimiert, von anderen Fenstern verdeckt, außerhalb des Bildschirms oder auf einem anderen virtuellen Desktop sein.

Parameter

• window: Window — Das zu prüfende Fenster.

Rückgabe

true, wenn das Fenster und alle seine übergeordneten Fenster angezeigt werden; false, wenn es ausgeblendet, null oder geschlossen ist.

1 Beispiel: Sichtbare Fenster der obersten Ebene auflisten

WindowGetWidth

WindowGetWidth(window: Window) → Integer

Gibt die sichtbare Breite eines Fensters zurück, ohne den unsichtbaren Rahmen zur Größenänderung, den Windows um die meisten Fenster legt.

Parameter

• window: Window — Das zu messende Fenster.

Rückgabe

Die Breite in Pixeln oder 0, wenn das Fenster null oder geschlossen ist.

3 Beispiele: Mehr als zwei Werte formatieren, Das aktive Fenster an der linken Hälfte seines Monitors ausrichten, Den Mauszeiger 5 Sekunden lang auf ein Fenster beschränken

WindowGetX

WindowGetX(window: Window) → Integer

Gibt die Bildschirmposition des sichtbaren linken Rands eines Fensters zurück, ohne den unsichtbaren Rahmen zur Größenänderung. Bei einem minimierten Fenster ist dies eine Parkposition außerhalb des Bildschirms.

Parameter

• window: Window — Das zu lokalisierende Fenster.

Rückgabe

Der linke Rand, in Pixeln des virtuellen Bildschirms, oder 0, wenn das Fenster null oder geschlossen ist.

4 Beispiele: Mehr als zwei Werte formatieren, Das aktive Fenster an der linken Hälfte seines Monitors ausrichten, Die Position eines Fensters merken und wiederherstellen, Den Mauszeiger 5 Sekunden lang auf ein Fenster beschränken

WindowGetY

WindowGetY(window: Window) → Integer

Gibt die Bildschirmposition des sichtbaren oberen Rands eines Fensters zurück, ohne den unsichtbaren Rahmen zur Größenänderung. Bei einem minimierten Fenster ist dies eine Parkposition außerhalb des Bildschirms.

Parameter

• window: Window — Das zu lokalisierende Fenster.

Rückgabe

Der obere Rand, in Pixeln des virtuellen Bildschirms, oder 0, wenn das Fenster null oder geschlossen ist.

4 Beispiele: Mehr als zwei Werte formatieren, Das aktive Fenster an der linken Hälfte seines Monitors ausrichten, Die Position eines Fensters merken und wiederherstellen, Den Mauszeiger 5 Sekunden lang auf ein Fenster beschränken

WindowHide

WindowHide(window: Window) → Bool

Blendet ein Fenster vollständig aus, einschließlich seiner Taskleistenschaltfläche. Die Engine zeigt es beim Beenden wieder an, und Ausgeblendete Fenster anzeigen im Infobereichsmenü holt es jederzeit zurück.

Parameter

• window: Window — Das auszublendende Fenster.

Rückgabe

true, wenn das Fenster ausgeblendet wurde oder bereits ausgeblendet war; false, wenn es null oder geschlossen ist, der Desktop, die Taskleiste oder eines der eigenen Fenster dieser Engine ist oder bereits 256 ausgeblendete Fenster verfolgt werden.

WindowIsCloaked

WindowIsCloaked(window: Window) → Bool

Prüft, ob Windows ein Fenster unsichtbar hält, obwohl es als angezeigt gilt, etwa ein Fenster auf einem anderen virtuellen Desktop oder eine angehaltene Store-App. Nützlich, um solche Fenster in einer Liste zu überspringen.

Parameter

• window: Window — Das zu prüfende Fenster.

Rückgabe

true, wenn das Fenster verhüllt (cloaked) ist; false, wenn nicht oder das Fenster null oder geschlossen ist.

1 Beispiel: Sichtbare Fenster der obersten Ebene auflisten

WindowIsMaximized

WindowIsMaximized(window: Window) → Bool

Prüft, ob ein Fenster maximiert ist, etwa bevor entschieden wird, ob WindowRestore oder WindowMaximize aufgerufen wird.

Parameter

• window: Window — Das zu prüfende Fenster.

Rückgabe

true, wenn das Fenster maximiert ist; false, wenn nicht oder das Fenster null oder geschlossen ist.

1 Beispiel: Maximieren des Fensters der Geste umschalten

WindowIsMinimized

WindowIsMinimized(window: Window) → Bool

Prüft, ob ein Fenster auf die Taskleiste minimiert ist, etwa bevor entschieden wird, ob WindowRestore aufgerufen wird.

Parameter

• window: Window — Das zu prüfende Fenster.

Rückgabe

true, wenn das Fenster minimiert ist; false, wenn nicht oder das Fenster null oder geschlossen ist.

WindowMapClientPointToScreenX

WindowMapClientPointToScreenX(window: Window, x: Integer, y: Integer) → Integer

Rechnet einen Punkt im Clientbereich eines Fensters (dem Inneren des Fensters, unterhalb der Titelleiste und innerhalb der Rahmen) in eine Bildschirmposition um und gibt deren horizontalen Anteil zurück.

Parameter

• window: Window — Das Fenster, in dessen Clientbereich der Punkt liegt.
• x: Integer — Horizontale Position ab dem linken Rand des Clientbereichs, in Pixeln.
• y: Integer — Vertikale Position ab dem oberen Rand des Clientbereichs, in Pixeln.

Rückgabe

Die X-Position auf dem Bildschirm, in Pixeln des virtuellen Bildschirms, oder 0, wenn das Fenster null oder geschlossen ist.

WindowMapClientPointToScreenY

WindowMapClientPointToScreenY(window: Window, x: Integer, y: Integer) → Integer

Rechnet einen Punkt im Clientbereich eines Fensters (dem Inneren des Fensters, unterhalb der Titelleiste und innerhalb der Rahmen) in eine Bildschirmposition um und gibt deren vertikalen Anteil zurück.

Parameter

• window: Window — Das Fenster, in dessen Clientbereich der Punkt liegt.
• x: Integer — Horizontale Position ab dem linken Rand des Clientbereichs, in Pixeln.
• y: Integer — Vertikale Position ab dem oberen Rand des Clientbereichs, in Pixeln.

Rückgabe

Die Y-Position auf dem Bildschirm, in Pixeln des virtuellen Bildschirms, oder 0, wenn das Fenster null oder geschlossen ist.

WindowMapScreenPointToClientX

WindowMapScreenPointToClientX(window: Window, x: Integer, y: Integer) → Integer

Rechnet eine Bildschirmposition in einen Punkt relativ zum Clientbereich eines Fensters (dem Inneren des Fensters, unterhalb der Titelleiste und innerhalb der Rahmen) um und gibt dessen horizontalen Anteil zurück.

Parameter

• window: Window — Das Fenster, von dessen Clientbereich aus gemessen wird.
• x: Integer — Horizontale Bildschirmposition, in Pixeln des virtuellen Bildschirms.
• y: Integer — Vertikale Bildschirmposition, in Pixeln des virtuellen Bildschirms.

Rückgabe

Die X-Position ab dem linken Rand des Clientbereichs, in Pixeln; negativ, wenn der Punkt links davon liegt. 0, wenn das Fenster null oder geschlossen ist.

1 Beispiel: Beschreiben, was sich unter dem Mauszeiger befindet

WindowMapScreenPointToClientY

WindowMapScreenPointToClientY(window: Window, x: Integer, y: Integer) → Integer

Rechnet eine Bildschirmposition in einen Punkt relativ zum Clientbereich eines Fensters (dem Inneren des Fensters, unterhalb der Titelleiste und innerhalb der Rahmen) um und gibt dessen vertikalen Anteil zurück.

Parameter

• window: Window — Das Fenster, von dessen Clientbereich aus gemessen wird.
• x: Integer — Horizontale Bildschirmposition, in Pixeln des virtuellen Bildschirms.
• y: Integer — Vertikale Bildschirmposition, in Pixeln des virtuellen Bildschirms.

Rückgabe

Die Y-Position ab dem oberen Rand des Clientbereichs, in Pixeln; negativ, wenn der Punkt darüber liegt. 0, wenn das Fenster null oder geschlossen ist.

1 Beispiel: Beschreiben, was sich unter dem Mauszeiger befindet

WindowMaximize

WindowMaximize(window: Window) → Bool · Einfach

Maximiert ein Fenster, sodass es seinen Monitor ausfüllt, und aktiviert es. Ein mit WindowHide ausgeblendetes Fenster wird angezeigt und nicht mehr als ausgeblendet geführt.

Parameter

• window: Window — Das zu maximierende Fenster.

Rückgabe

true, wenn das Fenster danach maximiert ist; false, wenn das Fenster null oder geschlossen ist oder nicht maximiert wurde.

2 Beispiele: Eine Geste, mehrere Möglichkeiten, Maximieren des Fensters der Geste umschalten

WindowMinimize

WindowMinimize(window: Window) → Bool · Einfach

Minimiert ein Fenster auf die Taskleiste. Windows aktiviert danach das nächste Fenster. Ein mit WindowHide ausgeblendetes Fenster wird minimiert angezeigt und nicht mehr als ausgeblendet geführt.

Parameter

• window: Window — Das zu minimierende Fenster.

Rückgabe

true, wenn das Fenster danach minimiert ist; false, wenn das Fenster null oder geschlossen ist oder nicht minimiert wurde.

4 Beispiele: Eine Geste, mehrere Möglichkeiten, Alle Fenster einer App minimieren, Nach der Maustaste des Strichs verzweigen, Verhalten ändern, solange Strg gedrückt ist

WindowMoveTo

WindowMoveTo(window: Window, x: Integer, y: Integer) → Bool

Verschiebt ein Fenster so, dass seine sichtbare obere linke Ecke an einer Bildschirmposition liegt, und behält seine Größe bei. Verwendet dieselben Koordinaten wie WindowGetX und WindowGetY; ein maximiertes Fenster wird nicht zuerst wiederhergestellt.

Parameter

• window: Window — Das zu verschiebende Fenster.
• x: Integer — Neuer linker Rand des sichtbaren Rahmens, in Pixeln des virtuellen Bildschirms.
• y: Integer — Neuer oberer Rand des sichtbaren Rahmens, in Pixeln des virtuellen Bildschirms.

Rückgabe

true, wenn das Fenster verschoben wurde; false, wenn das Fenster null oder geschlossen ist oder das Verschieben abgelehnt hat.

3 Beispiele: Das aktive Fenster an der linken Hälfte seines Monitors ausrichten, Ein Fenster in eine Zelle eines 3×2-Rasters unter dem Mauszeiger einpassen, Die Position eines Fensters merken und wiederherstellen

WindowRemoveProp

WindowRemoveProp(window: Window, name: Text) → Integer

Entfernt eine benannte Eigenschaft von einem Fenster, ob sie mit WindowSetPropertyInteger, WindowSetPropertyText oder von anderer Software gespeichert wurde.

Parameter

• window: Window — Das Fenster, von dem die Eigenschaft entfernt wird.
• name: Text — Der Name der Eigenschaft.

Rückgabe

Der rohe Wert der entfernten Eigenschaft oder 0, wenn sie nicht existierte oder das Fenster null ist. Bei einer Texteigenschaft ist dies eine interne Zahl, nicht der Text.

2 Beispiele: Ein Fenster im Vordergrund fixieren, Die Position eines Fensters merken und wiederherstellen

WindowResizeTo

WindowResizeTo(window: Window, width: Integer, height: Integer) → Bool

Ändert die Größe des sichtbaren Rahmens eines Fensters und lässt seine obere linke Ecke an Ort und Stelle. Verwendet dieselbe Größe wie WindowGetWidth und WindowGetHeight; ein maximiertes Fenster wird nicht zuerst wiederhergestellt.

Parameter

• window: Window — Das Fenster, dessen Größe geändert werden soll.
• width: Integer — Neue sichtbare Breite, in Pixeln.
• height: Integer — Neue sichtbare Höhe, in Pixeln.

Rückgabe

true, wenn die Größe des Fensters geändert wurde; false, wenn das Fenster null oder geschlossen ist oder die Änderung abgelehnt hat.

2 Beispiele: Das aktive Fenster an der linken Hälfte seines Monitors ausrichten, Ein Fenster in eine Zelle eines 3×2-Rasters unter dem Mauszeiger einpassen

WindowRestore

WindowRestore(window: Window) → Bool · Einfach

Bringt ein minimiertes oder maximiertes Fenster auf seine normale Größe und Position zurück und aktiviert es. Ein mit WindowHide ausgeblendetes Fenster wird angezeigt und nicht mehr als ausgeblendet geführt.

Parameter

• window: Window — Das wiederherzustellende Fenster.

Rückgabe

true, wenn das Fenster am Ende seine normale Größe hat, weder minimiert noch maximiert; false, wenn das Fenster null oder geschlossen ist oder diesen Zustand nicht erreicht hat. Ein minimiertes Fenster, das vorher maximiert war, kehrt in den maximierten Zustand zurück, was als false zählt.

3 Beispiele: Maximieren des Fensters der Geste umschalten, Das aktive Fenster an der linken Hälfte seines Monitors ausrichten, Ein Fenster in eine Zelle eines 3×2-Rasters unter dem Mauszeiger einpassen

WindowSendToBottom

WindowSendToBottom(window: Window) → Bool · Einfach

Verschiebt ein Fenster hinter alle anderen Fenster, ohne es zu aktivieren. Ein Fenster, das immer im Vordergrund war, verliert diese Einstellung.

Parameter

• window: Window — Das nach hinten zu verschiebende Fenster.

Rückgabe

true, wenn das Fenster nach hinten verschoben wurde; false, wenn das Fenster null oder geschlossen ist oder die Änderung abgelehnt hat.

WindowSendToMonitorAt

WindowSendToMonitorAt(window: Window, x: Integer, y: Integer, mouseFollows: Bool) → Bool

Verschiebt ein Fenster auf den Monitor, der einen Bildschirmpunkt enthält, und behält seine Größe und seine Position relativ zum Arbeitsbereich bei. Ein maximiertes Fenster ist danach auf dem neuen Monitor maximiert; wird es dadurch aktiviert, erhält das zuvor aktive Fenster den Fokus zurück, sofern Windows dies zulässt.

Parameter

• window: Window — Das zu verschiebende Fenster.
• x: Integer — Horizontale Position eines beliebigen Punkts auf dem Zielmonitor, in Pixeln des virtuellen Bildschirms. Für einen Punkt außerhalb aller Monitore wird der nächstgelegene Monitor gewählt.
• y: Integer — Vertikale Position eines beliebigen Punkts auf dem Zielmonitor, in Pixeln des virtuellen Bildschirms.
• mouseFollows: Bool — true, um den Mauszeiger an dieselbe relative Stelle auf dem neuen Monitor zu bewegen, wenn das Fenster verschoben wird; false, um ihn dort zu lassen, wo er ist.

Rückgabe

true, wenn das Fenster verschoben wurde; false, wenn das Fenster null oder geschlossen ist oder das Verschieben abgelehnt hat.

WindowSendToMonitorIndex

WindowSendToMonitorIndex(window: Window, index: Integer, mouseFollows: Bool) → Bool

Verschiebt ein Fenster auf einen Monitor, der über seine Position in der Liste des letzten Aufrufs von DisplayMonitorEnumeratedAll gewählt wird, und behält Größe und relative Position bei. Ein maximiertes Fenster bleibt maximiert; wird es durch das erneute Maximieren aktiviert, erhält das zuvor aktive Fenster den Fokus zurück, sofern Windows dies zulässt.

Parameter

• window: Window — Das zu verschiebende Fenster.
• index: Integer — Position in der Monitorliste, beginnend bei 0. Die Monitore sind von links nach rechts, dann von oben nach unten sortiert.
• mouseFollows: Bool — true, um den Mauszeiger an dieselbe relative Stelle auf dem neuen Monitor zu bewegen, wenn das Fenster verschoben wird; false, um ihn dort zu lassen, wo er ist.

Rückgabe

true, wenn das Fenster verschoben wurde; false, wenn das Fenster null oder geschlossen ist, index außerhalb des Bereichs liegt oder DisplayMonitorEnumeratedAll in diesem Skript nicht ausgeführt wurde oder das Fenster das Verschieben abgelehnt hat.

1 Beispiel: Ein Fenster auf einen bestimmten Monitor senden

WindowSendToMonitorName

WindowSendToMonitorName(window: Window, name: Text, mouseFollows: Bool) → Bool

Verschiebt ein Fenster auf den Monitor mit einem bestimmten Gerätepfad oder Anzeigenamen und behält Größe und relative Position bei. Ein maximiertes Fenster bleibt maximiert; wird es durch das erneute Maximieren aktiviert, erhält das zuvor aktive Fenster den Fokus zurück, sofern Windows dies zulässt. Nützlich für Anordnungen, die das An- und Abdocken überstehen.

Parameter

• window: Window — Das zu verschiebende Fenster.
• name: Text — Der Gerätepfad oder Anzeigename des Monitors, wie ihn DisplayMonitorGetDevicePathFromPoint oder DisplayMonitorGetFriendlyNameFromPoint zurückgibt. Der Gerätepfad ist die zuverlässige Wahl. Groß-/Kleinschreibung wird ignoriert.
• mouseFollows: Bool — true, um den Mauszeiger an dieselbe relative Stelle auf dem neuen Monitor zu bewegen, wenn das Fenster verschoben wird; false, um ihn dort zu lassen, wo er ist.

Rückgabe

true, wenn das Fenster verschoben wurde; false, wenn kein angeschlossener Monitor diesen Namen hat, das Fenster null oder geschlossen ist oder das Fenster das Verschieben abgelehnt hat.

WindowSendToNextScreen

WindowSendToNextScreen(window: Window, mouseFollows: Bool) → Bool · Einfach

Verschiebt ein Fenster auf den nächsten Monitor, von links nach rechts, dann von oben nach unten, und springt vom letzten zum ersten zurück; Größe und relative Position bleiben erhalten. Ein maximiertes Fenster bleibt maximiert; wird es durch das erneute Maximieren aktiviert, erhält das zuvor aktive Fenster den Fokus zurück, sofern Windows dies zulässt.

Parameter

• window: Window — Das zu verschiebende Fenster.
• mouseFollows: Bool — true, um den Mauszeiger an dieselbe relative Stelle auf dem neuen Monitor zu bewegen, wenn das Fenster verschoben wird; false, um ihn dort zu lassen, wo er ist.

Rückgabe

true, wenn das Fenster verschoben wurde, auch wenn es nur einen Monitor gibt; false, wenn das Fenster null oder geschlossen ist oder das Verschieben abgelehnt hat.

2 Beispiele: Ein Fenster auf den nächsten Monitor werfen, Ein Fenster auf einen bestimmten Monitor senden

WindowSendToPreviousScreen

WindowSendToPreviousScreen(window: Window, mouseFollows: Bool) → Bool · Einfach

Verschiebt ein Fenster auf den vorherigen Monitor, von rechts nach links, dann von unten nach oben, und springt vom ersten zum letzten zurück; Größe und relative Position bleiben erhalten. Ein maximiertes Fenster bleibt maximiert; wird es durch das erneute Maximieren aktiviert, erhält das zuvor aktive Fenster den Fokus zurück, sofern Windows dies zulässt.

Parameter

• window: Window — Das zu verschiebende Fenster.
• mouseFollows: Bool — true, um den Mauszeiger an dieselbe relative Stelle auf dem neuen Monitor zu bewegen, wenn das Fenster verschoben wird; false, um ihn dort zu lassen, wo er ist.

Rückgabe

true, wenn das Fenster verschoben wurde, auch wenn es nur einen Monitor gibt; false, wenn das Fenster null oder geschlossen ist oder das Verschieben abgelehnt hat.

WindowSetActive

WindowSetActive(window: Window) → Bool

Holt ein Fenster in den Vordergrund und gibt ihm den Tastaturfokus; ein minimiertes Fenster wird zuerst wiederhergestellt und ein ausgeblendetes angezeigt. Ein mit WindowHide ausgeblendetes Fenster wird nicht mehr als ausgeblendet geführt. Windows kann dies ablehnen und stattdessen seine Taskleistenschaltfläche blinken lassen.

Parameter

• window: Window — Das zu aktivierende Fenster.

Rückgabe

true, wenn das Fenster zum Vordergrundfenster wurde; false, wenn Windows abgelehnt hat oder das Fenster null oder geschlossen ist.

2 Beispiele: Ein Programm starten, auf sein Fenster warten, darauf reagieren, Auf einen Punkt in einem Fenster klicken

WindowSetAlpha

WindowSetAlpha(window: Window, alpha: Integer) → Bool

Legt fest, wie transparent ein Fenster ist, von vollständig transparent bis vollständig deckend. Bei 255 ist das Fenster kein überlagertes Fenster (Layered Window) mehr, wodurch auch eine Transparenz entfernt wird, die das Programm selbst gesetzt hat. Fenster von Programmen, die als Administrator laufen, können nur geändert werden, wenn auch die Engine als Administrator läuft.

Parameter

• window: Window — Das zu ändernde Fenster.
• alpha: Integer — Deckkraft von 0 (vollständig transparent) bis 255 (vollständig deckend). Werte außerhalb dieses Bereichs werden darauf begrenzt.

Rückgabe

true, wenn die Transparenz angewendet wurde; false, wenn das Fenster null oder geschlossen ist oder die Änderung abgelehnt wurde.

1 Beispiel: Fenstertransparenz durchschalten

WindowSetBounds

WindowSetBounds(window: Window, x: Integer, y: Integer, width: Integer, height: Integer) → Bool

Verschiebt ein Fenster und ändert seine Größe in einem Schritt, mit denselben Koordinaten des sichtbaren Rahmens wie WindowGetX, WindowGetY, WindowGetWidth und WindowGetHeight. Vermeidet das Flackern von WindowMoveTo gefolgt von WindowResizeTo.

Parameter

• window: Window — Das zu verschiebende und in der Größe zu ändernde Fenster.
• x: Integer — Neuer linker Rand des sichtbaren Rahmens, in Pixeln des virtuellen Bildschirms.
• y: Integer — Neuer oberer Rand des sichtbaren Rahmens, in Pixeln des virtuellen Bildschirms.
• width: Integer — Neue sichtbare Breite, in Pixeln.
• height: Integer — Neue sichtbare Höhe, in Pixeln.

Rückgabe

true, wenn die Änderung angewendet wurde; false, wenn das Fenster null oder geschlossen ist oder die Änderung abgelehnt hat.

WindowSetEnabled

WindowSetEnabled(window: Window, enabled: Bool) → Bool

Aktiviert oder deaktiviert ein Fenster oder Steuerelement. Ein deaktiviertes Fenster ignoriert Mausklicks und Tastendrücke, bis es wieder aktiviert wird.

Parameter

• window: Window — Das zu ändernde Fenster oder Steuerelement.
• enabled: Bool — true, um das Fenster zu aktivieren; false, um es zu deaktivieren.

Rückgabe

true, sobald die Anforderung gestellt wurde; false, wenn das Fenster null oder geschlossen ist.

WindowSetPropertyInteger

WindowSetPropertyInteger(window: Window, name: Text, value: Integer) → Bool

Speichert eine benannte Ganzzahl an einem Fenster, etwa um sich zwischen Aktionen etwas über dieses Fenster zu merken. Die Engine entfernt die von ihr gespeicherten Eigenschaften beim Beenden.

Parameter

• window: Window — Das Fenster, an dem der Wert gespeichert wird.
• name: Text — Der Name der Eigenschaft. Wählen Sie einen unverwechselbaren Namen, damit er nicht mit Eigenschaften kollidiert, die das Programm selbst verwendet.
• value: Integer — Die zu speichernde Ganzzahl.

Rückgabe

true, wenn der Wert gespeichert wurde; false, wenn das Fenster null oder geschlossen ist.

2 Beispiele: Ein Fenster im Vordergrund fixieren, Die Position eines Fensters merken und wiederherstellen

WindowSetPropertyText

WindowSetPropertyText(window: Window, name: Text, value: Text) → Bool

Speichert einen benannten Textwert an einem Fenster, der mit WindowGetPropertyText wieder gelesen wird. Die Engine behält den Text genau wie angegeben, einschließlich Groß-/Kleinschreibung, und er darf leer sein. Die Engine entfernt die von ihr gespeicherten Eigenschaften beim Beenden.

Parameter

• window: Window — Das Fenster, an dem der Text gespeichert wird.
• name: Text — Der Name der Eigenschaft. Wählen Sie einen unverwechselbaren Namen, damit er nicht mit Eigenschaften kollidiert, die das Programm selbst verwendet.
• value: Text — Der zu speichernde Text, höchstens 1024 Zeichen.

Rückgabe

true, wenn der Text gespeichert wurde; false, wenn das Fenster null oder geschlossen ist, bereits 512 Textwerte gespeichert sind oder die Eigenschaft nicht gesetzt werden konnte. Text mit mehr als 1024 Zeichen beendet die Aktion mit einem Fehler.

WindowSetTitle

WindowSetTitle(window: Window, title: Text) → Bool

Ändert den Text in der Titelleiste eines Fensters. Das Programm kann ihn jederzeit zurückändern. Ein Programm, das nicht innerhalb von 1 Sekunde reagiert, bleibt unverändert.

Parameter

• window: Window — Das umzubenennende Fenster.
• title: Text — Der neue Titeltext.

Rückgabe

true, wenn der Titel gesetzt wurde; false, wenn das Fenster null oder geschlossen ist, nicht innerhalb von 1 Sekunde reagiert hat oder das Programm abgelehnt hat.

1 Beispiel: Eine Geste, mehrere Möglichkeiten

WindowSetTopmost

WindowSetTopmost(window: Window, topmost: Bool) → Bool · Einfach

Hält ein Fenster über allen normalen Fenstern oder setzt es auf die normale Stapelreihenfolge zurück, ohne es zu aktivieren.

Parameter

• window: Window — Das zu ändernde Fenster.
• topmost: Bool — true, um das Fenster immer im Vordergrund zu halten; false, um es auf die normale Stapelreihenfolge zurückzusetzen.

Rückgabe

true, wenn die Änderung angewendet wurde; false, wenn das Fenster null oder geschlossen ist oder zu einem Programm mit höheren Rechten gehört.

1 Beispiel: Ein Fenster im Vordergrund fixieren

WindowShow

WindowShow(window: Window) → Bool

Zeigt ein ausgeblendetes Fenster wieder an, etwa eines, das mit WindowHide ausgeblendet wurde, in seiner aktuellen Größe und Position. Die Engine verfolgt es nicht mehr als ausgeblendet.

Parameter

• window: Window — Das anzuzeigende Fenster.

Rückgabe

true, wenn die Anzeigeanforderung gestellt wurde; false, wenn das Fenster null oder geschlossen ist.

WindowToggleTopmost

WindowToggleTopmost(window: Window) → Bool · Einfach

Schaltet ein Fenster zwischen immer im Vordergrund und normaler Stapelreihenfolge um, ohne es zu aktivieren.

Parameter

• window: Window — Das zu ändernde Fenster.

Rückgabe

true, wenn die Änderung angewendet wurde; false, wenn das Fenster null oder geschlossen ist oder die Änderung abgelehnt hat. Es gibt nicht an, in welchem Zustand sich das Fenster jetzt befindet.

WindowWaitClose

WindowWaitClose(window: Window, timeoutMs: Integer) → Bool

Wartet, bis ein Fenster geschlossen wird, und prüft alle 50 Millisekunden. Blockiert das Skript bis zu timeoutMs lang; das Beenden aller Aktionen beendet das Warten vorzeitig.

Parameter

• window: Window — Das Fenster, auf das gewartet wird.
• timeoutMs: Integer — Maximale Wartezeit in Millisekunden, von 0 bis 60000. Größere Werte zählen als 60000; 0 prüft einmal ohne Warten.

Rückgabe

true, sobald das Fenster geschlossen ist, sofort, wenn es bereits geschlossen oder null ist; false, wenn es nach Ablauf der Zeit noch geöffnet ist oder das Warten beendet wird.

1 Beispiel: Ein Programm starten, auf sein Fenster warten, darauf reagieren

WindowWaitFor

WindowWaitFor(pattern: Text, timeoutMs: Integer) → Window

Wartet, bis ein sichtbares Fenster der obersten Ebene erscheint, dessen Titel einem regulären Ausdruck entspricht, und prüft alle 50 Millisekunden. Blockiert das Skript bis zu timeoutMs lang; nützlich direkt nach dem Start eines Programms.

Parameter

• pattern: Text — Ein regulärer Ausdruck, der ohne Beachtung der Groß-/Kleinschreibung mit Fenstertiteln abgeglichen wird, etwa 'Notepad$'. Er passt an beliebiger Stelle im Titel, sofern er nicht mit ^ oder $ verankert ist.
• timeoutMs: Integer — Maximale Wartezeit in Millisekunden, von 0 bis 60000. Größere Werte zählen als 60000; 0 prüft einmal ohne Warten.

Rückgabe

Das vorderste passende Fenster oder ein Null-Fenster, wenn keines rechtzeitig erschienen ist oder das Warten beendet wurde. Ein ungültiges Muster beendet die Aktion mit einem Fehler.

1 Beispiel: Ein Programm starten, auf sein Fenster warten, darauf reagieren