CRMApplication
Das Application-Objekt des cRM
Implementiert
AsyncDisposableDisposableICRMApplication
Eigenschaften
ActiveView
get ActiveView(): View
Gibt die aktive Ansicht zurück
Rückgabewert
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2565
AppDir
get AppDir(): string
Liefert den vollständigen Pfad des Hauptverzeichnisses der Anwendung, d.h. dort wo sich die Applikationsdateien (EXE und OVL) befinden: z.B. C:\Program Files (x86)\combit\cRM
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2332
AppTitle
get AppTitle(): string
Liefert den Namen der Anwendung zurück
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2341
CurrentProject
get CurrentProject(): Project
Gibt das geladene Projekt als Objekt vom Typ Project zurück (leer, wenn kein Projekt geladen).
Rückgabewert
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2582
DBServerName
get DBServerName(): string
Liefert den konfigurierten Datenbankservernamen zurück
Hinweis: Der Datenbankservername wird so zurückgegeben, wie er unter Konto > Datenbankverbindung bzw.per Client-Installation angegeben wurde, inklusive der Groß- und Kleinschreibung.
Ein Vergleich mit bestimmten Werten sollte idealerweise ohne Berücksichtigung von Groß- und Kleinschreibung stattfinden, um ggf. unterschiedliche aber funktionierende Schreibweisen des Datenbankservernamens abzudecken.
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2352
DialogForm
get DialogForm(): DialogForm
Liefert ein Objekt vom Objekt DialogForm zurück.
Example
Der Aufruf könnte wie folgt aussehen:
let dialogForm : DialogForm;
try {
try {
dialogForm = cRM.DialogForm;
} catch (error) {
if (error instanceof (Error)) {
cRM.DialogMessageBox("Der Vorgang wird beendet\nAuf das Objekt zur Darstellung des combit CRM Dialogfensters konnte nicht zugegriffen werden.\n\n" + error.message ,"Dialogfenster kann nicht angezeigt werden", 48);
return;
}
}
//... Verwendung des DialogForm Objekts
} finally {
dialogForm?.Dispose();
}
Remarks
Vor der Rückgabe der DialogForm wird eine Registrierungsprüfung der combit DialogForm Komponente durchgeführt.
Sollte diese Registrierung nicht vorhanden sein oder ein unerwartetes Ergebnis zurückliefern wird ein Fehler ausgelöst.
Daher wird empfohlen den Aufruf dieser Eigenschaft nur innerhalb eines vollständigen Fehlerhandlings durchzuführen.
Throws
DialogFormInvalidRegistrationException - Wird ausgelöst wenn die Registrierung der combit DialogForm Komponente nicht gefunden oder ungültig ist
Rückgabewert
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2388
Edition
get Edition(): number
Liefert die Edition zurück.
Rückgabewert
number
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2406
FileVersion
get FileVersion(): number
Rückgabe der Dateiversion der installierten Anwendung.
Rückgabewert
number
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2415
IsDisposed
get IsDisposed(): boolean
Gibt an, ob das Objekt bereits Freigegeben wurde
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2596
MainWindowHandle
get MainWindowHandle(): number
Liefert das Haupt-Fensterhandle zurück.
Rückgabewert
number
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2424
NonInteractive
get NonInteractive(): boolean
Abfrage, ob der CRM ohne GUI gestartet wurde
set NonInteractive(val): void
Abfrage, ob der CRM ohne GUI gestartet wurde
Parameter
| Parameter | Type |
|---|---|
val | boolean |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2513
PhoneManager
get PhoneManager(): PhoneManager
Liefert das PhoneManager Objekt zurück.
Rückgabewert
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2433
ProcessID
get ProcessID(): number
Liefert die ProzessId zurück.
Rückgabewert
number
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2450
ProductVersion
get ProductVersion(): number
Rückgabe der Produkt-Versionsnummer der installierten Anwendung.
Rückgabewert
number
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2459
SerialNumber
get SerialNumber(): string
Rückgabe der Seriennummer
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2468
ServerAppDir
get ServerAppDir(): string
Rückgabe des Pfads der Serverinstallation. Im Fall einer Einzelplatzversion wird der Wert der Eigenschaft AppDir zurückgegeben
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2477
TempDir
get TempDir(): string
Rückgabe des Benutzer Temp-Verzeichnisses
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2486
TimeManagerType
get TimeManagerType(): number
Rückgabe der eingestellten Terminverwaltung.
Rückgabewert
number
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2495
TrialVersion
get TrialVersion(): boolean
Abfrage, ob die aktuelle Version eine Demoversion ist
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2504
UILanguageID
get UILanguageID(): number
Liefert die Sprachkonstante (LANGID gemäß Microsoft Windows SDK) der aktuell eingestellten Sprache des Benutzerinterfaces.Der Wert korrespondiert zu den ".lng"-Unterverzeichnissen der Installation
Rückgabewert
number
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2529
Version
get Version(): number
Rückgabe der Versionsnummer der installierten Anwendung
Rückgabewert
number
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2538
Visible
get Visible(): boolean
Gibt den Anzeigezustand der Anwendung zurück oder setzt diesen.
Standardmäßig ist beim Zugriff per COM der Anzeigezustand der Anwendung unsichtbar ( false ).
set Visible(val): void
Gibt den Anzeigezustand der Anwendung zurück oder setzt diesen.
Standardmäßig ist beim Zugriff per COM der Anzeigezustand der Anwendung unsichtbar ( false ).
Parameter
| Parameter | Type |
|---|---|
val | boolean |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2548
Methoden
CheckAbortedWaitDlg()
CheckAbortedWaitDlg(): boolean
Die Methode muss zwischen StartWaitDlg(text: string, cancel: boolean, initialDelay: number) und EndWaitDlg() aufgerufen werden und gibt zurück, ob der Benutzer die Schaltfläche "Abbrechen" des Wartedialoges betätigt hat, sofern StartWaitDlg mit AbbruchSchaltfläche angezeigt wurde. Die Methode wird vorzugsweise in Ausführungsschleifen verwendet.
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2619
ConvertHTML2PlainText()
ConvertHTML2PlainText(input): string
Konvertiert einen als HTML übergebenen String nach Klartext
Parameter
| Parameter | Type | Description |
|---|---|---|
input | string | Zu konvertierender HTML-String |
Rückgabewert
string
Klartext
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2631
ConvertLocalToUTCDateTime()
ConvertLocalToUTCDateTime(localDateTime): Date
Gibt das UTC-Datum und –Zeit zurück. Dies wird für die Konvertierung der Termine und Aufgaben benötigt, da eine Speicherung in die Datenbanktabelle(cmbt_tm_appointments = Termine | cmbt_tm_todos = Aufgabe) im UTC-Format erfolgt.
Diese Verwendung finden Sie in der Info-Zentrale des mitgelieferten Beispiel Projektes
Parameter
| Parameter | Type | Description |
|---|---|---|
localDateTime | Date | Lokales Datum und Uhrzeit |
Rückgabewert
Date
UTC-Datum
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2644
ConvertPlainText2HTML()
ConvertPlainText2HTML(input): string
Konvertiert einen als Klartext übergebenen String nach HTML
Parameter
| Parameter | Type | Description |
|---|---|---|
input | string | Zu konvertierender Klartext |
Rückgabewert
string
HTML
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2656
ConvertUTCToLocalDateTime()
ConvertUTCToLocalDateTime(utcDate): Date
Gibt das lokale Datum und die Uhrzeit anhand des UTC-Datums zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
utcDate | Date | UTC-Datum und Uhrzeit |
Rückgabewert
Date
Lokales Datum
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2668
CreateGUID()
CreateGUID(): string
Erzeugt einen global eindeutigen Identifier und gibt diesen als unformatierte Zeichenkette zurück
Rückgabewert
string
Uniqueidentifier im combit Format
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2679
CreatePKCEVerifierAndChallenge()
CreatePKCEVerifierAndChallenge(): string
Erzeugt einen Proof Key for Code Exchange gemäß RFC 7636, beispielsweise zur Verwendung in OAuthWorkflows. Der Rückgabewert besteht aus zwei per TAB-Trennzeichen getrennten String-Tokens: CodeVerifier und Code-Challenge. Details: https://www.oauth.com/oauth2\-servers/pkce/
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2688
CreateTempFile()
CreateTempFile(
prefix,
fileExtension,
autoRemove): string
Erzeugt im System-Verzeichnis %TEMP% eine temporäre eindeutige Datei ohne Inhalt und gibt deren Dateiname zurück. In diese Datei kann anschließend bspw. Über die Methode GetContentsByNameToFile der Inhalt eines Feldes vom Typ "Eingebettete Datei" oder "Eingebettete Grafik" gespeichert werden ohne das es Probleme mit einem nicht-eindeutigen Dateinamen gibt.
Parameter
| Parameter | Type | Description |
|---|---|---|
prefix | string | Präfix des Dateinamens |
fileExtension | string | Dateiendung |
autoRemove | boolean | true wenn die Datei beim Beenden der Anwendung gelöscht werden soll, andernfalls false |
Rückgabewert
string
Pfad zur temporären Datei
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2702
DebugOutput()
DebugOutput(output): void
Debugausgabe in Debwin
Parameter
| Parameter | Type | Description |
|---|---|---|
output | string | Nachricht für die Debugausgabe. Eine Anpassung des Ereignisprotokollgrades (Information, Warnung, Kritisch) für die Ausgabe in Debwin kann über die folgenden Bezeichner vorgenommen werden: (i) = Information (!) = Warnung (x) = Kritisch Einer dieser Bezeichner kann zu Beginn der Debugausgabe und mit einem Leerzeichen getrennt vom eigentlichen Inhalt verwendet werden. |
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2717
Decrypt()
Decrypt(input, key): string
Entschlüsselt einen Text anhand eines übergebenen Keys
Parameter
| Parameter | Type | Description |
|---|---|---|
input | string | Zu entschlüsselnder Text |
key | string | Passphrase |
Rückgabewert
string
Entschlüsselter Text
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3915
DialogAddressAssistant()
DialogAddressAssistant(mode, inputAddress)
DialogAddressAssistant(mode, inputAddress): string
Zeigt den Adresseingabe-Assistent für eine übergebene Adresse an oder ergänzt die Adresse mit fehlenden Informationen
Parameter
| Parameter | Type | Description |
|---|---|---|
mode | number | Wert 0: Der Adresseingabeassistent wird angezeigt. Wert 1: Der Adresseingabeassistent wird lediglich bei unvollständiger oder mehrdeutiger Adresse angezeigt.Sind alle Bestandteile der Adresse gültig oder kann eine Adresse mit weniger Bestandteilen eindeutig zurückgeliefert werden, wird der Adresseingabeassistent nicht angezeigt. |
inputAddress | string | Ermöglicht die TAB-getrennte Übergabe von Adressinformationen im nachfolgenden Format: "Land" & TAB & "Ort" & TAB & "PLZ" & TAB & "Straße" & TAB & "Hausnummer". Nicht vorhandene Adressbestandteile können leer gelassen werden. Wird die Hausnummer nicht separat von der Straße geführt, dann kann dieser Bestandteil leer gelassen und die Hausnummer im Straßenbestandteil zusammen mit der Straße übergeben werden. Wichtig: Die Angabe des Landes gemäß der Länderkonfiguration in den Ansichtseigenschaften ist obligatorisch. |
Rückgabewert
string
String (TAB-getrennte Liste mit folgenden Bestandteilen: Land, Ort, PLZ, Straße, Hausnummer, Vorwahl, Bundesland/Kanton, Regierungsbezirk, Landkreis, $CANCEL$ bei Abbruch)
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2732
DialogAddressAssistant(mode, inputAddress, parentHandle)
DialogAddressAssistant(
mode,
inputAddress,
parentHandle): string
Zeigt den Adresseingabe-Assistent für eine übergebene Adresse an oder ergänzt die Adresse mit fehlenden Informationen
Parameter
| Parameter | Type | Description |
|---|---|---|
mode | number | Wert 0: Der Adresseingabeassistent wird angezeigt. Wert 1: Der Adresseingabeassistent wird lediglich bei unvollständiger oder mehrdeutiger Adresse angezeigt.Sind alle Bestandteile der Adresse gültig oder kann eine Adresse mit weniger Bestandteilen eindeutig zurückgeliefert werden, wird der Adresseingabeassistent nicht angezeigt. |
inputAddress | string | Ermöglicht die TAB-getrennte Übergabe von Adressinformationen im nachfolgenden Format: "Land" & TAB & "Ort" & TAB & "PLZ" & TAB & "Straße" & TAB & "Hausnummer". Nicht vorhandene Adressbestandteile können leer gelassen werden. Wird die Hausnummer nicht separat von der Straße geführt, dann kann dieser Bestandteil leer gelassen und die Hausnummer im Straßenbestandteil zusammen mit der Straße übergeben werden. Wichtig: Die Angabe des Landes gemäß der Länderkonfiguration in den Ansichtseigenschaften ist obligatorisch. |
parentHandle | number | Ermöglicht die Übergabe eines Handles für das Elternfenster |
Rückgabewert
string
String (TAB-getrennte Liste mit folgenden Bestandteilen: Land, Ort, PLZ, Straße, Hausnummer, Vorwahl, Bundesland/Kanton, Regierungsbezirk, Landkreis, $CANCEL$ bei Abbruch)
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2745
DialogChoiceMessageBox()
DialogChoiceMessageBox(message, title, choices, icon, enableCancel)
DialogChoiceMessageBox(
message,
title,
choices,
icon,
enableCancel): number
Zeigt einen Dialog zur Auswahl von übergebenen Einträgen an.
Parameter
| Parameter | Type | Description |
|---|---|---|
message | string | Nachricht des Dialogs |
title | string | Titel des Dialogs |
choices | string | Über diesen Parameter bestimmen Sie die Auswahlmöglichkeiten. Zum Beispiel: "Thomas Held" & \t & "Laura Frisch" & \t & "Lisa Nett" |
icon | number | Bestimmt das neben der Auswahl dargestellte Symbol: 1: Information 2: Warnung 3: Fehler 4: Schild 5: Frage |
enableCancel | boolean | Bestimmt, ob eine "Abbrechen"-Schaltfläche angezeigt werden soll. |
Rückgabewert
number
Wenn der Nutzer eine Auswahl getroffen hat, dann wird ein OffSet von 100 einberechnet, d.h.bei Klick der zweiten Auswahl ist der Rückgabewert 102.
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2776
DialogChoiceMessageBox(message, title, choices, icon, enableCancel, parentHandle)
DialogChoiceMessageBox(
message,
title,
choices,
icon,
enableCancel,
parentHandle): number
Zeigt einen Dialog zur Auswahl von übergebenen Einträgen an.
Parameter
| Parameter | Type | Description |
|---|---|---|
message | string | Nachricht des Dialogs |
title | string | Titel des Dialogs |
choices | string | Über diesen Parameter bestimmen Sie die Auswahlmöglichkeiten. Zum Beispiel: "Thomas Held" & \t & "Laura Frisch" & \t & "Lisa Nett" |
icon | number | Bestimmt das neben der Auswahl dargestellte Symbol: 1: Information 2: Warnung 3: Fehler 4: Schild 5: Frage |
enableCancel | boolean | Bestimmt, ob eine "Abbrechen"-Schaltfläche angezeigt werden soll. |
parentHandle | number | Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll. |
Rückgabewert
number
Wenn der Nutzer eine Auswahl getroffen hat, dann wird ein OffSet von 100 einberechnet, d.h.bei Klick der zweiten Auswahl ist der Rückgabewert 102.
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2795
DialogInputBox()
DialogInputBox(prompt)
DialogInputBox(prompt): string
Zeigt einen Eingabedialog an und gibt den eingetragenen Wert zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
prompt | string | Information, die im Dialog angezeigt werden soll. |
Rückgabewert
string
Benutzereingabe oder $CANCEL$ bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2817
DialogInputBox(prompt, title)
DialogInputBox(prompt, title): string
Zeigt einen Eingabedialog an und gibt den eingetragenen Wert zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
prompt | string | Information, die im Dialog angezeigt werden soll. |
title | string | Titel des Dialogs. |
Rückgabewert
string
Benutzereingabe oder $CANCEL$ bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2827
DialogInputBox(prompt, title, defaultValue)
DialogInputBox(
prompt,
title,
defaultValue): string
Zeigt einen Eingabedialog an und gibt den eingetragenen Wert zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
prompt | string | Information, die im Dialog angezeigt werden soll. |
title | string | Titel des Dialogs. |
defaultValue | string | Voreingestellter Wert für die Eingabe. |
Rückgabewert
string
Benutzereingabe oder $CANCEL$ bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2838
DialogInputBox(prompt, title, defaultValue, inputType)
DialogInputBox(
prompt,
title,
defaultValue,
inputType): string
Zeigt einen Eingabedialog an und gibt den eingetragenen Wert zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
prompt | string | Information, die im Dialog angezeigt werden soll. |
title | string | Titel des Dialogs. |
defaultValue | string | Voreingestellter Wert für die Eingabe. |
inputType | number | Reserviert. Der Parameterwert wird derzeit ignoriert. |
Rückgabewert
string
Benutzereingabe oder $CANCEL$ bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2850
DialogInputBox(prompt, title, defaultValue, inputType, maxInputLenght)
DialogInputBox(
prompt,
title,
defaultValue,
inputType,
maxInputLenght): string
Zeigt einen Eingabedialog an und gibt den eingetragenen Wert zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
prompt | string | Information, die im Dialog angezeigt werden soll. |
title | string | Titel des Dialogs. |
defaultValue | string | Voreingestellter Wert für die Eingabe. |
inputType | number | Reserviert. Der Parameterwert wird derzeit ignoriert. |
maxInputLenght | number | Maximale Länge der Benutzereingabe. |
Rückgabewert
string
Benutzereingabe oder $CANCEL$ bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2863
DialogInputBox(prompt, title, defaultValue, inputType, maxInputLenght, parentHandle)
DialogInputBox(
prompt,
title,
defaultValue,
inputType,
maxInputLenght,
parentHandle): string
Zeigt einen Eingabedialog an und gibt den eingetragenen Wert zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
prompt | string | Information, die im Dialog angezeigt werden soll. |
title | string | Titel des Dialogs. |
defaultValue | string | Voreingestellter Wert für die Eingabe. |
inputType | number | Reserviert. Der Parameterwert wird derzeit ignoriert. |
maxInputLenght | number | Maximale Länge der Benutzereingabe. |
parentHandle | number | Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll. |
Rückgabewert
string
Benutzereingabe oder $CANCEL$ bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2877
DialogInputBoxMultiline()
DialogInputBoxMultiline(prompt)
DialogInputBoxMultiline(prompt): string
Zeigt einen Eingabedialog mit einem mehrzeiligen Eingabefeld an und gibt den eingetragenen Wert zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
prompt | string | Information, die im Dialog angezeigt werden soll.Beachten Sie bitte, dass keine Umbrüche unterstützt werden. |
Rückgabewert
string
Benutzereingabe oder $CANCEL$ bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2911
DialogInputBoxMultiline(prompt, title)
DialogInputBoxMultiline(prompt, title): string
Zeigt einen Eingabedialog mit einem mehrzeiligen Eingabefeld an und gibt den eingetragenen Wert zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
prompt | string | Information, die im Dialog angezeigt werden soll.Beachten Sie bitte, dass keine Umbrüche unterstützt werden. |
title | string | Titel des Dialogs. |
Rückgabewert
string
Benutzereingabe oder $CANCEL$ bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2921
DialogInputBoxMultiline(prompt, title, defaultValue)
DialogInputBoxMultiline(
prompt,
title,
defaultValue): string
Zeigt einen Eingabedialog mit einem mehrzeiligen Eingabefeld an und gibt den eingetragenen Wert zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
prompt | string | Information, die im Dialog angezeigt werden soll.Beachten Sie bitte, dass keine Umbrüche unterstützt werden. |
title | string | Titel des Dialogs. |
defaultValue | string | Voreingestellter Wert für die Eingabe. |
Rückgabewert
string
Benutzereingabe oder $CANCEL$ bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2932
DialogInputBoxMultiline(prompt, title, defaultValue, syntaxColoring)
DialogInputBoxMultiline(
prompt,
title,
defaultValue,
syntaxColoring): string
Zeigt einen Eingabedialog mit einem mehrzeiligen Eingabefeld an und gibt den eingetragenen Wert zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
prompt | string | Information, die im Dialog angezeigt werden soll.Beachten Sie bitte, dass keine Umbrüche unterstützt werden. |
title | string | Titel des Dialogs. |
defaultValue | string | Voreingestellter Wert für die Eingabe. |
syntaxColoring | string | Angabe, für welche Syntax ein Highlighting bzw. Coloring erfolgen soll. Mögliche Werte: "sql", "script", "" (wenn leer, wird kein Highlighting bzw.Coloring dargestellt). |
Rückgabewert
string
Benutzereingabe oder $CANCEL$ bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2944
DialogInputBoxMultiline(prompt, title, defaultValue, syntaxColoring, maxInputLenght)
DialogInputBoxMultiline(
prompt,
title,
defaultValue,
syntaxColoring,
maxInputLenght): string
Zeigt einen Eingabedialog mit einem mehrzeiligen Eingabefeld an und gibt den eingetragenen Wert zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
prompt | string | Information, die im Dialog angezeigt werden soll.Beachten Sie bitte, dass keine Umbrüche unterstützt werden. |
title | string | Titel des Dialogs. |
defaultValue | string | Voreingestellter Wert für die Eingabe. |
syntaxColoring | string | Angabe, für welche Syntax ein Highlighting bzw. Coloring erfolgen soll. Mögliche Werte: "sql", "script", "" (wenn leer, wird kein Highlighting bzw.Coloring dargestellt). |
maxInputLenght | number | aximale Länge der Benutzereingabe. |
Rückgabewert
string
Benutzereingabe oder $CANCEL$ bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2957
DialogInputBoxMultiline(prompt, title, defaultValue, syntaxColoring, maxInputLenght, parentHandle)
DialogInputBoxMultiline(
prompt,
title,
defaultValue,
syntaxColoring,
maxInputLenght,
parentHandle): string
Zeigt einen Eingabedialog mit einem mehrzeiligen Eingabefeld an und gibt den eingetragenen Wert zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
prompt | string | Information, die im Dialog angezeigt werden soll.Beachten Sie bitte, dass keine Umbrüche unterstützt werden. |
title | string | Titel des Dialogs. |
defaultValue | string | Voreingestellter Wert für die Eingabe. |
syntaxColoring | string | Angabe, für welche Syntax ein Highlighting bzw. Coloring erfolgen soll. Mögliche Werte: "sql", "script", "" (wenn leer, wird kein Highlighting bzw.Coloring dargestellt). |
maxInputLenght | number | Maximale Länge der Benutzereingabe. |
parentHandle | number | Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll. |
Rückgabewert
string
Benutzereingabe oder $CANCEL$ bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2971
DialogMessageBox()
DialogMessageBox(message, title, style)
DialogMessageBox(
message,
title,
style): number
Zeigt einen Dialog zur Ausgabe von Informationen im cRM-Stil an
Parameter
| Parameter | Type | Description |
|---|---|---|
message | string | Nachricht des Dialogs. Bitte beachten Sie, dass bei der Verwendung eines Zeilenumbruchs (\n) der erste Abschnitt bis zum Zeilenumbruch in einer größeren Schrift dargestellt wird.Der nachfolgende Abschnitt erhält eine kleinere Schriftgröße. |
title | string | Titel des Dialogs. |
style | number | Dieser Parameter bestimmt mittels Übergabe von Konstanten das Aussehen des Dialogs. |
Rückgabewert
number
Der Rückgabewert entspricht den Konstanten einer MsgBox unter VBScript
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3007
DialogMessageBox(message, title, style, parentHandle)
DialogMessageBox(
message,
title,
style,
parentHandle): number
Zeigt einen Dialog zur Ausgabe von Informationen im cRM-Stil an
Parameter
| Parameter | Type | Description |
|---|---|---|
message | string | Nachricht des Dialogs. Bitte beachten Sie, dass bei der Verwendung eines Zeilenumbruchs (\n) der erste Abschnitt bis zum Zeilenumbruch in einer größeren Schrift dargestellt wird.Der nachfolgende Abschnitt erhält eine kleinere Schriftgröße. |
title | string | Titel des Dialogs. |
style | number | Dieser Parameter bestimmt mittels Übergabe von Konstanten das Aussehen des Dialogs. |
parentHandle | number | Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden. |
Rückgabewert
number
Der Rückgabewert entspricht den Konstanten einer MsgBox unter VBScript
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3019
DialogMessageBoxAuto()
DialogMessageBoxAuto(message, title, style, autoMessageId)
DialogMessageBoxAuto(
message,
title,
style,
autoMessageId): number
Zeigt einen Dialog zur Ausgabe von Informationen im cRM-Stil an. Zusätzlich wird eine Option "In Zukunft nicht mehr anzeigen" bereitgestellt.
Parameter
| Parameter | Type | Description |
|---|---|---|
message | string | Nachricht des Dialogs. Bitte beachten Sie, dass bei der Verwendung eines Zeilenumbruchs (\n) der erste Abschnitt bis zum Zeilenumbruch in einer größeren Schrift dargestellt wird.Der nachfolgende Abschnitt erhält eine kleinere Schriftgröße. |
title | string | Titel des Dialogs. |
style | number | Dieser Parameter bestimmt mittels Übergabe von Konstanten das Aussehen des Dialogs. |
autoMessageId | string | Eindeutige ID in Form einer Zeichenkette zur Speicherung der Auswahl für den Wert "In Zukunft nicht mehr anzeigen". |
Rückgabewert
number
Der Rückgabewert entspricht den Konstanten einer MsgBox unter VBScript
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3044
DialogMessageBoxAuto(message, title, style, autoMessageId, parentHandle)
DialogMessageBoxAuto(
message,
title,
style,
autoMessageId,
parentHandle): number
Zeigt einen Dialog zur Ausgabe von Informationen im cRM-Stil an. Zusätzlich wird eine Option "In Zukunft nicht mehr anzeigen" bereitgestellt.
Parameter
| Parameter | Type | Description |
|---|---|---|
message | string | Nachricht des Dialogs. Bitte beachten Sie, dass bei der Verwendung eines Zeilenumbruchs (\n) der erste Abschnitt bis zum Zeilenumbruch in einer größeren Schrift dargestellt wird.Der nachfolgende Abschnitt erhält eine kleinere Schriftgröße. |
title | string | Titel des Dialogs. |
style | number | Dieser Parameter bestimmt mittels Übergabe von Konstanten das Aussehen des Dialogs. |
autoMessageId | string | Eindeutige ID in Form einer Zeichenkette zur Speicherung der Auswahl für den Wert "In Zukunft nicht mehr anzeigen". |
parentHandle | number | Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden. |
Rückgabewert
number
Der Rückgabewert entspricht den Konstanten einer MsgBox unter VBScript
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3057
DialogSelectColor()
DialogSelectColor()
DialogSelectColor(): number
Zeigt einen Farbauswahldialog an und gibt den ausgewählten Farbwert zurück
Rückgabewert
number
Ausgewählter Farbwert oder -1 bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3078
DialogSelectColor(currentColor)
DialogSelectColor(currentColor): number
Zeigt einen Farbauswahldialog an und gibt den ausgewählten Farbwert zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
currentColor | number | Aktuelle Farbe. Wenn dieser Parameter nicht übergeben wird, wird Schwarz verwendet. |
Rückgabewert
number
Ausgewählter Farbwert oder -1 bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3087
DialogSelectColor(currentColor, defaultColor)
DialogSelectColor(currentColor, defaultColor): number
Zeigt einen Farbauswahldialog an und gibt den ausgewählten Farbwert zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
currentColor | number | Aktuelle Farbe. Wenn dieser Parameter nicht übergeben wird, wird Schwarz verwendet. |
defaultColor | number | Neue Farbe, die vorausgewählt werden soll. Wenn dieser Parameter nicht angegeben wird, wird die aktuelle Farbe (vgl.Parameter currentColor ) verwendet. |
Rückgabewert
number
Ausgewählter Farbwert oder -1 bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3097
DialogSelectColor(currentColor, defaultColor, parentHandle)
DialogSelectColor(
currentColor,
defaultColor,
parentHandle): number
Zeigt einen Farbauswahldialog an und gibt den ausgewählten Farbwert zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
currentColor | number | Aktuelle Farbe. Wenn dieser Parameter nicht übergeben wird, wird Schwarz verwendet. |
defaultColor | number | Neue Farbe, die vorausgewählt werden soll. Wenn dieser Parameter nicht angegeben wird, wird die aktuelle Farbe (vgl.Parameter currentColor ) verwendet. |
parentHandle | number | Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden. |
Rückgabewert
number
Ausgewählter Farbwert oder -1 bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3108
DialogSelectDir()
DialogSelectDir(title, openFileDlg, initialPath, dwFlags)
DialogSelectDir(
title,
openFileDlg,
initialPath,
dwFlags): string
Zeigt einen Verzeichnisauswahldialog an und gibt den ausgewählten Verzeichnispfad zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
title | string | Dialogtitel |
openFileDlg | boolean | true Verzeichnis Öffnen false Verzeichnis Speichern. |
initialPath | string | Initielles Verzeichnis als Voreinstellung für den Dialog oder leer. |
dwFlags | number | Reserviert, muss 0 sein |
Rückgabewert
string
Ausgewählter Verzeichnispfad oder leer bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3136
DialogSelectDir(title, openFileDlg, initialPath, dwFlags, parentHandle)
DialogSelectDir(
title,
openFileDlg,
initialPath,
dwFlags,
parentHandle): string
Zeigt einen Verzeichnisauswahldialog an und gibt den ausgewählten Verzeichnispfad zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
title | string | Dialogtitel |
openFileDlg | boolean | true Verzeichnis Öffnen false Verzeichnis Speichern. |
initialPath | string | Initielles Verzeichnis als Voreinstellung für den Dialog oder leer. |
dwFlags | number | Reserviert, muss 0 sein |
parentHandle | number | Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden. |
Rückgabewert
string
Ausgewählter Verzeichnispfad oder leer bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3150
DialogSelectFile()
DialogSelectFile(title, openFileDlg, initialPath, fileFilter, dwFlags)
DialogSelectFile(
title,
openFileDlg,
initialPath,
fileFilter,
dwFlags): string
Zeigt einen Dateiauswahldialog an und gibt den ausgewählten Dateipfad zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
title | string | Dialogtitel |
openFileDlg | boolean | true Datei Öffnen false Datei Speichern. |
initialPath | string | Initielles Verzeichnis als Voreinstellung für den Dialog oder leer. Kann einen kompletten Dateipfad enthalten oder leer sein. |
fileFilter | string | Kann eine Liste von Dateifiltern enthalten oder leer sein. Format: BeschreibungFilter1 |
dwFlags | number | Bestimmt die Interaktion mit dem Dialog (Beschreibung siehe MSDN unter 'OPENFILENAME') |
Rückgabewert
string
Ausgewählter Dateipfad oder leer bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3178
DialogSelectFile(title, openFileDlg, initialPath, fileFilter, dwFlags, parentHandle)
DialogSelectFile(
title,
openFileDlg,
initialPath,
fileFilter,
dwFlags,
parentHandle): string
Zeigt einen Dateiauswahldialog an und gibt den ausgewählten Dateipfad zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
title | string | Dialogtitel |
openFileDlg | boolean | true Datei Öffnen false Datei Speichern. |
initialPath | string | Initielles Verzeichnis als Voreinstellung für den Dialog oder leer. Kann einen kompletten Dateipfad enthalten oder leer sein. |
fileFilter | string | Kann eine Liste von Dateifiltern enthalten oder leer sein. Format: BeschreibungFilter1 |
dwFlags | number | Bestimmt die Interaktion mit dem Dialog (Beschreibung siehe MSDN unter 'OPENFILENAME') |
parentHandle | number | Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden. |
Rückgabewert
string
Ausgewählter Dateipfad oder leer bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3194
DialogSelectString()
DialogSelectString(message, choices, sortChoices, allowMultiSelect, allowFilter, profileKey)
DialogSelectString(
message,
choices,
sortChoices,
allowMultiSelect,
allowFilter,
profileKey): string
Zeigt einen Dialog zur Auswahl eines oder mehrerer Strings an.
Parameter
| Parameter | Type | Description |
|---|---|---|
message | string | Information oder Frage, die im Titel des Dialogs angezeigt werden soll. |
choices | string | TAB-getrennte Liste mit Auswahlmöglichkeiten. Beginnt ein TAB-getrennter Eintrag mit einem *, dann wird dieser Eintrag vorausgewählt. |
sortChoices | number | 0: Reihenfolge der Einträge wird nicht sortiert. 1: Alphabetisch aufsteigende Reihenfolge der Einträge(keine Beachtung von Groß- und Kleinschreibung). -1: Alphabetisch absteigende Reihenfolge der Einträge(keine Beachtung von Groß- und Kleinschreibung). |
allowMultiSelect | boolean | true : Mehrfachauswahl von Einträgen ist möglich false : Mehrfachauswahl von Einträgen ist nicht möglich |
allowFilter | boolean | true : Suche innerhalb der Auflistung der Einträge ermöglicht false : Suche innerhalb der Auflistung der Einträge nicht ermöglicht |
profileKey | string | Name, unter welchem innerhalb der Registrierung im nachfolgenden Schlüssel die letzte Auswahl gespeichert und beim nächsten Mal automatisch geladen werden soll. Wenn neue Einträge mit einem * übergeben wurden, sodass diese vorausgewählt angezeigt werden sollen, dann überschreiben die neuen Einträge die bestehende Vorauswahl aus der Registrierung. Folgender Registrierungsschlüssel wird verwendet:HKEY_CURRENT_USER\Software\combit\combit Relationship Manager\Projects\{Name des Projektes}\COMDialogSelectString |
Rückgabewert
string
Ausgewählte Strings (TAB-getrennt bei Mehrfachauswahl) oder $CANCEL$ bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3226
DialogSelectString(message, choices, sortChoices, allowMultiSelect, allowFilter, profileKey, parentHandle)
DialogSelectString(
message,
choices,
sortChoices,
allowMultiSelect,
allowFilter,
profileKey,
parentHandle): string
Zeigt einen Dialog zur Auswahl eines oder mehrerer Strings an.
Parameter
| Parameter | Type | Description |
|---|---|---|
message | string | Information oder Frage, die im Titel des Dialogs angezeigt werden soll. |
choices | string | TAB-getrennte Liste mit Auswahlmöglichkeiten. Beginnt ein TAB-getrennter Eintrag mit einem *, dann wird dieser Eintrag vorausgewählt. |
sortChoices | number | 0: Reihenfolge der Einträge wird nicht sortiert. 1: Alphabetisch aufsteigende Reihenfolge der Einträge(keine Beachtung von Groß- und Kleinschreibung). -1: Alphabetisch absteigende Reihenfolge der Einträge(keine Beachtung von Groß- und Kleinschreibung). |
allowMultiSelect | boolean | true : Mehrfachauswahl von Einträgen ist möglich false : Mehrfachauswahl von Einträgen ist nicht möglich |
allowFilter | boolean | true : Suche innerhalb der Auflistung der Einträge ermöglicht false : Suche innerhalb der Auflistung der Einträge nicht ermöglicht |
profileKey | string | Name, unter welchem innerhalb der Registrierung im nachfolgenden Schlüssel die letzte Auswahl gespeichert und beim nächsten Mal automatisch geladen werden soll. Wenn neue Einträge mit einem * übergeben wurden, sodass diese vorausgewählt angezeigt werden sollen, dann überschreiben die neuen Einträge die bestehende Vorauswahl aus der Registrierung. Folgender Registrierungsschlüssel wird verwendet:HKEY_CURRENT_USER\Software\combit\combit Relationship Manager\Projects\{Name des Projektes}\COMDialogSelectString |
parentHandle | number | Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden. |
Rückgabewert
string
Ausgewählte Strings (TAB-getrennt bei Mehrfachauswahl) oder $CANCEL$ bei Benutzerabbruch
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3246
Dispose()
Dispose(): void
Standardimplementierung des Dispose
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3932
DisposeAsync()
DisposeAsync(): Promise<void>
Standardimplementierung des AsyncDispose
Rückgabewert
Promise<void>
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3921
Encrypt()
Encrypt(input, key): string
Verschlüsselt einen Text anhand eines übergebenen Keys
Parameter
| Parameter | Type | Description |
|---|---|---|
input | string | Zu verschlüsselnder Text |
key | string | Passphrase |
Rückgabewert
string
Verschlüsselter Text
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3902
EndWaitDlg()
EndWaitDlg(): void
Blendet einen zuvor mit StartWaitDlg angezeigten Wartedialog aus.
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3265
FetchGlobalConfigFile()
FetchGlobalConfigFile(srcFilePath, dstFilePath): boolean
Holt die globalen Konfigurationsdateien ohne Projekt-ID.
Parameter
| Parameter | Type | Description |
|---|---|---|
srcFilePath | string | Dateiname in der cmbt_Files Tabelle in der System-Datenbank |
dstFilePath | string | Dateiname, unter dem die Datei abgespeichert werden soll. |
Rückgabewert
boolean
true wenn der Befehl erfolgreich ausgeführt wurde, andernfalls false
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3278
GetIniProfileString()
GetIniProfileString(
section,
property,
defaultValue,
iniFile): string
Liest einen Eintrag aus einer INI-Datei aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
section | string | Name der Sektion in der INI-Datei, in der der zu lesende Eintrag steht. |
property | string | Name des zu lesenden Eintrags. |
defaultValue | string | Der Standardwert, der zurückgegeben wird, wenn kein Eintrag mit dem angegebenen Namen existiert. |
iniFile | string | Pfad zur INI-Datei. |
Rückgabewert
string
Eintrag der INI-Datei
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3311
GetMessageText()
GetMessageText(resourceFileName, id)
GetMessageText(resourceFileName, id): string
Lädt Texte aus einer Messages.txt im Projektverzeichnis. Falls die Oberflächen-Sprache auf Englisch eingestellt ist, dann aus der "Messages.0009.lng.txt".
Voraussetzung ist, dass ein Projekt geladen wurde, anderenfalls kommt es zu einem "Zugriff verweigert" Scriptfehler
Parameter
| Parameter | Type | Description |
|---|---|---|
resourceFileName | string | Reserviert - Es kann eine leere Zeichenkette übergeben werden |
id | string | Name des Eintrags aus der Messages.txt |
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3323
GetMessageText(resourceFileName, id, param1)
GetMessageText(
resourceFileName,
id,
param1): string
Lädt Texte aus einer Messages.txt im Projektverzeichnis. Falls die Oberflächen-Sprache auf Englisch eingestellt ist, dann aus der "Messages.0009.lng.txt".
Voraussetzung ist, dass ein Projekt geladen wurde, anderenfalls kommt es zu einem "Zugriff verweigert" Scriptfehler
Parameter
| Parameter | Type | Description |
|---|---|---|
resourceFileName | string | Reserviert - Es kann eine leere Zeichenkette übergeben werden |
id | string | Name des Eintrags aus der Messages.txt |
param1 | string | Erster Parameter, um Informationen für den Platzhalter {0} innerhalb der des Textes zu befüllen. |
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3333
GetMessageText(resourceFileName, id, param1, param2)
GetMessageText(
resourceFileName,
id,
param1,
param2): string
Lädt Texte aus einer Messages.txt im Projektverzeichnis. Falls die Oberflächen-Sprache auf Englisch eingestellt ist, dann aus der "Messages.0009.lng.txt".
Voraussetzung ist, dass ein Projekt geladen wurde, anderenfalls kommt es zu einem "Zugriff verweigert" Scriptfehler
Parameter
| Parameter | Type | Description |
|---|---|---|
resourceFileName | string | Reserviert - Es kann eine leere Zeichenkette übergeben werden |
id | string | Name des Eintrags aus der Messages.txt |
param1 | string | Erster Parameter, um Informationen für den Platzhalter {0} innerhalb der des Textes zu befüllen. |
param2 | string | Zweiter Parameter, um Informationen für den Platzhalter {1} innerhalb der des Textes zu befüllen. |
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3344
GetMessageText(resourceFileName, id, param1, param2, param3)
GetMessageText(
resourceFileName,
id,
param1,
param2,
param3): string
Lädt Texte aus einer Messages.txt im Projektverzeichnis. Falls die Oberflächen-Sprache auf Englisch eingestellt ist, dann aus der "Messages.0009.lng.txt".
Voraussetzung ist, dass ein Projekt geladen wurde, anderenfalls kommt es zu einem "Zugriff verweigert" Scriptfehler
Parameter
| Parameter | Type | Description |
|---|---|---|
resourceFileName | string | Reserviert - Es kann eine leere Zeichenkette übergeben werden |
id | string | Name des Eintrags aus der Messages.txt |
param1 | string | Erster Parameter, um Informationen für den Platzhalter {0} innerhalb der des Textes zu befüllen. |
param2 | string | Zweiter Parameter, um Informationen für den Platzhalter {1} innerhalb der des Textes zu befüllen. |
param3 | string | Dritter Parameter, um Informationen für den Platzhalter {2} innerhalb der des Textes zu befüllen. |
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3356
GetMessageText(resourceFileName, id, param1, param2, param3, param4)
GetMessageText(
resourceFileName,
id,
param1,
param2,
param3,
param4): string
Lädt Texte aus einer Messages.txt im Projektverzeichnis. Falls die Oberflächen-Sprache auf Englisch eingestellt ist, dann aus der "Messages.0009.lng.txt".
Voraussetzung ist, dass ein Projekt geladen wurde, anderenfalls kommt es zu einem "Zugriff verweigert" Scriptfehler
Parameter
| Parameter | Type | Description |
|---|---|---|
resourceFileName | string | Reserviert - Es kann eine leere Zeichenkette übergeben werden |
id | string | Name des Eintrags aus der Messages.txt |
param1 | string | Erster Parameter, um Informationen für den Platzhalter {0} innerhalb der des Textes zu befüllen. |
param2 | string | Zweiter Parameter, um Informationen für den Platzhalter {1} innerhalb der des Textes zu befüllen. |
param3 | string | Dritter Parameter, um Informationen für den Platzhalter {2} innerhalb der des Textes zu befüllen. |
param4 | string | Vierter Parameter, um Informationen für den Platzhalter {3} innerhalb der des Textes zu befüllen. |
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3369
GetMessageText(resourceFileName, id, param1, param2, param3, param4, param5)
GetMessageText(
resourceFileName,
id,
param1,
param2,
param3,
param4,
param5): string
Lädt Texte aus einer Messages.txt im Projektverzeichnis. Falls die Oberflächen-Sprache auf Englisch eingestellt ist, dann aus der "Messages.0009.lng.txt".
Voraussetzung ist, dass ein Projekt geladen wurde, anderenfalls kommt es zu einem "Zugriff verweigert" Scriptfehler
Parameter
| Parameter | Type | Description |
|---|---|---|
resourceFileName | string | Reserviert - Es kann eine leere Zeichenkette übergeben werden |
id | string | Name des Eintrags aus der Messages.txt |
param1 | string | Erster Parameter, um Informationen für den Platzhalter {0} innerhalb der des Textes zu befüllen. |
param2 | string | Zweiter Parameter, um Informationen für den Platzhalter {1} innerhalb der des Textes zu befüllen. |
param3 | string | Dritter Parameter, um Informationen für den Platzhalter {2} innerhalb der des Textes zu befüllen. |
param4 | string | Vierter Parameter, um Informationen für den Platzhalter {3} innerhalb der des Textes zu befüllen. |
param5 | string | Fünfter Parameter, um Informationen für den Platzhalter {4} innerhalb der des Textes zu befüllen. |
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3383
GetcRMByProcessID()
GetcRMByProcessID(processId): CRMApplication
Liefert ein bestimmtes cRM-Objekt anhand seiner ProcessID zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
processId | number | ProcessID |
Rückgabewert
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3288
HTTPDelete()
HTTPDelete(url, headerData)
HTTPDelete(url, headerData): string
Sendet einen HTTP-Request mit einer DELETE-Methode
Parameter
| Parameter | Type | Description |
|---|---|---|
url | string | URL des HTTP-Servers. |
headerData | string | JSON-formatierte Zeichenkette. Muss ein Array aus Objekten mit jeweils einem Key und einem Value enthalten. |
Rückgabewert
string
Im Erfolgsfall: String (JSON-formatiert, enthält die Objekte "status" [Statuscode] und "response" [Antwort des Servers])
Im Fehlerfall: String(JSON-formatiert), mit folgendem Aufbau:
{
"status": -1; // Interner / combit Fehler
"error": {
"type": number; // Kann momentan die Werte 0 (UNKNOWN), 1 (INVALID_ARGUMENT), 2 (JSON_ERROR) oder 3 (HTTP_ERROR) enthalten.
"type_string": string; // Entspricht dem Namen des Fehlers, welcher in 'type' enthalten ist.
"error_details": string; // Nur bei type == 2 vorhanden, enthält weitere Informationen wieso die JSON-Formatierung der Serverantwort fehlgeschlagen ist.
"response": string; // Nur bei type == 2 vorhanden, enthält die Serverantwort, allerdings OHNE die Zeichen, welche den aktuellen JSON_ERROR ausgelöst haben.Dient nur zur Information und sollte nicht zur weiteren Datenverarbeitung genutzt werden.
}
}
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3428
HTTPDelete(url, headerData, sendReceiveTimeout)
HTTPDelete(
url,
headerData,
sendReceiveTimeout): string
Sendet einen HTTP-Request mit einer DELETE-Methode
Parameter
| Parameter | Type | Description |
|---|---|---|
url | string | URL des HTTP-Servers. |
headerData | string | JSON-formatierte Zeichenkette. Muss ein Array aus Objekten mit jeweils einem Key und einem Value enthalten. |
sendReceiveTimeout | number | Bestimmt, wie lange der Timeout beim Senden und Empfangen von Daten sein soll. Ein Wert von 0 bedeutet, dass kein Timeout besteht. Positive Werte sind in Millisekunden anzugeben, negative Werte sind ungültig. |
Rückgabewert
string
Im Erfolgsfall: String (JSON-formatiert, enthält die Objekte "status" [Statuscode] und "response" [Antwort des Servers])
Im Fehlerfall: String(JSON-formatiert), mit folgendem Aufbau:
{
"status": -1; // Interner / combit Fehler
"error": {
"type": number; // Kann momentan die Werte 0 (UNKNOWN), 1 (INVALID_ARGUMENT), 2 (JSON_ERROR) oder 3 (HTTP_ERROR) enthalten.
"type_string": string; // Entspricht dem Namen des Fehlers, welcher in 'type' enthalten ist.
"error_details": string; // Nur bei type == 2 vorhanden, enthält weitere Informationen wieso die JSON-Formatierung der Serverantwort fehlgeschlagen ist.
"response": string; // Nur bei type == 2 vorhanden, enthält die Serverantwort, allerdings OHNE die Zeichen, welche den aktuellen JSON_ERROR ausgelöst haben.Dient nur zur Information und sollte nicht zur weiteren Datenverarbeitung genutzt werden.
}
}
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3449
HTTPGET()
HTTPGET(url, headerData)
HTTPGET(url, headerData): string
Sendet einen HTTP-Request mit einer GET-Methode
Parameter
| Parameter | Type | Description |
|---|---|---|
url | string | URL des HTTP-Servers. |
headerData | string | JSON-formatierte Zeichenkette. Muss ein Array aus Objekten mit jeweils einem Key und einem Value enthalten. |
Rückgabewert
string
Im Erfolgsfall: String (JSON-formatiert, enthält die Objekte "status" [Statuscode] und "response" [Antwort des Servers])
Im Fehlerfall: String(JSON-formatiert), mit folgendem Aufbau:
{
"status": -1; // Interner / combit Fehler
"error": {
"type": number; // Kann momentan die Werte 0 (UNKNOWN), 1 (INVALID_ARGUMENT), 2 (JSON_ERROR) oder 3 (HTTP_ERROR) enthalten.
"type_string": string; // Entspricht dem Namen des Fehlers, welcher in 'type' enthalten ist.
"error_details": string; // Nur bei type == 2 vorhanden, enthält weitere Informationen wieso die JSON-Formatierung der Serverantwort fehlgeschlagen ist.
"response": string; // Nur bei type == 2 vorhanden, enthält die Serverantwort, allerdings OHNE die Zeichen, welche den aktuellen JSON_ERROR ausgelöst haben.Dient nur zur Information und sollte nicht zur weiteren Datenverarbeitung genutzt werden.
}
}
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3482
HTTPGET(url, headerData, sendReceiveTimeout)
HTTPGET(
url,
headerData,
sendReceiveTimeout): string
Sendet einen HTTP-Request mit einer GET-Methode
Parameter
| Parameter | Type | Description |
|---|---|---|
url | string | URL des HTTP-Servers. |
headerData | string | JSON-formatierte Zeichenkette. Muss ein Array aus Objekten mit jeweils einem Key und einem Value enthalten. |
sendReceiveTimeout | number | Bestimmt, wie lange der Timeout beim Senden und Empfangen von Daten sein soll. Ein Wert von 0 bedeutet, dass kein Timeout besteht. Positive Werte sind in Millisekunden anzugeben, negative Werte sind ungültig. |
Rückgabewert
string
Im Erfolgsfall: String (JSON-formatiert, enthält die Objekte "status" [Statuscode] und "response" [Antwort des Servers])
Im Fehlerfall: String(JSON-formatiert), mit folgendem Aufbau:
{
"status": -1; // Interner / combit Fehler
"error": {
"type": number; // Kann momentan die Werte 0 (UNKNOWN), 1 (INVALID_ARGUMENT), 2 (JSON_ERROR) oder 3 (HTTP_ERROR) enthalten.
"type_string": string; // Entspricht dem Namen des Fehlers, welcher in 'type' enthalten ist.
"error_details": string; // Nur bei type == 2 vorhanden, enthält weitere Informationen wieso die JSON-Formatierung der Serverantwort fehlgeschlagen ist.
"response": string; // Nur bei type == 2 vorhanden, enthält die Serverantwort, allerdings OHNE die Zeichen, welche den aktuellen JSON_ERROR ausgelöst haben.Dient nur zur Information und sollte nicht zur weiteren Datenverarbeitung genutzt werden.
}
}
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3503
HTTPPatch()
HTTPPatch(url, headerData, bodyData)
HTTPPatch(
url,
headerData,
bodyData): string
Sendet einen HTTP-Request mit einer PATCH-Methode.
Parameter
| Parameter | Type | Description |
|---|---|---|
url | string | URL des HTTP-Servers. |
headerData | string | JSON-formatierte Zeichenkette. Muss ein Array aus Objekten mit jeweils einem Key und einem Value enthalten. |
bodyData | string | JSON-formatierte Zeichenkette. Muss ein Array aus Objekten mit jeweils einem Key und einem Value enthalten. |
Rückgabewert
string
Im Erfolgsfall: String (JSON-formatiert, enthält die Objekte "status" [Statuscode] und "response" [Antwort des Servers])
Im Fehlerfall: String(JSON-formatiert), mit folgendem Aufbau:
{
"status": -1; // Interner / combit Fehler
"error": {
"type": number; // Kann momentan die Werte 0 (UNKNOWN), 1 (INVALID_ARGUMENT), 2 (JSON_ERROR) oder 3 (HTTP_ERROR) enthalten.
"type_string": string; // Entspricht dem Namen des Fehlers, welcher in 'type' enthalten ist.
"error_details": string; // Nur bei type == 2 vorhanden, enthält weitere Informationen wieso die JSON-Formatierung der Serverantwort fehlgeschlagen ist.
"response": string; // Nur bei type == 2 vorhanden, enthält die Serverantwort, allerdings OHNE die Zeichen, welche den aktuellen JSON_ERROR ausgelöst haben.Dient nur zur Information und sollte nicht zur weiteren Datenverarbeitung genutzt werden.
}
}
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3537
HTTPPatch(url, headerData, bodyData, sendReceiveTimeout)
HTTPPatch(
url,
headerData,
bodyData,
sendReceiveTimeout): string
Sendet einen HTTP-Request mit einer PATCH-Methode.
Parameter
| Parameter | Type | Description |
|---|---|---|
url | string | URL des HTTP-Servers. |
headerData | string | JSON-formatierte Zeichenkette. Muss ein Array aus Objekten mit jeweils einem Key und einem Value enthalten. |
bodyData | string | JSON-formatierte Zeichenkette. Muss ein Array aus Objekten mit jeweils einem Key und einem Value enthalten. |
sendReceiveTimeout | number | Bestimmt, wie lange der Timeout beim Senden und Empfangen von Daten sein soll. Ein Wert von 0 bedeutet, dass kein Timeout besteht. Positive Werte sind in Millisekunden anzugeben, negative Werte sind ungültig. |
Rückgabewert
string
Im Erfolgsfall: String (JSON-formatiert, enthält die Objekte "status" [Statuscode] und "response" [Antwort des Servers])
Im Fehlerfall: String(JSON-formatiert), mit folgendem Aufbau:
{
"status": -1; // Interner / combit Fehler
"error": {
"type": number; // Kann momentan die Werte 0 (UNKNOWN), 1 (INVALID_ARGUMENT), 2 (JSON_ERROR) oder 3 (HTTP_ERROR) enthalten.
"type_string": string; // Entspricht dem Namen des Fehlers, welcher in 'type' enthalten ist.
"error_details": string; // Nur bei type == 2 vorhanden, enthält weitere Informationen wieso die JSON-Formatierung der Serverantwort fehlgeschlagen ist.
"response": string; // Nur bei type == 2 vorhanden, enthält die Serverantwort, allerdings OHNE die Zeichen, welche den aktuellen JSON_ERROR ausgelöst haben.Dient nur zur Information und sollte nicht zur weiteren Datenverarbeitung genutzt werden.
}
}
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3559
HTTPPost()
HTTPPost(url, headerData, bodyData)
HTTPPost(
url,
headerData,
bodyData): string
Sendet einen HTTP-Request mit einer POST-Methode.
Parameter
| Parameter | Type | Description |
|---|---|---|
url | string | URL des HTTP-Servers. |
headerData | string | JSON-formatierte Zeichenkette. Muss ein Array aus Objekten mit jeweils einem Key und einem Value enthalten. |
bodyData | string | JSON-formatierte Zeichenkette. Muss ein Array aus Objekten mit jeweils einem Key und einem Value enthalten. |
Rückgabewert
string
Im Erfolgsfall: String (JSON-formatiert, enthält die Objekte "status" [Statuscode] und "response" [Antwort des Servers])
Im Fehlerfall: String(JSON-formatiert), mit folgendem Aufbau:
{
"status": -1; // Interner / combit Fehler
"error": {
"type": number; // Kann momentan die Werte 0 (UNKNOWN), 1 (INVALID_ARGUMENT), 2 (JSON_ERROR) oder 3 (HTTP_ERROR) enthalten.
"type_string": string; // Entspricht dem Namen des Fehlers, welcher in 'type' enthalten ist.
"error_details": string; // Nur bei type == 2 vorhanden, enthält weitere Informationen wieso die JSON-Formatierung der Serverantwort fehlgeschlagen ist.
"response": string; // Nur bei type == 2 vorhanden, enthält die Serverantwort, allerdings OHNE die Zeichen, welche den aktuellen JSON_ERROR ausgelöst haben.Dient nur zur Information und sollte nicht zur weiteren Datenverarbeitung genutzt werden.
}
}
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3593
HTTPPost(url, headerData, bodyData, sendReceiveTimeout)
HTTPPost(
url,
headerData,
bodyData,
sendReceiveTimeout): string
Sendet einen HTTP-Request mit einer POST-Methode.
Parameter
| Parameter | Type | Description |
|---|---|---|
url | string | URL des HTTP-Servers. |
headerData | string | JSON-formatierte Zeichenkette. Muss ein Array aus Objekten mit jeweils einem Key und einem Value enthalten. |
bodyData | string | JSON-formatierte Zeichenkette. Muss ein Array aus Objekten mit jeweils einem Key und einem Value enthalten. |
sendReceiveTimeout | number | Bestimmt, wie lange der Timeout beim Senden und Empfangen von Daten sein soll. Ein Wert von 0 bedeutet, dass kein Timeout besteht. Positive Werte sind in Millisekunden anzugeben, negative Werte sind ungültig. |
Rückgabewert
string
Im Erfolgsfall: String (JSON-formatiert, enthält die Objekte "status" [Statuscode] und "response" [Antwort des Servers])
Im Fehlerfall: String(JSON-formatiert), mit folgendem Aufbau:
{
"status": -1; // Interner / combit Fehler
"error": {
"type": number; // Kann momentan die Werte 0 (UNKNOWN), 1 (INVALID_ARGUMENT), 2 (JSON_ERROR) oder 3 (HTTP_ERROR) enthalten.
"type_string": string; // Entspricht dem Namen des Fehlers, welcher in 'type' enthalten ist.
"error_details": string; // Nur bei type == 2 vorhanden, enthält weitere Informationen wieso die JSON-Formatierung der Serverantwort fehlgeschlagen ist.
"response": string; // Nur bei type == 2 vorhanden, enthält die Serverantwort, allerdings OHNE die Zeichen, welche den aktuellen JSON_ERROR ausgelöst haben.Dient nur zur Information und sollte nicht zur weiteren Datenverarbeitung genutzt werden.
}
}
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3615
HTTPPut()
HTTPPut(url, headerData, bodyData)
HTTPPut(
url,
headerData,
bodyData): string
Sendet einen HTTP-Request mit einer PUT-Methode.
Parameter
| Parameter | Type | Description |
|---|---|---|
url | string | URL des HTTP-Servers. |
headerData | string | JSON-formatierte Zeichenkette. Muss ein Array aus Objekten mit jeweils einem Key und einem Value enthalten. |
bodyData | string | JSON-formatierte Zeichenkette. Muss ein Array aus Objekten mit jeweils einem Key und einem Value enthalten. |
Rückgabewert
string
Im Erfolgsfall: String (JSON-formatiert, enthält die Objekte "status" [Statuscode] und "response" [Antwort des Servers])
Im Fehlerfall: String(JSON-formatiert), mit folgendem Aufbau:
{
"status": -1; // Interner / combit Fehler
"error": {
"type": number; // Kann momentan die Werte 0 (UNKNOWN), 1 (INVALID_ARGUMENT), 2 (JSON_ERROR) oder 3 (HTTP_ERROR) enthalten.
"type_string": string; // Entspricht dem Namen des Fehlers, welcher in 'type' enthalten ist.
"error_details": string; // Nur bei type == 2 vorhanden, enthält weitere Informationen wieso die JSON-Formatierung der Serverantwort fehlgeschlagen ist.
"response": string; // Nur bei type == 2 vorhanden, enthält die Serverantwort, allerdings OHNE die Zeichen, welche den aktuellen JSON_ERROR ausgelöst haben.Dient nur zur Information und sollte nicht zur weiteren Datenverarbeitung genutzt werden.
}
}
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3649
HTTPPut(url, headerData, bodyData, sendReceiveTimeout)
HTTPPut(
url,
headerData,
bodyData,
sendReceiveTimeout): string
Sendet einen HTTP-Request mit einer PUT-Methode.
Parameter
| Parameter | Type | Description |
|---|---|---|
url | string | URL des HTTP-Servers. |
headerData | string | JSON-formatierte Zeichenkette. Muss ein Array aus Objekten mit jeweils einem Key und einem Value enthalten. |
bodyData | string | JSON-formatierte Zeichenkette. Muss ein Array aus Objekten mit jeweils einem Key und einem Value enthalten. |
sendReceiveTimeout | number | Bestimmt, wie lange der Timeout beim Senden und Empfangen von Daten sein soll. Ein Wert von 0 bedeutet, dass kein Timeout besteht. Positive Werte sind in Millisekunden anzugeben, negative Werte sind ungültig. |
Rückgabewert
string
Im Erfolgsfall: String (JSON-formatiert, enthält die Objekte "status" [Statuscode] und "response" [Antwort des Servers])
Im Fehlerfall: String(JSON-formatiert), mit folgendem Aufbau:
{
"status": -1; // Interner / combit Fehler
"error": {
"type": number; // Kann momentan die Werte 0 (UNKNOWN), 1 (INVALID_ARGUMENT), 2 (JSON_ERROR) oder 3 (HTTP_ERROR) enthalten.
"type_string": string; // Entspricht dem Namen des Fehlers, welcher in 'type' enthalten ist.
"error_details": string; // Nur bei type == 2 vorhanden, enthält weitere Informationen wieso die JSON-Formatierung der Serverantwort fehlgeschlagen ist.
"response": string; // Nur bei type == 2 vorhanden, enthält die Serverantwort, allerdings OHNE die Zeichen, welche den aktuellen JSON_ERROR ausgelöst haben.Dient nur zur Information und sollte nicht zur weiteren Datenverarbeitung genutzt werden.
}
}
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3671
InvokeMenu()
InvokeMenu(menuId, synchron): boolean
Ruft einen Menüeintrag der Anwendung auf. Neben der ID des Menüeintrages wird angegeben, ob das Script solange warten soll, bis der Befehl abgearbeitet wurde(und evtl. Dialoge geschlossen wurden) oder ob das Script direkt weiterlaufen soll.
Parameter
| Parameter | Type | Description |
|---|---|---|
menuId | number | Die ID des Menüeintrages. |
synchron | boolean | true : synchrone Ausführung false : asynchrone Ausführung |
Rückgabewert
boolean
true wenn der Befehl zum Aufrufen eines Menüeintrags erfolgreich übermittelt wurde, false wenn der Befehl nicht übermittelt werden konnte, weil z.B. der Menüeintrag nicht zur Verfügung steht
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3695
Login()
Login(
projectpath,
userName,
userPW): Project
Öffnet ein Projekt.
Diese Methode sollte nur aufgerufen werden, wenn noch kein anderes Projekt geladen ist.
Parameter
| Parameter | Type | Description |
|---|---|---|
projectpath | string | Verzeichnispfad der Projektdatei. Übergibt man für das zu ladende Projekt leer, so wird zunächst versucht das bereits geladene Projekt zurückzugeben.Wurde Login aber unmittelbar nach CreateObject mit leer aufgerufen, wird versucht das zuletzt geladene Projekt zu öffnen. |
userName | string | Benutzername. Übergibt man diesen und das Passwort leer, wird Windows Authentifizierung versucht. Schlägt diese fehl, wird der Login-Dialog angezeigt. |
userPW | string | Passwort des Benutzers |
Rückgabewert
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3710
OAuthRedirectDialog()
OAuthRedirectDialog(url)
OAuthRedirectDialog(url): string
Öffnet einen Browserdialog, der die übergebene URL ansteuert. Diese Methode ist explizit für OAuth-Anmeldungen zu nutzen. Wenn sich der Benutzer im Dialog angemeldet hat, gibt diese Methode die URL zurück, zu der die aufgerufene Seite einen Redirect ausführen möchte.Typischerweise befindet sich in dieser Redirect-URL ein Token, welches für weitere API-Aufrufe genutzt werden kann(z.B.um sich bei dem übergebenen Server zu authentifizieren bzw.den Request im Namen des im Dialog angegebenen Nutzers durchzuführen)
Parameter
| Parameter | Type | Description |
|---|---|---|
url | string | URL des HTTP-Servers |
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3728
OAuthRedirectDialog(url, redirectUrl)
OAuthRedirectDialog(url, redirectUrl): string
Öffnet einen Browserdialog, der die übergebene URL ansteuert. Diese Methode ist explizit für OAuth-Anmeldungen zu nutzen. Wenn sich der Benutzer im Dialog angemeldet hat, gibt diese Methode die URL zurück, zu der die aufgerufene Seite einen Redirect ausführen möchte.Typischerweise befindet sich in dieser Redirect-URL ein Token, welches für weitere API-Aufrufe genutzt werden kann(z.B.um sich bei dem übergebenen Server zu authentifizieren bzw.den Request im Namen des im Dialog angegebenen Nutzers durchzuführen)
Parameter
| Parameter | Type | Description |
|---|---|---|
url | string | URL des HTTP-Servers |
redirectUrl | string | Redirect-URL des HTTP-Servers Der Parameter wird genutzt, um Redirects richtig zu erkennen, falls die normale URL und die Redirect -URL die gleiche Origin-Komponente besitzen. Ein Beispiel für gleiche Origin-Komponenten bei URL und Redirect-URL wäre: URL (1.Parameter): https://login.microsoftonline.com/\{tenant\}/oauth2/v2.0/authorize Redirect-URL(2.Parameter) : https://login.microsoftonline.com/common/oauth2/nativeclient |
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3739
PerformanceCounterCreate()
PerformanceCounterCreate(counterName): void
Legt einen Messpunkt mit einem bestimmten Namen an oder setzt einen bereits existierenden Messpunkt mit dem übergebenen Namen auf 0 zurück.So können Performance-Messungen mit Hilfe des Debug-Tools des cRM durchgeführt werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
counterName | string | Name des Messpunkts. |
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3759
PerformanceCounterHit()
PerformanceCounterHit(counterName)
PerformanceCounterHit(counterName): void
Gibt eine Messung der vergangenen Zeit in Millisekunden seit dem Aufruf von PerformanceCounterCreate(counterName: string) für den angegebenen Namen eines Messpunkts im Debug-Tool des cRM aus.
Der zweite Parameter ist optional und kann, wenn erforderlich, noch weitere relevante Informationen zur Messung ausgeben.
Parameter
| Parameter | Type | Description |
|---|---|---|
counterName | string | Name des Messpunkts. |
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3770
PerformanceCounterHit(counterName, additionalInfo)
PerformanceCounterHit(counterName, additionalInfo): void
Gibt eine Messung der vergangenen Zeit in Millisekunden seit dem Aufruf von PerformanceCounterCreate(counterName: string) für den angegebenen Namen eines Messpunkts im Debug-Tool des cRM aus.
Der zweite Parameter ist optional und kann, wenn erforderlich, noch weitere relevante Informationen zur Messung ausgeben.
Parameter
| Parameter | Type | Description |
|---|---|---|
counterName | string | Name des Messpunkts. |
additionalInfo | string | Weitere Informationen. |
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3779
SendMail()
SendMail(
address,
subject,
content,
files,
showDialog): boolean
Sendet eine eMail über die MAPI-Schnittstelle, unabhängig von den Record oder RecordSet Objekten.
Parameter
| Parameter | Type | Description |
|---|---|---|
address | string | E-Mail-Adresse(n) eines oder mehrerer Empfänger(s). Bei mehreren E-Mail-Adressen müssen diese durch Semikolon getrennt werden. Die Empfangsart pro E-Mail-Adresse kann über Präfixe bestimmt werden.Wenn kein Präfix angegeben ist, wird "TO:" angenommen, dieser kann aber optional auch angegeben werden.Für den Versand von E-Mail-Kopien können zusätzlich die Präfixe "CC:" und/oder "BCC:" verwendet werden; beachten Sie hierbei, dass jede E-Mail-Adresse einen eigenen Präfix benötigt.Das E-Mail-Protokoll kann über die Präfixe "MAPI:" (Voreinstellung), "XMAPI" oder "SMTP:" (Voreinstellung bei Versand über Workflow-Server) bestimmt werden.Pro E-Mail-Versand kann nur einer dieser Präfixe verwendet werden, dieser muss am Anfang stehen. |
subject | string | Betreff der eMail. |
content | string | Text der E-Mail. |
files | string | Kann eine Liste von E-Mail-Anhängen beinhalten. Diese müssen dann per Semikolon separiert übergeben werden. |
showDialog | number | Anzeige eines Bestätigungsdialoges. 0 = Dialog wird nicht angezeigt. 1 = Dialog wird angezeigt. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3806
SetDBConnectInfo()
SetDBConnectInfo(dbServer, dbUser, dbPwd, windowsAuth, dbSystem)
SetDBConnectInfo(
dbServer,
dbUser,
dbPwd,
windowsAuth,
dbSystem): void
Parameter
| Parameter | Type |
|---|---|
dbServer | string |
dbUser | string |
dbPwd | string |
windowsAuth | boolean |
dbSystem | number |
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3864
SetDBConnectInfo(dbServer, dbUser, dbPwd, windowsAuth, dbSystem, customConnectOptions)
SetDBConnectInfo(
dbServer,
dbUser,
dbPwd,
windowsAuth,
dbSystem,
customConnectOptions): void
Parameter
| Parameter | Type |
|---|---|
dbServer | string |
dbUser | string |
dbPwd | string |
windowsAuth | boolean |
dbSystem | number |
customConnectOptions | string |
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3866
SetIniProfileString()
SetIniProfileString(
section,
property,
value,
iniFile): void
Setzt einen Eintrag in einer INI-Datei.
Parameter
| Parameter | Type | Description |
|---|---|---|
section | string | Name der Sektion in der INI-Datei, in der der zu lesende Eintrag steht. |
property | string | Name des zu lesenden Eintrags. |
value | string | Der zu setzende Wert. |
iniFile | string | Pfad zur INI-Datei. |
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3819
SetWaitDlgText()
SetWaitDlgText(text): void
Hiermit kann der Text in einem per StartWaitDlg gestarteten Wartedialog nachträglich geändert werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
text | string | Setzt den Text eines offenen Wartedialogs |
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3829
StartWaitDlg()
StartWaitDlg(text, cancel)
StartWaitDlg(text, cancel): void
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
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3840
StartWaitDlg(text, cancel, initialDelay)
StartWaitDlg(
text,
cancel,
initialDelay): void
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 wird immer 0 verwendet. Verzögerung bis zur Anzeige des Dialogs in Sekunden. 0 = unmittelbare Anzeige. Der vorbelegte Wert beträgt 3 Sekunden |
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3849
StoreGlobalConfigFile()
StoreGlobalConfigFile(srcFilePath, dstFilePath): boolean
Speichert die globalen Konfigurationsdateien ohne Projekt-ID.
Parameter
| Parameter | Type | Description |
|---|---|---|
srcFilePath | string | Dateiname unter dem die Datei in der cmbt_Files Tabelle in der System-Datenbank abgelegt werden soll. |
dstFilePath | string | Dateiname der lokalen Datei, die verwendet werden soll. |
Rückgabewert
boolean
true wenn der Befehl erfolgreich ausgeführt wurde, andernfalls false
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3889
[asyncDispose]()
asyncDispose: Promise<void>
Standardimplementierung des AsyncDispose Symbols
Rückgabewert
Promise<void>
Implementierung von
AsyncDisposable.[asyncDispose]
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3927
[dispose]()
dispose: void
Standardimplementierung des Dispose Symbols
Rückgabewert
void
Implementierung von
Disposable.[dispose]
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3938
[hasInstance]()
static hasInstance: boolean
Symbol.hasInstance welches eine benutzerdefinierte Überprüfung der 'instanceof'-Operation für Objekte ermöglicht.
Parameter
| Parameter | Type |
|---|---|
value | any |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:3946