cRMApplication
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:7928
Das Application-Objekt des cRM
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Implementiert
AsyncDisposableDisposableICRMApplication
Eigenschaften
AppDir
Abfragesignatur
get AppDir(): string;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:7954
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
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
string
AppTitle
Abfragesignatur
get AppTitle(): string;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:7964
Liefert den Namen der Anwendung zurück
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
string
CurrentProject
Abfragesignatur
get CurrentProject(): Promise<Project>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8154
Gibt das geladene Projekt als Objekt vom Typ Project zurück (leer, wenn kein Projekt geladen).
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
Promise<Project>
DBServerName
Abfragesignatur
get DBServerName(): string;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:7976
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.
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
string
DialogForm
Abfragesignatur
get DialogForm(): Promise<DialogForm>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8013
Liefert ein Objekt vom Objekt DialogForm zurück.
Example
Der Aufruf könnte wie folgt aussehen:
let dialogForm : DialogForm;
try {
try {
dialogForm = await cRM.DialogForm;
} catch (error) {
if (error instanceof (Error)) {
await cRM.DialogMessageBox("Der Vorgang wird beendet","Auf das Objekt zur Darstellung des combit CRM Dialogfensters konnte nicht zugegriffen werden.\nBitte wenden Sie sich an Ihren Administrator oder den cosmolink Support.\n\n" + error.message ,"Dialogfenster kann nicht angezeigt werden", MsgBoxButton.OkOnly, MsgBoxIcon.Exclamation);
return;
}
}
//... Verwendung des DialogForm Objekts
} finally {
await dialogForm?.DisposeAsync();
}
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
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
Promise<DialogForm>
Edition
Abfragesignatur
get Edition(): Edition;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8035
Liefert die Edition zurück.
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
Environment
Abfragesignatur
get Environment(): CRMEnvironment;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:7943
Skriptumgebung
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
FileVersion
Abfragesignatur
get FileVersion(): CRMVersion;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8046
Rückgabe der Dateiversion der installierten Anwendung.
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
IsDisposed
Abfragesignatur
get IsDisposed(): boolean;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8191
Gibt an, ob das Objekt bereits Freigegeben wurde
Rückgabewert
boolean
MainWindowHandle
Abfragesignatur
get MainWindowHandle(): number;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8064
Liefert das Haupt-Fensterhandle zurück.
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
number
ProcessID
Abfragesignatur
get ProcessID(): number;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8074
Liefert die ProzessId zurück.
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
number
ProductVersion
Abfragesignatur
get ProductVersion(): CRMVersion;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8084
Rückgabe der Produkt-Versionsnummer der installierten Anwendung.
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
ServerAppDir
Abfragesignatur
get ServerAppDir(): string;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8102
Rückgabe des Pfads der Serverinstallation. Im Fall einer Einzelplatzversion wird der Wert der Eigenschaft AppDir zurückgegeben
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
string
TempDir
Abfragesignatur
get TempDir(): string;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8112
Rückgabe des Benutzer Temp-Verzeichnisses
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
string
TimeManagerType
Abfragesignatur
get TimeManagerType(): TimeManagerType;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8122
Rückgabe der eingestellten Terminverwaltung.
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
TrialVersion
Abfragesignatur
get TrialVersion(): boolean;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8133
Abfrage, ob die aktuelle Version eine Demoversion ist
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
boolean
UILanguageID
Abfragesignatur
get UILanguageID(): UILanguage;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8143
Liefert die Sprachkonstante (LANGID gemäß Microsoft Windows SDK) der aktuell eingestellten Sprache des Benutzerinterfaces.Der Wert korrespondiert zu den ".lng"-Unterverzeichnissen der Installation
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
Visible
Abfragesignatur
get Visible(): boolean;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8176
Gibt den Anzeigezustand der Anwendung zurück oder setzt diesen.
Standardmäßig ist beim Zugriff per COM der Anzeigezustand der Anwendung unsichtbar ( false ).
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
boolean
Änderungssignatur
set Visible(val): void;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8186
Gibt den Anzeigezustand der Anwendung zurück oder setzt diesen.
Standardmäßig ist beim Zugriff per COM der Anzeigezustand der Anwendung unsichtbar ( false ).
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Parameter
| Parameter | Type |
|---|---|
val | boolean |
Rückgabewert
void
Methoden
[asyncDispose]()
asyncDispose: Promise<void>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:9200
Standardimplementierung des AsyncDispose Symbols
Rückgabewert
Promise<void>
Implementierung von
AsyncDisposable.[asyncDispose]
[dispose]()
dispose: void;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:9211
Standardimplementierung des Dispose Symbols
Rückgabewert
void
Implementierung von
Disposable.[dispose]
CheckAbortedWaitDlg()
CheckAbortedWaitDlg(): Promise<boolean>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8215
Die Methode muss zwischen StartWaitDlg 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
Promise<boolean>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
ConvertHTML2PlainText()
ConvertHTML2PlainText(html): Promise<string>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8228
Konvertiert einen als HTML übergebenen String nach Klartext
Parameter
| Parameter | Type | Description |
|---|---|---|
html | string | Zu konvertierender HTML-String |
Rückgabewert
Promise<string>
Klartext
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
ConvertLocalToUTCDateTime()
ConvertLocalToUTCDateTime(localDateTime): Date;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8241
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 |
|---|---|
localDateTime | Date |
Rückgabewert
UTC-Datum
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
ConvertPlainText2HTML()
ConvertPlainText2HTML(plainText): Promise<string>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8254
Konvertiert einen als Klartext übergebenen String nach HTML
Parameter
| Parameter | Type | Description |
|---|---|---|
plainText | string | Zu konvertierender Klartext |
Rückgabewert
Promise<string>
HTML
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
ConvertUTCToLocalDateTime()
ConvertUTCToLocalDateTime(utcDate): Date;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8267
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
Lokales Datum
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
CreateGUID()
CreateGUID(): Promise<string>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8279
Erzeugt einen global eindeutigen Identifier und gibt diesen als unformatierte Zeichenkette zurück
Rückgabewert
Promise<string>
Uniqueidentifier im combit Format
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
CreateTempFile()
CreateTempFile(
prefix,
extension,
autoRemove): Promise<string>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8294
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 |
extension | string | Dateiendung |
autoRemove | boolean | true wenn die Datei beim Beenden der Anwendung gelöscht werden soll, andernfalls false |
Rückgabewert
Promise<string>
Pfad zur temporären Datei
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
DebugOutput()
DebugOutput(output): Promise<void>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8304
Debugausgabe in Debwin
Parameter
| Parameter | Type |
|---|---|
output | string |
Rückgabewert
Promise<void>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Decrypt()
Decrypt(input, key): Promise<string>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:9188
Entschlüsselt einen Text anhand eines übergebenen Keys
Parameter
| Parameter | Type | Description |
|---|---|---|
input | string | Zu entschlüsselnder Text |
key | string | Passphrase |
Rückgabewert
Promise<string>
Entschlüsselter Text
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
DialogAddressAssistant()
DialogAddressAssistant(mode, input): Promise<CRMDialogResult<DialogOutputAddress>>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8322
Zeigt den Adresseingabe-Assistent für eine übergebene Adresse an oder ergänzt die Adresse mit fehlenden Informationen
Parameter
| Parameter | Type | Description |
|---|---|---|
mode | DialogAddressMode | Gibt an wie der Dialog angezeigt wird |
input | DialogInputAddress | Ermöglicht die Übergabe von Adressinformationen |
Rückgabewert
Promise<CRMDialogResult<DialogOutputAddress>>
Enthält die ergänzte Adressinformation sofern möglich in Value . Bei Benutzerabbruch ist IsCanceled gesetzt
Remarks
Version 12.0.0
Die Methode/Eigenschaft wird erst ab dieser Version unterstützt. Bei vorherigen Versionen führt der Aufruf zu einer Exception.
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
DialogChoiceMessageBox()
DialogChoiceMessageBox(
message,
title,
choices,
icon?,
enableCancel?,
parentHandle?): Promise<CRMDialogResult<number>>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8356
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. |
icon? | DialogChoiceIcon | Bestimmt das neben der Auswahl dargestellte Symbol |
enableCancel? | boolean | Bestimmt, ob eine "Abbrechen"-Schaltfläche angezeigt werden soll. |
parentHandle? | number | Optional - Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll. |
Rückgabewert
Promise<CRMDialogResult<number>>
Enthält den 0 basierten Index des gewählten Eintrags in Value . Bei Benutzerabbruch ist IsCanceled gesetzt
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
DialogInputBox()
DialogInputBox(
prompt,
title?,
defaultValue?,
dialogInputType?,
maxInputLenght?,
parentHandle?): Promise<CRMDialogResult<string>>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8423
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 | Optional - Titel des Dialogs. |
defaultValue? | string | Optional - Voreingestellter Wert für die Eingabe. |
dialogInputType? | DialogInputType | Optional - Reserviert. Der Parameterwert wird derzeit ignoriert. |
maxInputLenght? | number | Optional Voreinstellung:256 - Maximale Länge der Benutzereingabe. |
parentHandle? | number | Optional - Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll. |
Rückgabewert
Promise<CRMDialogResult<string>>
Enthält die Benutzereingabe in Value . Bei Benutzerabbruch ist IsCanceled gesetzt
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
DialogInputBoxMultiline()
DialogInputBoxMultiline(
prompt,
title?,
defaultValue?,
dialogSyntaxColoring?,
maxInputLenght?,
parentHandle?): Promise<CRMDialogResult<string>>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8512
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 | Optional - Titel des Dialogs. |
defaultValue? | string | Optional - Voreingestellter Wert für die Eingabe. |
dialogSyntaxColoring? | DialogSyntaxColoring | Optional - 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 | Optional Voreinstellung: 256 - Maximale Länge der Benutzereingabe. |
parentHandle? | number | Optional - Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll. |
Rückgabewert
Promise<CRMDialogResult<string>>
Enthält die Benutzereingabe in Value . Bei Benutzerabbruch ist IsCanceled gesetzt
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
DialogMessageBox()
DialogMessageBox(
messageSubject,
messageText,
title,
button?,
icon?,
parentHandle?): Promise<DialogResult>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8601
Zeigt einen Dialog zur Ausgabe von Informationen im cRM-Stil an
Parameter
| Parameter | Type | Description |
|---|---|---|
messageSubject | string | Hauptzeile der Nachricht, diese wird in einer größeren Schrift dargestellt |
messageText | string | Nachricht des Dialogs. |
title | string | Titel des Dialogs. |
button? | MsgBoxButton | Bestimmt die Schaltflächen des Dialogs |
icon? | MsgBoxIcon | Bestimmt das Icon des Dialogs |
parentHandle? | number | Optional. Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden. |
Rückgabewert
Promise<DialogResult>
Der Rückgabewert entspricht einer Konstante von DialogResult
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
DialogMessageBoxAuto()
DialogMessageBoxAuto(
messageSubject,
messageText,
title,
messageId,
button?,
icon?,
parentHandle?): Promise<DialogResult>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8645
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 |
|---|---|---|
messageSubject | string | Hauptzeile der Nachricht, diese wird in einer größeren Schrift dargestellt |
messageText | string | Nachricht des Dialogs. |
title | string | Titel des Dialogs. |
messageId | string | Eindeutige ID in Form einer Zeichenkette zur Speicherung der Auswahl für den Wert "In Zukunft nicht mehr anzeigen". |
button? | MsgBoxButton | Bestimmt die Schaltflächen des Dialogs |
icon? | MsgBoxIcon | Bestimmt das Icon des Dialogs |
parentHandle? | number | Optional. Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden. |
Rückgabewert
Promise<DialogResult>
Der Rückgabewert entspricht einer Konstante von DialogResult
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
DialogSelectColor()
DialogSelectColor(
currentColor?,
defaultColor?,
parentHandle?): Promise<CRMDialogResult<number>>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8685
Zeigt einen Farbauswahldialog an und gibt den ausgewählten Farbwert zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
currentColor? | number | Optional. Aktuelle Farbe. Wenn dieser Parameter nicht übergeben wird, wird Schwarz verwendet. |
defaultColor? | number | Optional. Neue Farbe, die vorausgewählt werden soll. Wenn dieser Parameter nicht angegeben wird, wird die aktuelle Farbe (vgl.Parameter currentColor ) verwendet. |
parentHandle? | number | Optional. Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden. |
Rückgabewert
Promise<CRMDialogResult<number>>
Enthält den ausgewählten Farbwert in Value . Bei Benutzerabbruch ist IsCanceled gesetzt
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
DialogSelectDir()
DialogSelectDir(
title,
openFileDlg,
initialPath?,
flags?,
parentHandle?): Promise<CRMDialogResult<string>>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8744
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 | Optional -Initielles Verzeichnis als Voreinstellung für den Dialog oder leer. |
flags? | OFNFlags | Optional -Reserviert, muss 0 sein |
parentHandle? | number | Optional. Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden. |
Rückgabewert
Promise<CRMDialogResult<string>>
Enthält den ausgewählten Verzeichnispfad in Value . Bei Benutzerabbruch ist IsCanceled gesetzt
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
DialogSelectFile()
DialogSelectFile(
title,
openFileDlg,
initialPath?,
fileFilter?,
flags?,
parentHandle?): Promise<CRMDialogResult<string>>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8813
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 | Optional -Initielles Verzeichnis als Voreinstellung für den Dialog oder leer. Kann einen kompletten Dateipfad enthalten oder leer sein. |
fileFilter? | string | Optional -Kann eine Liste von Dateifiltern enthalten oder leer sein. Format: BeschreibungFilter1 |
flags? | OFNFlags | Optional -Bestimmt die Interaktion mit dem Dialog (Beschreibung siehe MSDN unter 'OPENFILENAME') |
parentHandle? | number | Optional. Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden. |
Rückgabewert
Promise<CRMDialogResult<string>>
Enthält den ausgewählten Dateipfad in Value . Bei Benutzerabbruch ist IsCanceled gesetzt
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
DialogSelectString()
DialogSelectString(
message,
choices,
sortChoices,
allowMultiSelect?,
allowFilter?,
profileKey?,
parentHandle?): Promise<CRMDialogResult<string[]>>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8895
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[] | Liste mit Auswahlmöglichkeiten. Beginnt Eintrag mit einem *, dann wird dieser Eintrag vorausgewählt. |
sortChoices | SortOrderChoices | Sortierung der Einträge |
allowMultiSelect? | boolean | Optional Vorteinstellung true - true : Mehrfachauswahl von Einträgen ist möglich false : Mehrfachauswahl von Einträgen ist nicht möglich |
allowFilter? | boolean | Optional Vorteinstellung true - true : Suche innerhalb der Auflistung der Einträge ermöglicht false : Suche innerhalb der Auflistung der Einträge nicht ermöglicht |
profileKey? | string | Optional - 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 | Optional - Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden. |
Rückgabewert
Promise<CRMDialogResult<string[]>>
Enthält ein Array der ausgewählten Strings in Value . Bei Benutzerabbruch ist IsCanceled gesetzt
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Dispose()
Dispose(): void;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:9205
Standardimplementierung des Dispose
Rückgabewert
void
DisposeAsync()
DisposeAsync(): Promise<void>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:9194
Standardimplementierung des AsyncDispose
Rückgabewert
Promise<void>
Encrypt()
Encrypt(input, key): Promise<string>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:9174
Verschlüsselt einen Text anhand eines übergebenen Keys
Parameter
| Parameter | Type | Description |
|---|---|---|
input | string | Zu verschlüsselnder Text |
key | string | Passphrase |
Rückgabewert
Promise<string>
Verschlüsselter Text
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
EndWaitDlg()
EndWaitDlg(): Promise<void>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8965
Blendet einen zuvor mit StartWaitDlg angezeigten Wartedialog aus.
Rückgabewert
Promise<void>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
FetchGlobalConfigFile()
FetchGlobalConfigFile(sourceFilePath, targetFilePath): Promise<boolean>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8979
Holt die globalen Konfigurationsdateien ohne Projekt-ID.
Parameter
| Parameter | Type | Description |
|---|---|---|
sourceFilePath | string | Dateiname in der cmbt_Files Tabelle in der System-Datenbank |
targetFilePath | string | Dateiname, unter dem die Datei abgespeichert werden soll. |
Rückgabewert
Promise<boolean>
true wenn der Befehl erfolgreich ausgeführt wurde, andernfalls false
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
GetIniProfileString()
GetIniProfileString(
section,
property,
defaultValue,
iniFile): Promise<string>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:8995
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
Promise<string>
Eintrag der INI-Datei
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
InvokeMenu()
InvokeMenu(menuId, synchronous): Promise<boolean>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:9010
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. |
synchronous | boolean | true : synchrone Ausführung false : asynchrone Ausführung |
Rückgabewert
Promise<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
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Login()
Login(
projectFilePath,
userName,
password): Promise<Project>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:9026
Öffnet ein Projekt.
Diese Methode sollte nur aufgerufen werden, wenn noch kein anderes Projekt geladen ist.
Parameter
| Parameter | Type | Description |
|---|---|---|
projectFilePath | 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. |
password | string | Passwort des Benutzers |
Rückgabewert
Promise<Project>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
PerformanceCounterCreate()
PerformanceCounterCreate(counterName): Promise<void>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:9045
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
Promise<void>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
PerformanceCounterHit()
PerformanceCounterHit(counterName, additionalInfo?): Promise<void>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:9058
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 | Optional - Weitere Informationen. |
Rückgabewert
Promise<void>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
SendMail()
SendMail(
subject,
content,
toEmailAddresses?,
ccEmailAddresses?,
bccEmailAddresses?,
files?,
showDialog?): Promise<boolean>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:9082
Sendet eine eMail über die MAPI-Schnittstelle, unabhängig von den Record oder RecordSet Objekten.
Parameter
| Parameter | Type | Description |
|---|---|---|
subject | string | Betreff der eMail. |
content | string | Text der eMail. |
toEmailAddresses? | string[] | Empfänger E-Mail-Adressen |
ccEmailAddresses? | string[] | CC E-Mail-Adressen |
bccEmailAddresses? | string[] | BCC E-Mail-Adressen |
files? | string[] | Optional - Liste von eMail-Anhängen. |
showDialog? | boolean | Optional Voreinstellung: true - Gibt an ob der Dialog angezeigt wird |
Rückgabewert
Promise<boolean>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
SetIniProfileString()
SetIniProfileString(
section,
property,
value,
iniFile): Promise<void>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:9115
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
Promise<void>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
SetWaitDlgText()
SetWaitDlgText(text): Promise<void>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:9126
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
Promise<void>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
StartWaitDlg()
StartWaitDlg(
text,
cancel,
initialDelay?): Promise<void>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:9139
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 | Optional - 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
Promise<void>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
StoreGlobalConfigFile()
StoreGlobalConfigFile(sourceFilePath, targetFilePath): Promise<boolean>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:9160
Speichert die globalen Konfigurationsdateien ohne Projekt-ID.
Parameter
| Parameter | Type | Description |
|---|---|---|
sourceFilePath | string | Dateiname unter dem die Datei in der cmbt_Files Tabelle in der System-Datenbank abgelegt werden soll. |
targetFilePath | string | Dateiname der lokalen Datei, die verwendet werden soll. |
Rückgabewert
Promise<boolean>
true wenn der Befehl erfolgreich ausgeführt wurde, andernfalls false
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
[hasInstance]()
static hasInstance: boolean;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:9219
Symbol.hasInstance welches eine benutzerdefinierte Überprüfung der 'instanceof'-Operation für Objekte ermöglicht.
Parameter
| Parameter | Type |
|---|---|
value | any |
Rückgabewert
boolean