Version: 25.346.842.1

CRMApplication

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2252

Das Application-Objekt des cRM

Implementiert

AsyncDisposable
Disposable
ICRMApplication

Eigenschaften

AppDir

Abfragesignatur

get AppDir(): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2266

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

AppTitle

Abfragesignatur

get AppTitle(): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2275

Liefert den Namen der Anwendung zurück

Rückgabewert

string

CurrentProject

Abfragesignatur

get CurrentProject(): Project;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2483

Gibt das geladene Projekt als Objekt vom Typ Project zurück (leer, wenn kein Projekt geladen).

Rückgabewert

Project

DBServerName

Abfragesignatur

get DBServerName(): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2286

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

DialogForm

Abfragesignatur

get DialogForm(): DialogForm;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2322

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

DialogForm

Edition

Abfragesignatur

get Edition(): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2340

Liefert die Edition zurück.

Rückgabewert

number

FileVersion

Abfragesignatur

get FileVersion(): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2349

Rückgabe der Dateiversion der installierten Anwendung.

Rückgabewert

number

IsDisposed

Abfragesignatur

get IsDisposed(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2497

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean

MainWindowHandle

Abfragesignatur

get MainWindowHandle(): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2358

Liefert das Haupt-Fensterhandle zurück.

Rückgabewert

number

PhoneManager

Abfragesignatur

get PhoneManager(): PhoneManager;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2367

Liefert das PhoneManager Objekt zurück.

Rückgabewert

PhoneManager

ProcessID

Abfragesignatur

get ProcessID(): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2384

Liefert die ProzessId zurück.

Rückgabewert

number

ProductVersion

Abfragesignatur

get ProductVersion(): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2393

Rückgabe der Produkt-Versionsnummer der installierten Anwendung.

Rückgabewert

number

SerialNumber

Abfragesignatur

get SerialNumber(): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2402

Rückgabe der Seriennummer

Rückgabewert

string

ServerAppDir

Abfragesignatur

get ServerAppDir(): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2411

Rückgabe des Pfads der Serverinstallation. Im Fall einer Einzelplatzversion wird der Wert der Eigenschaft AppDir zurückgegeben

Rückgabewert

string

TempDir

Abfragesignatur

get TempDir(): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2420

Rückgabe des Benutzer Temp-Verzeichnisses

Rückgabewert

string

TimeManagerType

Abfragesignatur

get TimeManagerType(): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2429

Rückgabe der eingestellten Terminverwaltung.

Rückgabewert

number

TrialVersion

Abfragesignatur

get TrialVersion(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2438

Abfrage, ob die aktuelle Version eine Demoversion ist

Rückgabewert

boolean

UILanguageID

Abfragesignatur

get UILanguageID(): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2447

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

Version

Abfragesignatur

get Version(): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2456

Rückgabe der Versionsnummer der installierten Anwendung

Rückgabewert

number

Visible

Abfragesignatur

get Visible(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2466

Gibt den Anzeigezustand der Anwendung zurück oder setzt diesen.
Standardmäßig ist beim Zugriff per COM der Anzeigezustand der Anwendung unsichtbar ( false ).

Rückgabewert

boolean

Änderungssignatur

set Visible(val): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2475

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

void

Methoden

[asyncDispose]()

asyncDispose: Promise<void>;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3615

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

[dispose]()

dispose: void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3626

Standardimplementierung des Dispose Symbols

Rückgabewert

void

Implementierung von

Disposable.[dispose]

CheckAbortedWaitDlg()

CheckAbortedWaitDlg(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2520

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

ConvertHTML2PlainText()

ConvertHTML2PlainText(input): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2532

Konvertiert einen als HTML übergebenen String nach Klartext

Parameter

Parameter	Type	Description
`input`	`string`	Zu konvertierender HTML-String

Rückgabewert

string

Klartext

ConvertLocalToUTCDateTime()

ConvertLocalToUTCDateTime(localDateTime): Date;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2545

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

ConvertPlainText2HTML()

ConvertPlainText2HTML(input): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2557

Konvertiert einen als Klartext übergebenen String nach HTML

Parameter

Parameter	Type	Description
`input`	`string`	Zu konvertierender Klartext

Rückgabewert

string

HTML

ConvertUTCToLocalDateTime()

ConvertUTCToLocalDateTime(utcDate): Date;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2569

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

CreateGUID()

CreateGUID(): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2580

Erzeugt einen global eindeutigen Identifier und gibt diesen als unformatierte Zeichenkette zurück

Rückgabewert

string

Uniqueidentifier im combit Format

CreateTempFile()

CreateTempFile(
   prefix, 
   fileExtension, 
   autoRemove): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2594

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

DebugOutput()

DebugOutput(output): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2609

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

Decrypt()

Decrypt(input, key): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3603

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

DialogChoiceMessageBox()

Aufrufsignatur

DialogChoiceMessageBox(
   message, 
   title, 
   choices, 
   icon, 
   enableCancel): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2630

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.

Aufrufsignatur

DialogChoiceMessageBox(
   message, 
   title, 
   choices, 
   icon, 
   enableCancel, 
   parentHandle): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2649

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.

DialogInputBox()

Aufrufsignatur

DialogInputBox(prompt): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2671

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

Aufrufsignatur

DialogInputBox(prompt, title): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2681

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

Aufrufsignatur

DialogInputBox(
   prompt, 
   title, 
   defaultValue): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2692

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

Aufrufsignatur

DialogInputBox(
   prompt, 
   title, 
   defaultValue, 
   inputType): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2704

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

Aufrufsignatur

DialogInputBox(
   prompt, 
   title, 
   defaultValue, 
   inputType, 
   maxInputLenght): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2717

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

Aufrufsignatur

DialogInputBox(
   prompt, 
   title, 
   defaultValue, 
   inputType, 
   maxInputLenght, 
   parentHandle): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2731

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

DialogInputBoxMultiline()

Aufrufsignatur

DialogInputBoxMultiline(prompt): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2765

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

Aufrufsignatur

DialogInputBoxMultiline(prompt, title): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2775

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

Aufrufsignatur

DialogInputBoxMultiline(
   prompt, 
   title, 
   defaultValue): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2786

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

Aufrufsignatur

DialogInputBoxMultiline(
   prompt, 
   title, 
   defaultValue, 
   syntaxColoring): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2798

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

Aufrufsignatur

DialogInputBoxMultiline(
   prompt, 
   title, 
   defaultValue, 
   syntaxColoring, 
   maxInputLenght): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2811

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

Aufrufsignatur

DialogInputBoxMultiline(
   prompt, 
   title, 
   defaultValue, 
   syntaxColoring, 
   maxInputLenght, 
   parentHandle): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2825

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

DialogMessageBox()

Aufrufsignatur

DialogMessageBox(
   message, 
   title, 
   style): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2861

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

Aufrufsignatur

DialogMessageBox(
   message, 
   title, 
   style, 
   parentHandle): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2873

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

DialogMessageBoxAuto()

Aufrufsignatur

DialogMessageBoxAuto(
   message, 
   title, 
   style, 
   autoMessageId): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2898

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

Aufrufsignatur

DialogMessageBoxAuto(
   message, 
   title, 
   style, 
   autoMessageId, 
   parentHandle): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2911

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

DialogSelectColor()

Aufrufsignatur

DialogSelectColor(): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2932

Zeigt einen Farbauswahldialog an und gibt den ausgewählten Farbwert zurück

Rückgabewert

number

Ausgewählter Farbwert oder -1 bei Benutzerabbruch

Aufrufsignatur

DialogSelectColor(currentColor): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2941

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

Aufrufsignatur

DialogSelectColor(currentColor, defaultColor): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2951

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

Aufrufsignatur

DialogSelectColor(
   currentColor, 
   defaultColor, 
   parentHandle): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2962

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

DialogSelectDir()

DialogSelectDir(
   title, 
   openFileDlg, 
   initialPath, 
   dwFlags): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:2990

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

DialogSelectFile()

DialogSelectFile(
   title, 
   openFileDlg, 
   initialPath, 
   fileFilter, 
   dwFlags): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3008

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

DialogSelectString()

Aufrufsignatur

DialogSelectString(
   message, 
   choices, 
   sortChoices, 
   allowMultiSelect, 
   allowFilter, 
   profileKey): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3030

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

Aufrufsignatur

DialogSelectString(
   message, 
   choices, 
   sortChoices, 
   allowMultiSelect, 
   allowFilter, 
   profileKey, 
   parentHandle): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3050

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

Dispose()

Dispose(): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3620

Standardimplementierung des Dispose

Rückgabewert

void

DisposeAsync()

DisposeAsync(): Promise<void>;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3609

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>

Encrypt()

Encrypt(input, key): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3590

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

EndWaitDlg()

EndWaitDlg(): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3069

Blendet einen zuvor mit StartWaitDlg angezeigten Wartedialog aus.

Rückgabewert

void

FetchGlobalConfigFile()

FetchGlobalConfigFile(srcFilePath, dstFilePath): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3082

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

GetcRMByProcessID()

GetcRMByProcessID(processId): CRMApplication;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3092

Liefert ein bestimmtes cRM-Objekt anhand seiner ProcessID zurück.

Parameter

Parameter	Type	Description
`processId`	`number`	ProcessID

Rückgabewert

CRMApplication

GetIniProfileString()

GetIniProfileString(
   section, 
   property, 
   defaultValue, 
   iniFile): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3115

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

GetMessageText()

Aufrufsignatur

GetMessageText(resourceFileName, id): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3154

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

Aufrufsignatur

GetMessageText(
   resourceFileName, 
   id, 
   param1): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3164

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

Aufrufsignatur

GetMessageText(
   resourceFileName, 
   id, 
   param1, 
   param2): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3175

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

Aufrufsignatur

GetMessageText(
   resourceFileName, 
   id, 
   param1, 
   param2, 
   param3): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3187

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

Aufrufsignatur

GetMessageText(
   resourceFileName, 
   id, 
   param1, 
   param2, 
   param3, 
   param4): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3200

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

Aufrufsignatur

GetMessageText(
   resourceFileName, 
   id, 
   param1, 
   param2, 
   param3, 
   param4, 
   param5): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3214

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

GetOptionString()

Aufrufsignatur

GetOptionString(optionName, reserved): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3120

Parameter

Parameter	Type
`optionName`	`string`
`reserved`	`string`

Rückgabewert

string

Aufrufsignatur

GetOptionString(
   optionName, 
   reserved, 
   parentHandle): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3122

Parameter

Parameter	Type
`optionName`	`string`
`reserved`	`string`
`parentHandle`	`number`

Rückgabewert

string

GetTickCount()

GetTickCount(): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3137

Rückgabewert

number

GetTimeStamp()

GetTimeStamp(): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3142

Rückgabewert

string

HTTPDelete()

HTTPDelete(url, headerData): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3259

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.
}
}

HTTPGET()

HTTPGET(url, headerData): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3282

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

HTTPPatch()

HTTPPatch(
   url, 
   headerData, 
   bodyData): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3306

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

HTTPPost()

HTTPPost(
   url, 
   headerData, 
   bodyData): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3330

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

HTTPPut()

HTTPPut(
   url, 
   headerData, 
   bodyData): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3354

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

InvokeMenu()

InvokeMenu(menuId, synchron): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3368

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

Login(
   projectpath, 
   userName, 
   userPW): Project;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3383

Ö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

Project

OAuthRedirectDialog()

Aufrufsignatur

OAuthRedirectDialog(url): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3401

Ö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

Aufrufsignatur

OAuthRedirectDialog(url, redirectUrl): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3412

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

PerformanceCounterCreate()

PerformanceCounterCreate(counterName): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3432

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

PerformanceCounterHit()

Aufrufsignatur

PerformanceCounterHit(counterName): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3443

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

Aufrufsignatur

PerformanceCounterHit(counterName, additionalInfo): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3452

Parameter

Parameter	Type	Description
`counterName`	`string`	Name des Messpunkts.
`additionalInfo`	`string`	Weitere Informationen.

Rückgabewert

void

SendMail()

SendMail(
   address, 
   subject, 
   content, 
   files, 
   showDialog): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3479

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

SetDBConnectInfo()

SetDBConnectInfo(
   dbServer, 
   dbUser, 
   dbPwd, 
   windowsAuth, 
   dbSystem): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3559

Parameter

Parameter	Type
`dbServer`	`string`
`dbUser`	`string`
`dbPwd`	`string`
`windowsAuth`	`boolean`
`dbSystem`	`number`

Rückgabewert

void

SetDoRestart()

SetDoRestart(projectToLoadNextTime): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3564

Parameter

Parameter	Type
`projectToLoadNextTime`	`string`

Rückgabewert

void

SetIniProfileString()

SetIniProfileString(
   section, 
   property, 
   value, 
   iniFile): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3492

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

SetOptionString()

Aufrufsignatur

SetOptionString(flag, optionVal): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3497

Parameter

Parameter	Type
`flag`	`string`
`optionVal`	`string`

Rückgabewert

void

Aufrufsignatur

SetOptionString(
   flag, 
   optionVal, 
   reserved): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3499

Parameter

Parameter	Type
`flag`	`string`
`optionVal`	`string`
`reserved`	`string`

Rückgabewert

void

Aufrufsignatur

SetOptionString(
   flag, 
   optionVal, 
   reserved, 
   parentHandle): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3501

Parameter

Parameter	Type
`flag`	`string`
`optionVal`	`string`
`reserved`	`string`
`parentHandle`	`number`

Rückgabewert

void

SetWaitDlgText()

SetWaitDlgText(text): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3524

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

StartWaitDlg()

Aufrufsignatur

StartWaitDlg(text, cancel): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3535

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.v11.ts:3544

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

StoreGlobalConfigFile()

StoreGlobalConfigFile(srcFilePath, dstFilePath): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3577

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

[hasInstance]()

static hasInstance: boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:3634

Symbol.hasInstance welches eine benutzerdefinierte Überprüfung der 'instanceof'-Operation für Objekte ermöglicht.

Parameter

Parameter	Type
`value`	`any`

Rückgabewert

boolean

Implementiert​

Eigenschaften​

AppDir​

Abfragesignatur​

Rückgabewert​

AppTitle​

Abfragesignatur​

Rückgabewert​

CurrentProject​

Abfragesignatur​

Rückgabewert​

DBServerName​

Abfragesignatur​

Rückgabewert​

DialogForm​

Abfragesignatur​

Example​

Remarks​

Throws​

Rückgabewert​

Edition​

Abfragesignatur​

Rückgabewert​

FileVersion​

Abfragesignatur​

Rückgabewert​

IsDisposed​

Abfragesignatur​

Rückgabewert​

MainWindowHandle​

Abfragesignatur​

Rückgabewert​

PhoneManager​

Abfragesignatur​

Rückgabewert​

ProcessID​

Abfragesignatur​

Rückgabewert​

ProductVersion​

Abfragesignatur​

Rückgabewert​

SerialNumber​

Abfragesignatur​

Rückgabewert​

ServerAppDir​

Abfragesignatur​

Rückgabewert​

TempDir​

Abfragesignatur​

Rückgabewert​

TimeManagerType​

Abfragesignatur​

Rückgabewert​

TrialVersion​

Abfragesignatur​

Rückgabewert​

UILanguageID​

Abfragesignatur​

Rückgabewert​

Version​

Abfragesignatur​

Rückgabewert​

Visible​

Abfragesignatur​

Rückgabewert​

Änderungssignatur​

Parameter​

Rückgabewert​

Methoden​

[asyncDispose]()​

Rückgabewert​

Implementierung von​

[dispose]()​

Rückgabewert​

Implementierung von​

CheckAbortedWaitDlg()​

Rückgabewert​

ConvertHTML2PlainText()​

Parameter​

Rückgabewert​

Implementiert

Eigenschaften

AppDir

Abfragesignatur

Rückgabewert

AppTitle

Abfragesignatur

Rückgabewert

CurrentProject

Abfragesignatur

Rückgabewert

DBServerName

Abfragesignatur

Rückgabewert

DialogForm

Abfragesignatur

Example

Remarks

Throws

Rückgabewert

Edition

Abfragesignatur

Rückgabewert

FileVersion

Abfragesignatur

Rückgabewert

IsDisposed

Abfragesignatur

Rückgabewert

MainWindowHandle

Abfragesignatur

Rückgabewert

PhoneManager

Abfragesignatur

Rückgabewert

ProcessID

Abfragesignatur

Rückgabewert

ProductVersion

Abfragesignatur

Rückgabewert

SerialNumber

Abfragesignatur

Rückgabewert

ServerAppDir

Abfragesignatur

Rückgabewert

TempDir

Abfragesignatur

Rückgabewert

TimeManagerType

Abfragesignatur

Rückgabewert

TrialVersion

Abfragesignatur

Rückgabewert

UILanguageID

Abfragesignatur

Rückgabewert

Version

Abfragesignatur

Rückgabewert

Visible

Abfragesignatur

Rückgabewert

Änderungssignatur

Parameter

Rückgabewert

Methoden

[asyncDispose]()

Rückgabewert

Implementierung von

[dispose]()

Rückgabewert

Implementierung von

CheckAbortedWaitDlg()

Rückgabewert

ConvertHTML2PlainText()

Parameter

Rückgabewert