CRMWScript
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11236
Eigenschaften
clipboardTextAsync
Abfragesignatur
get clipboardTextAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11255
Setzt oder liest den Textinhalt der Zwischenablage.
Rückgabewert
Promise<string>
eventAsync
Abfragesignatur
get eventAsync(): Promise<CRMEvent>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11270
Rückgabewert
Promise<CRMEvent>
priorityAsync
Abfragesignatur
get priorityAsync(): Promise<number>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11287
Legt die Priorität des Scripts fest oder gibt diese zurück. Je höher die Priorität, desto häufiger bekommt das
Script Rechenzeit zugeteilt und umgekehrt.Die möglichen Werte liegen zwischen –2 und +2, wobei –2 die
niedrigste und +2 die höchste Priorität darstellt.
Hinweis: Kann nur in asynchronen Scripts verwendet werden.
Rückgabewert
Promise<number>
rightClickedAsync
Abfragesignatur
get rightClickedAsync(): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11310
Gibt true zurück, wenn das Script in der Eingabemaske über einen Button ausgeführt wurde und dieser mit
der rechten Maustaste geklickt wurde.Ermöglicht die Ausführung zweier verschiedener Funktionen über
einen Button.
Rückgabewert
Promise<boolean>
terminateAsync
Abfragesignatur
get terminateAsync(): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11319
Gibt true zurück, wenn die Anwendung gerade beendet wird bzw. das aktive Script zum Beenden aufgefordert wird. Die Eigenschaft kann und sollte unbedingt in Verbindung mit asynchronen Scripts verwendet werden und ermöglicht ein sauberes Verlassen des Scripts.
Bitte beachten Sie dabei, dass die noch laufenden, asynchronen Scripte insgesamt 4 Sekunden Zeit haben, sich zu beenden, bevor die Beendigung erzwungen wird.Sleeps und andere Aktionen im Script sollten also keinesfalls länger als 3 Sekunden dauern, bevor wieder die.Terminate Eigenschaft geprüft und das Script dann ggf.sich so schnell wie möglich kontrolliert beenden muss.
Rückgabewert
Promise<boolean>
Konstruktoren
Konstruktor
new CRMWScript(crmWScript?): CRMWScript;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11240
Parameter
| Parameter | Type |
|---|---|
crmWScript? | CRMWScript |
Rückgabewert
CRMWScript
Methoden
activateTitleAsync()
activateTitleAsync(windowTitle): Promise<void>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11329
Aktiviert ein Windows-Fenster über dessen Titel.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Der Titel (Name) des zu aktivierenden Fensters. Wenn Sie als erstes Zeichen ein "$" übergeben, muss der übergebene Titel lediglich enthalten sein, ansonsten genau übereinstimmen. |
Rückgabewert
Promise<void>
activateTitleByClassnameAsync()
activateTitleByClassnameAsync(windowClassname): Promise<void>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11341
Aktiviert ein Windows-Fenster über dessen Klassennamen.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowClassname | string | Der Klassenname des zu aktivierenden Fensters. |
Rückgabewert
Promise<void>
beepAsync()
beepAsync(): Promise<void>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11352
Gibt den Standard Windows Warnton aus.
Rückgabewert
Promise<void>
checkAbortedWaitDlgAsync()
checkAbortedWaitDlgAsync(): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11363
Die Methode muss zwischen startWaitDlgAsync(text: string, cancel: boolean) und endWaitDlgAsync() aufgerufen werden und gibt zurück, ob der Benutzer die Schaltfläche "Abbrechen" des Wartedialoges betätigt hat, sofern startWaitDlgAsync(text: string, cancel: boolean) mit Abbruch-Button angezeigt wurde.Die Methode wird vorzugsweise in Ausführungsschleifen verwendet.
Rückgabewert
Promise<boolean>
endWaitDlgAsync()
endWaitDlgAsync(): Promise<void>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11372
Blendet einen zuvor mit startWaitDlgAsync(text: string, cancel: boolean) angezeigten Wartedialog aus.
Rückgabewert
Promise<void>
getGlobalPropertyAsync()
getGlobalPropertyAsync(name, defaultValue): Promise<string>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11385
Liest eine globale Script-Einstellung aus, die zuvor mit setGlobalPropertyAsync(name: string, value: string) gesetzt wurde oder gibt den Standardwert zuruück.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
name | string | undefined | Der Name der globalen Einstellung. |
defaultValue | string | '' | Der Standardwert der Einstellung, der zurückgegeben wird, wenn keine Einstellung mit dem angegebenen Namen existiert. |
Rückgabewert
Promise<string>
getUserPropertyAsync()
getUserPropertyAsync(name, defaultValue): Promise<string>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11407
Liest eine benutzerspezifische Script-Einstellung aus, die zuvor mit CRMWScript.SetUserProperty | SetUserProperty(name: string, value: string) gesetzt wurde oder gibt den Standardwert zurück.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
name | string | undefined | Der Name der benutzerspezifischen Einstellung. |
defaultValue | string | '' | Der Standardwert der Einstellung, der zurückgegeben wird, wenn keine Einstellung mit dem angegebenen Namen existiert. |
Rückgabewert
Promise<string>
setClipboardTextAsync()
setClipboardTextAsync(value): Promise<void>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11263
Setzt oder liest den Textinhalt der Zwischenablage.
Parameter
| Parameter | Type |
|---|---|
value | string |
Rückgabewert
Promise<void>
setGlobalPropertyAsync()
setGlobalPropertyAsync(name, value): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11396
Setzt eine globale Script-Einstellung. Die Speicherung erfolgt in der Datei "global.ini" in der "cmbt_Files" Tabelle.
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Der Name der globalen Einstellung. |
value | string | Der (neue) Wert der Einstellung. |
Rückgabewert
Promise<boolean>
setPriorityAsync()
setPriorityAsync(value): Promise<void>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11298
Legt die Priorität des Scripts fest oder gibt diese zurück. Je höher die Priorität, desto häufiger bekommt das
Script Rechenzeit zugeteilt und umgekehrt.Die möglichen Werte liegen zwischen –2 und +2, wobei –2 die
niedrigste und +2 die höchste Priorität darstellt.
Hinweis: Kann nur in asynchronen Scripts verwendet werden.
Parameter
| Parameter | Type |
|---|---|
value | number |
Rückgabewert
Promise<void>
setUserPropertyAsync()
setUserPropertyAsync(name, value): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11418
Setzt eine benutzerspezifische Script-Einstellung. Die Speicherung erfolgt in der Datei "<BENUTZER>\user_scriptvars.ini" in der "cmbt_Files" Tabelle.
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Der Name der benutzerspezifischen Einstellung. |
value | string | Der (neue) Wert der Einstellung. |
Rückgabewert
Promise<boolean>
setWaitDlgTextAsync()
setWaitDlgTextAsync(text): Promise<void>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11427
Hiermit kann der Text in einem per startWaitDlgAsync gestarteten Wartedialog nachträglich geändert werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
text | string | Der anzuzeigende Informationstext. |
Rückgabewert
Promise<void>
sleepAsync()
sleepAsync(milliseconds): Promise<void>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11439
Hält die Ausführung des Scripts für eine anzugebende Zeit an.
Parameter
| Parameter | Type | Description |
|---|---|---|
milliseconds | number | Anzahl Millisekunden, die das Script angehalten werden soll. Sleep(1000) hält die Ausführung bspw. für 1 Sekunde an. |
Rückgabewert
Promise<void>
startWaitDlgAsync()
startWaitDlgAsync(
text,
cancel,
initialDelay?): Promise<void>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11457
Zeigt einen Wartedialog mit einer Fortschrittsanimation sowie einem zu übergebenden Informationstext an.
Die Ausführung des Scripts wird während der Anzeige fortgeführt.Die Ausblendung erfolgt mit EndWaitDlg.
Über den zweiten Parameter kann bestimmt werden, ob der Dialog eine "Abbrechen"-Schaltfläche enthalten soll.
Wenn ja, dann kann mit CheckAbortedWaitDlg geprüft werden, ob die Schaltfläche betätigt wurde.
Reserviert: Über den dritten Parameter kann die Verzögerung bis zur Anzeige des Dialogs eingestellt werden.Standardmäßig wird eine Verzögerung von 3 Sekunden verwendet, um zu verhindern, dass schnell geöffnete und geschlossene Dialoge flackern.
Parameter
| Parameter | Type | Description |
|---|---|---|
text | string | Der anzuzeigende Informationstext. |
cancel | boolean | Anzeige einer Schaltfläche "Abbrechen. |
initialDelay? | number | Anzeige des Wartedialogs erst nach einer bestimmten Zeit in Millisekunden. |
Rückgabewert
Promise<void>
waitTitleAsync()
waitTitleAsync(title, time): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11470
Methode wartet so lange, bis das Fenster mit dem übergebenen Titel gefunden wurde. Anschließend wird das gefundene Fenster aktiviert.
Parameter
| Parameter | Type | Description |
|---|---|---|
title | string | Der Titel (Name) des zu aktivierenden Fensters. Wenn Sie als erstes Zeichen ein "$" übergeben, muss der übergebene Titel lediglich enthalten sein, ansonsten genau übereinstimmen. |
time | number | Max. Wartezeit in Sekunden. -1 bedeutet unbegrenzte Wartezeit |
Rückgabewert
Promise<boolean>
true Fenster wurde gefunden. false Kein Fenster gefunden.