CRMWScript
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14556
Das WScript-Objekt beinhaltet Eigenschaften und Methoden der Scripting-Engine sowie von der Datenbank oder dem aktuellen Status unabhängige Funktionalität.
Das Objekt kann nicht von außen instanziert werden und steht daher in dieser Form nur in Scripten zur Verfügung, die innerhalb des Programms aufgerufen werden.
Implementiert
AsyncDisposableDisposable
Eigenschaften
ClipboardText
Abfragesignatur
get ClipboardText(): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14570
Setzt oder liest den Textinhalt der Zwischenablage.
Rückgabewert
string
Änderungssignatur
set ClipboardText(val): void;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14578
Setzt oder liest den Textinhalt der Zwischenablage.
Parameter
| Parameter | Type |
|---|---|
val | string |
Rückgabewert
void
Context
Abfragesignatur
get Context(): ScriptContext;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14587
Gibt innerhalb von Scripten, welche durch ScriptContext.ExecuteScriptByFilename oder ScriptContext.ExecuteScriptByCode aufgerufen wurden, das ScriptContext-Objekt des aufrufenden Scripts zurück.
Bei Scripten, welche nicht durch ScriptContext.ExecuteScriptByFilename oder ScriptContext.ExecuteScriptByCode aufgerufen wurden, ist die Eigenschaft Nothing bzw. null.
Rückgabewert
Event
Abfragesignatur
get Event(): CRMEvent;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14605
Das WScript.Event-Objekt und entsprechende Unterobjekte sind global verfügbar. Die im jeweils aktuellen
Script-Kontext nicht verfügbaren Unterobjekte sind Nothing bzw. null. WScript.Event.Project ist immer verfügbar und entspricht cRM.CurrentProject.
Rückgabewert
IsDisposed
Abfragesignatur
get IsDisposed(): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14662
Gibt an, ob das Objekt bereits Freigegeben wurde
Rückgabewert
boolean
Priority
Abfragesignatur
get Priority(): number;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14625
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
number
Änderungssignatur
set Priority(val): void;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14636
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 |
|---|---|
val | number |
Rückgabewert
void
RightClicked
Abfragesignatur
get RightClicked(): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14646
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
boolean
Terminate
Abfragesignatur
get Terminate(): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14656
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
boolean
Methoden
[asyncDispose]()
asyncDispose: Promise<void>;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14850
Standardimplementierung des AsyncDispose Symbols
Rückgabewert
Promise<void>
Implementierung von
AsyncDisposable.[asyncDispose]
[dispose]()
dispose: void;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14861
Standardimplementierung des Dispose Symbols
Rückgabewert
void
Implementierung von
Disposable.[dispose]
ActivateTitle()
ActivateTitle(windowTitle): void;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14686
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
void
ActivateTitleByClassname()
ActivateTitleByClassname(classname): void;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14696
Aktiviert ein Windows-Fenster über dessen Klassennamen.
Parameter
| Parameter | Type | Description |
|---|---|---|
classname | string | Der Klassenname des zu aktivierenden Fensters. |
Rückgabewert
void
Beep()
Beep(): void;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14705
Gibt den Standard Windows Warnton aus.
Rückgabewert
void
CheckAbortedWaitDlg()
CheckAbortedWaitDlg(): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14714
Die Methode muss zwischen StartWaitDlg(text: string, cancel: boolean) und EndWaitDlg() aufgerufen werden und gibt zurück, ob der Benutzer die Schaltfläche "Abbrechen" des Wartedialoges betätigt hat, sofern StartWaitDlg(text: string, cancel: boolean) mit Abbruch-Button angezeigt wurde.Die Methode wird vorzugsweise in Ausführungsschleifen verwendet.
Rückgabewert
boolean
Dispose()
Dispose(): void;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14855
Standardimplementierung des Dispose
Rückgabewert
void
DisposeAsync()
DisposeAsync(): Promise<void>;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14844
Standardimplementierung des AsyncDispose
Rückgabewert
Promise<void>
EndWaitDlg()
EndWaitDlg(): void;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14723
Blendet einen zuvor mit StartWaitDlg(text: string, cancel: boolean) angezeigten Wartedialog aus.
Rückgabewert
void
GetGlobalProperty()
GetGlobalProperty(name, defaultValue): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14734
Liest eine globale Script-Einstellung aus, die zuvor mit SetGlobalProperty(name: string, value: string) gesetzt wurde oder gibt den Standardwert zuruück.
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Der Name der Einstellung. |
defaultValue | string | Der Standardwert der Einstellung, der zurückgegeben wird, wenn keine Einstellung mit dem angegebenen Namen existiert. |
Rückgabewert
string
GetUserProperty()
GetUserProperty(name, defaultValue): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14745
Liest eine benutzerspezifische Script-Einstellung aus, die zuvor mit SetUserProperty(name: string, value: string) gesetzt wurde oder gibt den Standardwert zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Der Name der Einstellung. |
defaultValue | string | Der Standardwert der Einstellung, der zurückgegeben wird, wenn keine Einstellung mit dem angegebenen Namen existiert. |
Rückgabewert
string
SetGlobalProperty()
SetGlobalProperty(name, value): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14756
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 Einstellung. |
value | string | Der (neue) Wert der Einstellung. |
Rückgabewert
boolean
SetUserProperty()
SetUserProperty(name, value): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14767
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 Einstellung. |
value | string | Der (neue) Wert der Einstellung. |
Rückgabewert
boolean
SetWaitDlgText()
SetWaitDlgText(text): void;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14777
Hiermit kann der Text in einem per StartWaitDlg gestarteten Wartedialog nachträglich geändert werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
text | string | Der anzuzeigende Informationstext. |
Rückgabewert
void
Sleep()
Sleep(time): void;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14787
Hält die Ausführung des Scripts für eine anzugebende Zeit an.
Parameter
| Parameter | Type | Description |
|---|---|---|
time | number | Anzahl Millisekunden, die das Script angehalten werden soll. Sleep(1000) hält die Ausführung bspw. für 1 Sekunde an. |
Rückgabewert
void
StartWaitDlg()
Aufrufsignatur
StartWaitDlg(text, cancel): void;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14802
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. |
Rückgabewert
void
Aufrufsignatur
StartWaitDlg(
text,
cancel,
initialDelay): void;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14815
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 | Reserviert, derzeit immer 0. (Optional. Verzögerung bis zur Anzeige des Dialogs in Sekunden. 0 = unmittelbare Anzeige. Der vorbelegte Wert beträgt 3 Sekunden.) |
Rückgabewert
void
WaitTitle()
WaitTitle(title, time): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14838
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
boolean
true Fenster wurde gefunden. false Kein Fenster gefunden.
[hasInstance]()
static hasInstance: boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:14869
Symbol.hasInstance welches eine benutzerdefinierte Überprüfung der 'instanceof'-Operation für Objekte ermöglicht.
Parameter
| Parameter | Type |
|---|---|
value | any |
Rückgabewert
boolean