RecordSet
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9301
Datensätze
Implementiert
Iterable<Record>AsyncDisposableDisposable
Eigenschaften
CurrentRecord
Abfragesignatur
get CurrentRecord(): Record;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9361
Liefert den aktuellen Datensatz als Objekt vom Typ Record zurück.
Rückgabewert
CurrentRecordBuffered
Abfragesignatur
get CurrentRecordBuffered(): Record;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9378
Liefert den aktuellen Datensatz als Objekt vom Typ Record zurück. Diese Methode funktioniert nur, wenn zuvor über eine der Move...-Methoden auf einen gültigen Datensatz gesprungen wurde.Wenn z.B.keine Datensätze im RecordSet enthalten sind, liefert diese Methode kein Record Objekt zurück.
Rückgabewert
CurrentRecordSynchronized
Abfragesignatur
get CurrentRecordSynchronized(): Record;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9396
Liefert den aktuellen Datensatz als Objekt vom Typ Record zurück. Wenn z. B. keine Datensätze im RecordSet enthalten sind, liefert diese Methode kein Record Objekt zurück.
Deprecated
Diese Eigenschaft ist aus Kompatibilitätsgründen enthalten, siehe die Methode CurrentRecord für den empfohlenen Weg
Rückgabewert
HasMultipleRecords
Abfragesignatur
get HasMultipleRecords(): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9315
Gibt true zurück, wenn das RecordSet mehr als einen Datensatz beinhaltet. Diese Methode ist deutlich effizienter als die Abfrage von RecCount , insofern bei einem Filter genau ein Treffer erwartet wird, aber auch der Fall mit mehreren Treffern sauber behandelt werden soll.
Rückgabewert
boolean
IsDisposed
Abfragesignatur
get IsDisposed(): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9410
Gibt an, ob das Objekt bereits Freigegeben wurde
Rückgabewert
boolean
RecCount
Abfragesignatur
get RecCount(): number;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9325
Liefert die Anzahl der Datensätze im aktuellen RecordSet Objekt zurück.
Sollte das RecordSet Objekt zuvor gefiltert worden sein, dann wird die Anzahl der im Filter befindlichen Datensätze zurückgeliefert. Ohne aktiven Filter erhält man die Gesamtzahl der Datensätze
Rückgabewert
number
SortOrder
Abfragesignatur
get SortOrder(): number;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9335
Gibt die aktuell gesetzte Sortierung zurück oder setzt diese
0 = Ohne Sortierung
Rückgabewert
number
Änderungssignatur
set SortOrder(val): void;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9344
Gibt die aktuell gesetzte Sortierung zurück oder setzt diese
0 = Ohne Sortierung
Parameter
| Parameter | Type |
|---|---|
val | number |
Rückgabewert
void
ViewName
Abfragesignatur
get ViewName(): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9352
Gibt den Namen des übergeordneten View Objektes zurück.
Rückgabewert
string
Methoden
[asyncDispose]()
asyncDispose: Promise<void>;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10865
Standardimplementierung des AsyncDispose Symbols
Rückgabewert
Promise<void>
Implementierung von
AsyncDisposable.[asyncDispose]
[dispose]()
dispose: void;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10876
Standardimplementierung des Dispose Symbols
Rückgabewert
void
Implementierung von
Disposable.[dispose]
[iterator]()
iterator: IterableIterator<Record>;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10847
Standardimplementierung des Iterators
Rückgabewert
IterableIterator<Record>
Implementierung von
Iterable.[iterator]
CalcAggregationValues()
CalcAggregationValues(aggregationColumnsExpression): DataItem;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9442
Erlaubt die Berechnung von Aggregationsergebnissen basierend auf dem aktuellen Filter.
Parameter
| Parameter | Type | Description |
|---|---|---|
aggregationColumnsExpression | string | Übergabe des SQL-Ausdrucks. Ergebnis sollten Spalten sein, die beispielsweise auch bei der Nutzung von SELECT den Rückgabewert darstellen. Etwaige Spaltendatentypen bleiben, soweit möglich, erhalten. Unbenannte Spaltennamen ohne Alias erhalten die Namen $Field1 bis $FieldN. |
Rückgabewert
Example
Beispielaufruf
CalcAggregationValues("count(1) as Counter, min(\"Birthday\") as Oldest, max(\"Birthday\") as Youngest");
CreateCopy()
Aufrufsignatur
CreateCopy(): RecordSet;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9459
Erstellt eine Kopie des aktuellen RecordSet Objekts, um dieses beispielsweise per Filter weiter einzugrenzen, ohne dafür das zugrundeliegende RecordSet Objekt verändern zu müssen.
Rückgabewert
RecordSet
Aufrufsignatur
CreateCopy(cursorMode): RecordSet;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9472
Erstellt eine Kopie des aktuellen RecordSet Objekts, um dieses beispielsweise per Filter weiter einzugrenzen, ohne dafür das zugrundeliegende RecordSet Objekt verändern zu müssen.
Parameter
| Parameter | Type | Description |
|---|---|---|
cursorMode | number | Ermöglicht die Spezifikation des Datenbankcursormodells, das für den zurückgegebenen RecordSet genutzt werden soll. Werte: 0: Erzeugt ein RecordSet mit einem Datenbankcursormodell, welches innerhalb der combit CRM-Projektdatei spezifiziert werden kann. Wird in der combit CRM-Projektdatei keine Eigenschaft COMRecordSetCursorDefault gefunden, so wird immer ein fully-dynamic RecordSet erzeugt.Mögliche Werte für die Eigenschaft sind: 1 – fully-dynamic RecordSet, 2 – forward-only RecordSet. 1: Erzeugt ein RecordSet mit fully-dynamic Datenbankcursor.. 2: Erzeugt ein RecordSet mit forward-only Datenbankcursor. Ermöglicht deutliche Performance-Gewinne, insbesondere bei großen Datenmengen und komplexen Filterausdrücken, erlaubt aber lediglich das einmalige Durchlaufen in Vorwärtsrichtung durch den RecordSet. Die Methoden DialogSelectRecord(windowTitle: string) , DialogSelectRecordMultiple(windowTitle: string) , SendBulkMail(templatePath: string, errorTagFilePath: string) (bei anzuzeigendem integrierten Mail-Editor), MovePrevious() , MoveLast() , DialogSelectRecordDropDown(recordSet: RecordSet) werden einen Scriptfehler werfen, wenn diese für einen forward-only RecordSet genutzt werden. Für diese Methoden muss der RecordSet explizit ohne forward-only(Werte 0 oder 1) erzeugt werden |
Rückgabewert
RecordSet
DeleteAllRecords()
DeleteAllRecords(): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9503
Löscht alle Datensätze im Filter des aktuellen RecordSet -Objektes
Rückgabewert
boolean
DialogEditFormula()
Aufrufsignatur
DialogEditFormula(title, formula): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9518
Stellt den Formel-Assistenten basierend auf den Feldern des aktuellen RecordSet dar
Parameter
| Parameter | Type | Description |
|---|---|---|
title | string | Titel des Dialogs inklusive des Anhangs" bearbeiten". Wenn eine leere Zeichenkette übergeben wird, wird "Formel bearbeiten" verwendet. |
formula | string | Zu bearbeitende Formel. |
Rückgabewert
string
Formel - Die Formel konnte erfolgreich erstellt werden und befindet sich nun im Rückgabewert der Methode.
$CANCEL$ - Der Formel-Assistent wurde vom Benutzer geschlossen bzw.die Eingabe abgebrochen.
$ERROR$\t$lt;Fehlertext> - Es ist ein Fehler aufgetreten. Genauere Informationen finden sich TAB-getrennt im Fehlertext.
Aufrufsignatur
DialogEditFormula(
title,
formula,
useRealData): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9532
Stellt den Formel-Assistenten basierend auf den Feldern des aktuellen RecordSet dar
Parameter
| Parameter | Type | Description |
|---|---|---|
title | string | Titel des Dialogs inklusive des Anhangs" bearbeiten". Wenn eine leere Zeichenkette übergeben wird, wird "Formel bearbeiten" verwendet. |
formula | string | Zu bearbeitende Formel. |
useRealData | boolean | true : Es wird in der Formelergebnis-Vorschau mit den aktuellen Werten des aktuellen Datensatzes gearbeitet. false : Es werden keine Echtdaten verwendet. |
Rückgabewert
string
Formel - Die Formel konnte erfolgreich erstellt werden und befindet sich nun im Rückgabewert der Methode.
$CANCEL$ - Der Formel-Assistent wurde vom Benutzer geschlossen bzw.die Eingabe abgebrochen.
$ERROR$\t$lt;Fehlertext> - Es ist ein Fehler aufgetreten. Genauere Informationen finden sich TAB-getrennt im Fehlertext.
Aufrufsignatur
DialogEditFormula(
title,
formula,
useRealData,
allowedResultType): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9551
Stellt den Formel-Assistenten basierend auf den Feldern des aktuellen RecordSet dar
Parameter
| Parameter | Type | Description |
|---|---|---|
title | string | Titel des Dialogs inklusive des Anhangs" bearbeiten". Wenn eine leere Zeichenkette übergeben wird, wird "Formel bearbeiten" verwendet. |
formula | string | Zu bearbeitende Formel. |
useRealData | boolean | Es wird in der Formelergebnis-Vorschau mit den aktuellen Werten des aktuellen Datensatzes gearbeitet. false : Es werden keine Echtdaten verwendet. |
allowedResultType | number | 0x10000000 = Text, 0x08000000 = Numerisch, 0x04000000 = Datum, 0x02000000 = Boolean Diese Werte können beliebig miteinander kombiniert("verODERt") werden. |
Rückgabewert
string
Formel - Die Formel konnte erfolgreich erstellt werden und befindet sich nun im Rückgabewert der Methode.
$CANCEL$ - Der Formel-Assistent wurde vom Benutzer geschlossen bzw.die Eingabe abgebrochen.
$ERROR$\t$lt;Fehlertext> - Es ist ein Fehler aufgetreten. Genauere Informationen finden sich TAB-getrennt im Fehlertext.
Aufrufsignatur
DialogEditFormula(
title,
formula,
useRealData,
allowedResultType,
parentHandle): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9571
Stellt den Formel-Assistenten basierend auf den Feldern des aktuellen RecordSet dar
Parameter
| Parameter | Type | Description |
|---|---|---|
title | string | Titel des Dialogs inklusive des Anhangs" bearbeiten". Wenn eine leere Zeichenkette übergeben wird, wird "Formel bearbeiten" verwendet. |
formula | string | Zu bearbeitende Formel. |
useRealData | boolean | Es wird in der Formelergebnis-Vorschau mit den aktuellen Werten des aktuellen Datensatzes gearbeitet. false : Es werden keine Echtdaten verwendet. |
allowedResultType | number | 0x10000000 = Text, 0x08000000 = Numerisch, 0x04000000 = Datum, 0x02000000 = Boolean Diese Werte können beliebig miteinander kombiniert("verODERt") werden. |
parentHandle | number | Ermöglicht die Übergabe eines Handles für das Elternfenster |
Rückgabewert
string
Formel - Die Formel konnte erfolgreich erstellt werden und befindet sich nun im Rückgabewert der Methode.
$CANCEL$ - Der Formel-Assistent wurde vom Benutzer geschlossen bzw.die Eingabe abgebrochen.
$ERROR$\t$lt;Fehlertext> - Es ist ein Fehler aufgetreten. Genauere Informationen finden sich TAB-getrennt im Fehlertext.
DialogFilterAssistant()
Aufrufsignatur
DialogFilterAssistant(windowTitle, filterStatementFile): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9602
Stellt den Dialog des Filter-Assistenten dar. Es besteht die Möglichkeit eine .crmshare-Datei zu übergeben, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Als Rückgabewert erhält man eine .crmshare-Datei, welche den zusammengestellten Filterausdruck enthält. Das anschließende Bereinigen der erstellten .crmshare-Datei wird nicht vom cRM durchgeführt.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenster Titel. Aktuell reserviert |
filterStatementFile | string | Pfad zu einer .crmshare-Datei, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Falls eine solche Datei nicht vorhanden ist kann eine leere Zeichenkette übergeben werden. |
Rückgabewert
string
Pfad zu einer .crmshare-Datei - Der Filterausdruck konnte erfolgreich in eine .crmshare-Datei überführt werden
$CANCEL$ - Der Filter-Dialog wurde vom Benutzer geschlossen bzw. die Eingabe abgebrochen
$ERROR$ - Es ist ein Fehler aufgetreten (z. B. .crmshare-Datei konnte nicht erzeugt werden, der übergebene Filter passt nicht zur Ansicht, auf der das RecordSet basiert, der Filter ist von einem anderen Filtertyp, als der Dialog, der angezeigt werden soll).
Aufrufsignatur
DialogFilterAssistant(
windowTitle,
filterStatementFile,
disableAskString): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9615
Stellt den Dialog des Filter-Assistenten dar. Es besteht die Möglichkeit eine .crmshare-Datei zu übergeben, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Als Rückgabewert erhält man eine .crmshare-Datei, welche den zusammengestellten Filterausdruck enthält. Das anschließende Bereinigen der erstellten .crmshare-Datei wird nicht vom cRM durchgeführt.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenster Titel. Aktuell reserviert |
filterStatementFile | string | Pfad zu einer .crmshare-Datei, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Falls eine solche Datei nicht vorhanden ist kann eine leere Zeichenkette übergeben werden. |
disableAskString | boolean | true Benutzereingabe als Filter-Element wird nicht angeboten |
Rückgabewert
string
Pfad zu einer .crmshare-Datei - Der Filterausdruck konnte erfolgreich in eine .crmshare-Datei überführt werden
$CANCEL$ - Der Filter-Dialog wurde vom Benutzer geschlossen bzw. die Eingabe abgebrochen
$ERROR$ - Es ist ein Fehler aufgetreten (z. B. .crmshare-Datei konnte nicht erzeugt werden, der übergebene Filter passt nicht zur Ansicht, auf der das RecordSet basiert, der Filter ist von einem anderen Filtertyp, als der Dialog, der angezeigt werden soll).
Aufrufsignatur
DialogFilterAssistant(
windowTitle,
filterStatementFile,
disableAskString,
parentHandle): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9629
Stellt den Dialog des Filter-Assistenten dar. Es besteht die Möglichkeit eine .crmshare-Datei zu übergeben, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Als Rückgabewert erhält man eine .crmshare-Datei, welche den zusammengestellten Filterausdruck enthält. Das anschließende Bereinigen der erstellten .crmshare-Datei wird nicht vom cRM durchgeführt.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenster Titel. Aktuell reserviert |
filterStatementFile | string | Pfad zu einer .crmshare-Datei, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Falls eine solche Datei nicht vorhanden ist kann eine leere Zeichenkette übergeben werden. |
disableAskString | boolean | true Benutzereingabe als Filter-Element wird nicht angeboten |
parentHandle | number | Ermöglicht die Übergabe eines Handles für das Elternfenster |
Rückgabewert
string
Pfad zu einer .crmshare-Datei - Der Filterausdruck konnte erfolgreich in eine .crmshare-Datei überführt werden
$CANCEL$ - Der Filter-Dialog wurde vom Benutzer geschlossen bzw. die Eingabe abgebrochen
$ERROR$ - Es ist ein Fehler aufgetreten (z. B. .crmshare-Datei konnte nicht erzeugt werden, der übergebene Filter passt nicht zur Ansicht, auf der das RecordSet basiert, der Filter ist von einem anderen Filtertyp, als der Dialog, der angezeigt werden soll).
DialogFilterGeneral()
Aufrufsignatur
DialogFilterGeneral(windowTitle, filterStatementFile): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9657
Stellt den Dialog des Filter-Allgemein dar. Es besteht die Möglichkeit eine .crmshare-Datei zu übergeben, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Als Rückgabewert erhält man eine .crmshare-Datei, welche den zusammengestellten Filterausdruck enthält. Das anschließende Bereinigen der erstellten .crmshare-Datei wird nicht vom cRM durchgeführt.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenster Titel. Aktuell reserviert |
filterStatementFile | string | Pfad zu einer .crmshare-Datei, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Falls eine solche Datei nicht vorhanden ist kann eine leere Zeichenkette übergeben werden. |
Rückgabewert
string
Pfad zu einer .crmshare-Datei - Der Filterausdruck konnte erfolgreich in eine .crmshare-Datei überführt werden
$CANCEL$ - Der Filter-Dialog wurde vom Benutzer geschlossen bzw. die Eingabe abgebrochen
$ERROR$ - Es ist ein Fehler aufgetreten (z. B. .crmshare-Datei konnte nicht erzeugt werden, der übergebene Filter passt nicht zur Ansicht, auf der das RecordSet basiert, der Filter ist von einem anderen Filtertyp, als der Dialog, der angezeigt werden soll).
Aufrufsignatur
DialogFilterGeneral(
windowTitle,
filterStatementFile,
disableAskString): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9670
Stellt den Dialog des Filter-Allgemein dar. Es besteht die Möglichkeit eine .crmshare-Datei zu übergeben, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Als Rückgabewert erhält man eine .crmshare-Datei, welche den zusammengestellten Filterausdruck enthält. Das anschließende Bereinigen der erstellten .crmshare-Datei wird nicht vom cRM durchgeführt.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenster Titel. Aktuell reserviert |
filterStatementFile | string | Pfad zu einer .crmshare-Datei, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Falls eine solche Datei nicht vorhanden ist kann eine leere Zeichenkette übergeben werden. |
disableAskString | boolean | true Benutzereingabe als Filter-Element wird nicht angeboten |
Rückgabewert
string
Pfad zu einer .crmshare-Datei - Der Filterausdruck konnte erfolgreich in eine .crmshare-Datei überführt werden
$CANCEL$ - Der Filter-Dialog wurde vom Benutzer geschlossen bzw. die Eingabe abgebrochen
$ERROR$ - Es ist ein Fehler aufgetreten (z. B. .crmshare-Datei konnte nicht erzeugt werden, der übergebene Filter passt nicht zur Ansicht, auf der das RecordSet basiert, der Filter ist von einem anderen Filtertyp, als der Dialog, der angezeigt werden soll).
Aufrufsignatur
DialogFilterGeneral(
windowTitle,
filterStatementFile,
disableAskString,
parentHandle): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9684
Stellt den Dialog des Filter-Allgemein dar. Es besteht die Möglichkeit eine .crmshare-Datei zu übergeben, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Als Rückgabewert erhält man eine .crmshare-Datei, welche den zusammengestellten Filterausdruck enthält. Das anschließende Bereinigen der erstellten .crmshare-Datei wird nicht vom cRM durchgeführt.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenster Titel. Aktuell reserviert |
filterStatementFile | string | Pfad zu einer .crmshare-Datei, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Falls eine solche Datei nicht vorhanden ist kann eine leere Zeichenkette übergeben werden. |
disableAskString | boolean | true Benutzereingabe als Filter-Element wird nicht angeboten |
parentHandle | number | Ermöglicht die Übergabe eines Handles für das Elternfenster |
Rückgabewert
string
Pfad zu einer .crmshare-Datei - Der Filterausdruck konnte erfolgreich in eine .crmshare-Datei überführt werden
$CANCEL$ - Der Filter-Dialog wurde vom Benutzer geschlossen bzw. die Eingabe abgebrochen
$ERROR$ - Es ist ein Fehler aufgetreten (z. B. .crmshare-Datei konnte nicht erzeugt werden, der übergebene Filter passt nicht zur Ansicht, auf der das RecordSet basiert, der Filter ist von einem anderen Filtertyp, als der Dialog, der angezeigt werden soll).
DialogFilterSQLQuery()
Aufrufsignatur
DialogFilterSQLQuery(windowTitle, filterStatementFile): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9712
Stellt den Dialog des Filter-SQL-Abfrage dar. Es besteht die Möglichkeit eine .crmshare-Datei zu übergeben, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Als Rückgabewert erhält man eine .crmshare-Datei, welche den zusammengestellten Filterausdruck enthält. Das anschließende Bereinigen der erstellten .crmshare-Datei wird nicht vom cRM durchgeführt.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenster Titel. Aktuell reserviert |
filterStatementFile | string | Pfad zu einer .crmshare-Datei, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Falls eine solche Datei nicht vorhanden ist kann eine leere Zeichenkette übergeben werden. |
Rückgabewert
string
Pfad zu einer .crmshare-Datei - Der Filterausdruck konnte erfolgreich in eine .crmshare-Datei überführt werden
$CANCEL$ - Der Filter-Dialog wurde vom Benutzer geschlossen bzw. die Eingabe abgebrochen
$ERROR$ - Es ist ein Fehler aufgetreten (z. B. .crmshare-Datei konnte nicht erzeugt werden, der übergebene Filter passt nicht zur Ansicht, auf der das RecordSet basiert, der Filter ist von einem anderen Filtertyp, als der Dialog, der angezeigt werden soll).
Aufrufsignatur
DialogFilterSQLQuery(
windowTitle,
filterStatementFile,
disableAskString): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9725
Stellt den Dialog des Filter-SQL-Abfrage dar. Es besteht die Möglichkeit eine .crmshare-Datei zu übergeben, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Als Rückgabewert erhält man eine .crmshare-Datei, welche den zusammengestellten Filterausdruck enthält. Das anschließende Bereinigen der erstellten .crmshare-Datei wird nicht vom cRM durchgeführt.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenster Titel. Aktuell reserviert |
filterStatementFile | string | Pfad zu einer .crmshare-Datei, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Falls eine solche Datei nicht vorhanden ist kann eine leere Zeichenkette übergeben werden. |
disableAskString | boolean | true Benutzereingabe als Filter-Element wird nicht angeboten |
Rückgabewert
string
Pfad zu einer .crmshare-Datei - Der Filterausdruck konnte erfolgreich in eine .crmshare-Datei überführt werden
$CANCEL$ - Der Filter-Dialog wurde vom Benutzer geschlossen bzw. die Eingabe abgebrochen
$ERROR$ - Es ist ein Fehler aufgetreten (z. B. .crmshare-Datei konnte nicht erzeugt werden, der übergebene Filter passt nicht zur Ansicht, auf der das RecordSet basiert, der Filter ist von einem anderen Filtertyp, als der Dialog, der angezeigt werden soll).
Aufrufsignatur
DialogFilterSQLQuery(
windowTitle,
filterStatementFile,
disableAskString,
parentHandle): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9739
Stellt den Dialog des Filter-SQL-Abfrage dar. Es besteht die Möglichkeit eine .crmshare-Datei zu übergeben, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Als Rückgabewert erhält man eine .crmshare-Datei, welche den zusammengestellten Filterausdruck enthält. Das anschließende Bereinigen der erstellten .crmshare-Datei wird nicht vom cRM durchgeführt.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenster Titel. Aktuell reserviert |
filterStatementFile | string | Pfad zu einer .crmshare-Datei, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Falls eine solche Datei nicht vorhanden ist kann eine leere Zeichenkette übergeben werden. |
disableAskString | boolean | true Benutzereingabe als Filter-Element wird nicht angeboten |
parentHandle | number | Ermöglicht die Übergabe eines Handles für das Elternfenster |
Rückgabewert
string
Pfad zu einer .crmshare-Datei - Der Filterausdruck konnte erfolgreich in eine .crmshare-Datei überführt werden
$CANCEL$ - Der Filter-Dialog wurde vom Benutzer geschlossen bzw. die Eingabe abgebrochen
$ERROR$ - Es ist ein Fehler aufgetreten (z. B. .crmshare-Datei konnte nicht erzeugt werden, der übergebene Filter passt nicht zur Ansicht, auf der das RecordSet basiert, der Filter ist von einem anderen Filtertyp, als der Dialog, der angezeigt werden soll).
DialogSelectRecord()
Aufrufsignatur
DialogSelectRecord(windowTitle): Record;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9765
Ermöglicht die Auswahl eines Datensatzes basierend auf dem aktuellen Filter des RecordSet Objektes. Das Ergebnis ist ein Objekt vom Typ Record .
Wenn kein Datensatz ausgewählt wurde, wird null zurückgegeben.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenstertitel des erzeugten Dialoges. Der Titel kann auch leer übergeben werden, dann wird eine Grundeinstellung genommen. |
Rückgabewert
Rückgabe: Record wenn ein Datensatz ausgewählt wurde, andernfalls null
Aufrufsignatur
DialogSelectRecord(windowTitle, allowUserDefinedSortOrder): Record;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9777
Ermöglicht die Auswahl eines Datensatzes basierend auf dem aktuellen Filter des RecordSet Objektes. Das Ergebnis ist ein Objekt vom Typ Record .
Wenn kein Datensatz ausgewählt wurde, wird null zurückgegeben.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenstertitel des erzeugten Dialoges. Der Titel kann auch leer übergeben werden, dann wird eine Grundeinstellung genommen. |
allowUserDefinedSortOrder | boolean | true : Eine etwaige vom Benutzer in diesem Dialog zuletzt eingestellte Sortierung wird verwendet. Standardmäßig wird die erste Sortierung aktiviert, die in der zum RecordSet gehörenden Ansicht definiert wurde. false : Es wird die im RecordSet eingestellte Sortierung verwendet. Ist keine eingestellt, so wird die erste Sortierung aktiviert, die in der zum RecordSet gehörenden Ansicht definiert wurde. |
Rückgabewert
Rückgabe: Record wenn ein Datensatz ausgewählt wurde, andernfalls null
Aufrufsignatur
DialogSelectRecord(
windowTitle,
allowUserDefinedSortOrder,
parentHandle): Record;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9790
Ermöglicht die Auswahl eines Datensatzes basierend auf dem aktuellen Filter des RecordSet Objektes. Das Ergebnis ist ein Objekt vom Typ Record .
Wenn kein Datensatz ausgewählt wurde, wird null zurückgegeben.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenstertitel des erzeugten Dialoges. Der Titel kann auch leer übergeben werden, dann wird eine Grundeinstellung genommen. |
allowUserDefinedSortOrder | boolean | true : Eine etwaige vom Benutzer in diesem Dialog zuletzt eingestellte Sortierung wird verwendet. Standardmäßig wird die erste Sortierung aktiviert, die in der zum RecordSet gehörenden Ansicht definiert wurde. false : Es wird die im RecordSet eingestellte Sortierung verwendet. Ist keine eingestellt, so wird die erste Sortierung aktiviert, die in der zum RecordSet gehörenden Ansicht definiert wurde. |
parentHandle | number | Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll. |
Rückgabewert
Rückgabe: Record wenn ein Datensatz ausgewählt wurde, andernfalls null
DialogSelectRecordMultiple()
Aufrufsignatur
DialogSelectRecordMultiple(windowTitle): RecordSet;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9841
Ermöglicht die Auswahl mehrerer Datensätze basierend auf dem aktuellen Filter des RecordSet Objektes. Das Ergebnis ist ein neues unabhängiges Objekt vom Typ RecordSet , welches die gefiltertern Datensätze enthält.
Wenn ohne Setzen eines Häkchens einer Checkbox für die Datensatzauswahl der Dialog mit OK bestätigt wird, wird der blau hinterlegte und selektierte Datensatz an das RecordSet übergeben. Dies kann ebenso mit einem Doppelklick auf den gewünschten Datensatz erreicht werden, sofern noch keine anderen Datensätze angehakt wurden.
Wenn kein Datensatz ausgewählt werden soll, muss die Abbrechen-Schaltfläche betätigt werden – es wird dann null zurückgegeben.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenstertitel des erzeugten Dialoges. Der Titel kann auch leer übergeben werden, dann wird eine Grundeinstellung genommen. |
Rückgabewert
RecordSet
Rückgabe: RecordSet wenn Datensätze ausgewählt wurden, andernfalls null
Aufrufsignatur
DialogSelectRecordMultiple(windowTitle, allowUserDefinedSortOrder): RecordSet;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9854
Ermöglicht die Auswahl mehrerer Datensätze basierend auf dem aktuellen Filter des RecordSet Objektes. Das Ergebnis ist ein neues unabhängiges Objekt vom Typ RecordSet , welches die gefiltertern Datensätze enthält.
Wenn ohne Setzen eines Häkchens einer Checkbox für die Datensatzauswahl der Dialog mit OK bestätigt wird, wird der blau hinterlegte und selektierte Datensatz an das RecordSet übergeben. Dies kann ebenso mit einem Doppelklick auf den gewünschten Datensatz erreicht werden, sofern noch keine anderen Datensätze angehakt wurden.
Wenn kein Datensatz ausgewählt werden soll, muss die Abbrechen-Schaltfläche betätigt werden – es wird dann null zurückgegeben.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenstertitel des erzeugten Dialoges. Der Titel kann auch leer übergeben werden, dann wird eine Grundeinstellung genommen. |
allowUserDefinedSortOrder | boolean | true : Eine etwaige vom Benutzer in diesem Dialog zuletzt eingestellte Sortierung wird verwendet. Standardmäßig wird die erste Sortierung aktiviert, die in der zum RecordSet gehörenden Ansicht definiert wurde. false : Es wird die im RecordSet eingestellte Sortierung verwendet. Ist keine eingestellt, so wird die erste Sortierung aktiviert, die in der zum RecordSet gehörenden Ansicht definiert wurde. |
Rückgabewert
RecordSet
Rückgabe: RecordSet wenn Datensätze ausgewählt wurden, andernfalls null
Aufrufsignatur
DialogSelectRecordMultiple(
windowTitle,
allowUserDefinedSortOrder,
parentHandle): RecordSet;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9868
Ermöglicht die Auswahl mehrerer Datensätze basierend auf dem aktuellen Filter des RecordSet Objektes. Das Ergebnis ist ein neues unabhängiges Objekt vom Typ RecordSet , welches die gefiltertern Datensätze enthält.
Wenn ohne Setzen eines Häkchens einer Checkbox für die Datensatzauswahl der Dialog mit OK bestätigt wird, wird der blau hinterlegte und selektierte Datensatz an das RecordSet übergeben. Dies kann ebenso mit einem Doppelklick auf den gewünschten Datensatz erreicht werden, sofern noch keine anderen Datensätze angehakt wurden.
Wenn kein Datensatz ausgewählt werden soll, muss die Abbrechen-Schaltfläche betätigt werden – es wird dann null zurückgegeben.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenstertitel des erzeugten Dialoges. Der Titel kann auch leer übergeben werden, dann wird eine Grundeinstellung genommen. |
allowUserDefinedSortOrder | boolean | true : Eine etwaige vom Benutzer in diesem Dialog zuletzt eingestellte Sortierung wird verwendet. Standardmäßig wird die erste Sortierung aktiviert, die in der zum RecordSet gehörenden Ansicht definiert wurde. false : Es wird die im RecordSet eingestellte Sortierung verwendet. Ist keine eingestellt, so wird die erste Sortierung aktiviert, die in der zum RecordSet gehörenden Ansicht definiert wurde. |
parentHandle | number | Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll. |
Rückgabewert
RecordSet
Rückgabe: RecordSet wenn Datensätze ausgewählt wurden, andernfalls null
Dispose()
Dispose(): void;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10870
Standardimplementierung des Dispose
Rückgabewert
void
DisposeAsync()
DisposeAsync(): Promise<void>;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10859
Standardimplementierung des AsyncDispose
Rückgabewert
Promise<void>
ExecuteInstantReportByName()
ExecuteInstantReportByName(name): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9915
Führt einen abgespeicherten Sofortbericht anhand seines Namens aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Name des Sofortberichts. Groß- / Kleinschreibung wird beachtet! |
Rückgabewert
boolean
Export()
Export(format): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9926
Startet den Export-Assistenten und führt das übergebene Benutzerformat aus. Es werden alle Einstellungen dieses Formates verwendet.
Parameter
| Parameter | Type | Description |
|---|---|---|
format | string | Name des Exportformates. Es kann sich dabei um einen kompletten Dateipfad auf eine .etp Format-Datei handeln, alternativ um den Formatnamen, so wie er im Assistenten dargestellt wird, dabei werden zuerst die benutzerspezifischen Formate durchsucht, anschließend die globalen Formate. Bitte beachten Sie die Großkleinschreibung. |
Rückgabewert
boolean
FindRecordByDupeCheckCriteria()
Aufrufsignatur
FindRecordByDupeCheckCriteria(recordId, fieldContent1): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9939
Führt den Online-Dublettencheck anhand der übergebenen Werte und den definierten Kriterien für Dubletten aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
recordId | string | ID des Datensatzes, welcher vom DublettenCheck ausgeschlossen werden soll. Wenn dieser Parameter leer übergeben wird, dann werden alle Datensätze einbezogen. |
fieldContent1 | string | Inhalt des ersten Kriteriums für den Dublettencheck. |
Rückgabewert
boolean
true Es gab Treffer, für das RecordSet ist nun der entsprechende Filter aktiv
Aufrufsignatur
FindRecordByDupeCheckCriteria(
recordId,
fieldContent1,
fieldContent2): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9950
Führt den Online-Dublettencheck anhand der übergebenen Werte und den definierten Kriterien für Dubletten aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
recordId | string | ID des Datensatzes, welcher vom DublettenCheck ausgeschlossen werden soll. Wenn dieser Parameter leer übergeben wird, dann werden alle Datensätze einbezogen. |
fieldContent1 | string | Inhalt des ersten Kriteriums für den Dublettencheck. |
fieldContent2 | string | Inhalt des zweiten Kriteriums für den Dublettencheck. |
Rückgabewert
boolean
true Es gab Treffer, für das RecordSet ist nun der entsprechende Filter aktiv
Aufrufsignatur
FindRecordByDupeCheckCriteria(
recordId,
fieldContent1,
fieldContent2,
fieldContent3): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9962
Führt den Online-Dublettencheck anhand der übergebenen Werte und den definierten Kriterien für Dubletten aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
recordId | string | ID des Datensatzes, welcher vom DublettenCheck ausgeschlossen werden soll. Wenn dieser Parameter leer übergeben wird, dann werden alle Datensätze einbezogen. |
fieldContent1 | string | Inhalt des ersten Kriteriums für den Dublettencheck. |
fieldContent2 | string | Inhalt des zweiten Kriteriums für den Dublettencheck. |
fieldContent3 | string | Inhalt des drittens Kriteriums für den Dublettencheck. |
Rückgabewert
boolean
true Es gab Treffer, für das RecordSet ist nun der entsprechende Filter aktiv
Aufrufsignatur
FindRecordByDupeCheckCriteria(
recordId,
fieldContent1,
fieldContent2,
fieldContent3,
fieldContent4): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9975
Führt den Online-Dublettencheck anhand der übergebenen Werte und den definierten Kriterien für Dubletten aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
recordId | string | ID des Datensatzes, welcher vom DublettenCheck ausgeschlossen werden soll. Wenn dieser Parameter leer übergeben wird, dann werden alle Datensätze einbezogen. |
fieldContent1 | string | Inhalt des ersten Kriteriums für den Dublettencheck. |
fieldContent2 | string | Inhalt des zweiten Kriteriums für den Dublettencheck. |
fieldContent3 | string | Inhalt des drittens Kriteriums für den Dublettencheck. |
fieldContent4 | string | Inhalt des vierten Kriteriums für den Dublettencheck. |
Rückgabewert
boolean
true Es gab Treffer, für das RecordSet ist nun der entsprechende Filter aktiv
Aufrufsignatur
FindRecordByDupeCheckCriteria(
recordId,
fieldContent1,
fieldContent2,
fieldContent3,
fieldContent4,
fieldContent5): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:9989
Führt den Online-Dublettencheck anhand der übergebenen Werte und den definierten Kriterien für Dubletten aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
recordId | string | ID des Datensatzes, welcher vom DublettenCheck ausgeschlossen werden soll. Wenn dieser Parameter leer übergeben wird, dann werden alle Datensätze einbezogen. |
fieldContent1 | string | Inhalt des ersten Kriteriums für den Dublettencheck. |
fieldContent2 | string | Inhalt des zweiten Kriteriums für den Dublettencheck. |
fieldContent3 | string | Inhalt des drittens Kriteriums für den Dublettencheck. |
fieldContent4 | string | Inhalt des vierten Kriteriums für den Dublettencheck. |
fieldContent5 | string | Inhalt des fünften Kriteriums für den Dublettencheck. |
Rückgabewert
boolean
true Es gab Treffer, für das RecordSet ist nun der entsprechende Filter aktiv
Aufrufsignatur
FindRecordByDupeCheckCriteria(
recordId,
fieldContent1,
fieldContent2,
fieldContent3,
fieldContent4,
fieldContent5,
fieldContent6): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10004
Führt den Online-Dublettencheck anhand der übergebenen Werte und den definierten Kriterien für Dubletten aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
recordId | string | ID des Datensatzes, welcher vom DublettenCheck ausgeschlossen werden soll. Wenn dieser Parameter leer übergeben wird, dann werden alle Datensätze einbezogen. |
fieldContent1 | string | Inhalt des ersten Kriteriums für den Dublettencheck. |
fieldContent2 | string | Inhalt des zweiten Kriteriums für den Dublettencheck. |
fieldContent3 | string | Inhalt des drittens Kriteriums für den Dublettencheck. |
fieldContent4 | string | Inhalt des vierten Kriteriums für den Dublettencheck. |
fieldContent5 | string | Inhalt des fünften Kriteriums für den Dublettencheck. |
fieldContent6 | string | Inhalt des sechsten Kriteriums für den Dublettencheck. |
Rückgabewert
boolean
true Es gab Treffer, für das RecordSet ist nun der entsprechende Filter aktiv
Aufrufsignatur
FindRecordByDupeCheckCriteria(
recordId,
fieldContent1,
fieldContent2,
fieldContent3,
fieldContent4,
fieldContent5,
fieldContent6,
fieldContent7): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10020
Führt den Online-Dublettencheck anhand der übergebenen Werte und den definierten Kriterien für Dubletten aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
recordId | string | ID des Datensatzes, welcher vom DublettenCheck ausgeschlossen werden soll. Wenn dieser Parameter leer übergeben wird, dann werden alle Datensätze einbezogen. |
fieldContent1 | string | Inhalt des ersten Kriteriums für den Dublettencheck. |
fieldContent2 | string | Inhalt des zweiten Kriteriums für den Dublettencheck. |
fieldContent3 | string | Inhalt des drittens Kriteriums für den Dublettencheck. |
fieldContent4 | string | Inhalt des vierten Kriteriums für den Dublettencheck. |
fieldContent5 | string | Inhalt des fünften Kriteriums für den Dublettencheck. |
fieldContent6 | string | Inhalt des sechsten Kriteriums für den Dublettencheck. |
fieldContent7 | string | Inhalt des siebten Kriteriums für den Dublettencheck. |
Rückgabewert
boolean
true Es gab Treffer, für das RecordSet ist nun der entsprechende Filter aktiv
Aufrufsignatur
FindRecordByDupeCheckCriteria(
recordId,
fieldContent1,
fieldContent2,
fieldContent3,
fieldContent4,
fieldContent5,
fieldContent6,
fieldContent7,
fieldContent8): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10037
Führt den Online-Dublettencheck anhand der übergebenen Werte und den definierten Kriterien für Dubletten aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
recordId | string | ID des Datensatzes, welcher vom DublettenCheck ausgeschlossen werden soll. Wenn dieser Parameter leer übergeben wird, dann werden alle Datensätze einbezogen. |
fieldContent1 | string | Inhalt des ersten Kriteriums für den Dublettencheck. |
fieldContent2 | string | Inhalt des zweiten Kriteriums für den Dublettencheck. |
fieldContent3 | string | Inhalt des drittens Kriteriums für den Dublettencheck. |
fieldContent4 | string | Inhalt des vierten Kriteriums für den Dublettencheck. |
fieldContent5 | string | Inhalt des fünften Kriteriums für den Dublettencheck. |
fieldContent6 | string | Inhalt des sechsten Kriteriums für den Dublettencheck. |
fieldContent7 | string | Inhalt des siebten Kriteriums für den Dublettencheck. |
fieldContent8 | string | Inhalt des achten Kriteriums für den Dublettencheck. |
Rückgabewert
boolean
true Es gab Treffer, für das RecordSet ist nun der entsprechende Filter aktiv
Aufrufsignatur
FindRecordByDupeCheckCriteria(
recordId,
fieldContent1,
fieldContent2,
fieldContent3,
fieldContent4,
fieldContent5,
fieldContent6,
fieldContent7,
fieldContent8,
useCurrentQuery): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10055
Führt den Online-Dublettencheck anhand der übergebenen Werte und den definierten Kriterien für Dubletten aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
recordId | string | ID des Datensatzes, welcher vom DublettenCheck ausgeschlossen werden soll. Wenn dieser Parameter leer übergeben wird, dann werden alle Datensätze einbezogen. |
fieldContent1 | string | Inhalt des ersten Kriteriums für den Dublettencheck. |
fieldContent2 | string | Inhalt des zweiten Kriteriums für den Dublettencheck. |
fieldContent3 | string | Inhalt des drittens Kriteriums für den Dublettencheck. |
fieldContent4 | string | Inhalt des vierten Kriteriums für den Dublettencheck. |
fieldContent5 | string | Inhalt des fünften Kriteriums für den Dublettencheck. |
fieldContent6 | string | Inhalt des sechsten Kriteriums für den Dublettencheck. |
fieldContent7 | string | Inhalt des siebten Kriteriums für den Dublettencheck. |
fieldContent8 | string | Inhalt des achten Kriteriums für den Dublettencheck. |
useCurrentQuery | boolean | Gibt an, ob lediglich innerhalb des aktuellen Filters gesucht werden soll. |
Rückgabewert
boolean
true Es gab Treffer, für das RecordSet ist nun der entsprechende Filter aktiv
FindRecordByEmail()
Aufrufsignatur
FindRecordByEmail(email, reduceMail): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10099
Sucht alle Datensätze, bei denen in einem eMail-Feld eine bestimmte eMail-Adresse vorhanden ist. Diese unscharfe Suche findet auch eMail-Adressen derselben Domain falls kein direkter Treffer vorhanden ist.
Parameter
| Parameter | Type | Description |
|---|---|---|
email | string | Die eMail-Adresse, nach der in allen eMail-Feldern gesucht werden soll. |
reduceMail | boolean | Wenn true , dann wird die eMail-Adresse schrittweise in bis zu vier Durchläufen durch Auslassen von Top-Level-Domain, Domain, Lokalteil gesucht, falls es nicht bereits Treffer gab. So können auch eMails unterschiedlicher Domains gefunden werden |
Rückgabewert
boolean
true Es gab Treffer, für das RecordSet ist nun der entsprechende Filter aktiv
Aufrufsignatur
FindRecordByEmail(
email,
reduceMail,
useCurrentQuery): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10110
Sucht alle Datensätze, bei denen in einem eMail-Feld eine bestimmte eMail-Adresse vorhanden ist. Diese unscharfe Suche findet auch eMail-Adressen derselben Domain falls kein direkter Treffer vorhanden ist.
Parameter
| Parameter | Type | Description |
|---|---|---|
email | string | Die eMail-Adresse, nach der in allen eMail-Feldern gesucht werden soll. |
reduceMail | boolean | Wenn true , dann wird die eMail-Adresse schrittweise in bis zu vier Durchläufen durch Auslassen von Top-Level-Domain, Domain, Lokalteil gesucht, falls es nicht bereits Treffer gab. So können auch eMails unterschiedlicher Domains gefunden werden |
useCurrentQuery | boolean | Gibt an, ob lediglich innerhalb des aktuellen Filters gesucht werden soll. |
Rückgabewert
boolean
true Es gab Treffer, für das RecordSet ist nun der entsprechende Filter aktiv
FindRecordByPhoneNumber()
Aufrufsignatur
FindRecordByPhoneNumber(phoneNo, reducePhoneNo): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10133
Sucht alle Datensätze, bei denen in einem Telefon-Feld eine bestimmte Telefonnummer vorhanden ist, analog zur Rufnummernerkennung durch den phone manager.
Parameter
| Parameter | Type | Description |
|---|---|---|
phoneNo | string | Die Telefonnummer, nach der in allen Telefonfeldern gesucht werden soll. Die Telefonnummer darf telefonspez.Sonderzeichen wie zum Beispiel '/', '+', '-' enthalten |
reducePhoneNo | boolean | Wenn true , dann wird die Telefonnummer schrittweise um bis zu 4 Stellen verkürzt, falls es nicht bereits Treffer gab.So können auch unterschiedliche Durchwahl-Nummern gefunden werden. |
Rückgabewert
boolean
true Es gab Treffer, für das RecordSet ist nun der entsprechende Filter aktiv
Aufrufsignatur
FindRecordByPhoneNumber(
phoneNo,
reducePhoneNo,
useCurrentQuery): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10144
Sucht alle Datensätze, bei denen in einem Telefon-Feld eine bestimmte Telefonnummer vorhanden ist, analog zur Rufnummernerkennung durch den phone manager.
Parameter
| Parameter | Type | Description |
|---|---|---|
phoneNo | string | Die Telefonnummer, nach der in allen Telefonfeldern gesucht werden soll. Die Telefonnummer darf telefonspez.Sonderzeichen wie zum Beispiel '/', '+', '-' enthalten |
reducePhoneNo | boolean | Wenn true , dann wird die Telefonnummer schrittweise um bis zu 4 Stellen verkürzt, falls es nicht bereits Treffer gab.So können auch unterschiedliche Durchwahl-Nummern gefunden werden. |
useCurrentQuery | boolean | Gibt an, ob lediglich innerhalb des aktuellen Filters gesucht werden soll. |
Rückgabewert
boolean
true Es gab Treffer, für das RecordSet ist nun der entsprechende Filter aktiv
Import()
Import(format): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10165
Startet den Import-Assistenten und führt das übergebene Benutzerformat aus. Es werden alle Einstellungen dieses Formates verwendet.
Parameter
| Parameter | Type | Description |
|---|---|---|
format | string | Name des Importformates. Es kann sich dabei um einen kompletten Dateipfad auf eine .itp Format-Datei handeln, alternativ um den Formatnamen, so wie er im Assistenten dargestellt wird, dabei werden zuerst die benutzerspezifischen Formate durchsucht, anschließend die globalen Formate. Bitte beachten Sie die Großkleinschreibung. |
Rückgabewert
boolean
MoveFirst()
MoveFirst(): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10176
Bewegt den Datensatz-Zeiger auf den Anfang des RecordSet .
Rückgabewert
boolean
true wenn der Pointer auf den ersten Datensatz gewechselt werden konnte, andernfalls false
MoveLast()
MoveLast(): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10187
Bewegt den Datensatz-Zeiger auf das Ende des RecordSet .
Rückgabewert
boolean
true wenn der Pointer auf den letzten Datensatz gewechselt werden konnte, andernfalls false
MoveNext()
MoveNext(): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10198
Bewegt den Datensatz-Zeiger um einen Datensatz vorwärts.
Rückgabewert
boolean
true wenn der Pointer auf den nächsten Datensatz gewechselt werden konnte, andernfalls false
MovePrevious()
MovePrevious(): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10209
Bewegt den Datensatz-Zeiger um einen Datensatz rückwärts.
Rückgabewert
boolean
true wenn der Pointer auf den vorherigen Datensatz gewechselt werden konnte, andernfalls false
NewRecord()
NewRecord(): Record;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10218
Erzeugt einen neuen Datensatz und liefert diesen als Objekt vom Typ Record zurück.
Rückgabewert
PrintCard()
Aufrufsignatur
PrintCard(
media,
fileName,
silent,
range,
outputFileName): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10241
Druckt ein Karteikartenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
media | string | Ausgabe-Medium |
fileName | string | Dateiname inkl. Pfad der Druckvorlage |
silent | boolean | Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll. |
range | boolean | true : Es werden alle Datensätze im aktuellen Filter/Datenbank ausgegeben, entspricht dem Seriendruck. false : Es wird nur der aktuelle Datensatz ausgegeben, entspricht dem Einzeldruck |
outputFileName | string | Evtl. Name und Pfad der zu erzeugenden Ausgabe-Datei bei Ausgabe-Medien wie z.B. "RTF" oder "HTML". In allen anderen Fällen kann ein leerer String übergeben werden. |
Rückgabewert
boolean
Aufrufsignatur
PrintCard(
media,
fileName,
silent,
range,
outputFileName,
useModalPreviewWindow): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10254
Druckt ein Karteikartenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
media | string | Ausgabe-Medium |
fileName | string | Dateiname inkl. Pfad der Druckvorlage |
silent | boolean | Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll. |
range | boolean | true : Es werden alle Datensätze im aktuellen Filter/Datenbank ausgegeben, entspricht dem Seriendruck. false : Es wird nur der aktuelle Datensatz ausgegeben, entspricht dem Einzeldruck |
outputFileName | string | Evtl. Name und Pfad der zu erzeugenden Ausgabe-Datei bei Ausgabe-Medien wie z.B. "RTF" oder "HTML". In allen anderen Fällen kann ein leerer String übergeben werden. |
useModalPreviewWindow | boolean | Legt fest, ob der Druck auf Vorschau (PRV) in das normale Vorschaufenster gedruckt wird oder in die Berichtsansicht( false ). |
Rückgabewert
boolean
PrintLabel()
Aufrufsignatur
PrintLabel(
media,
fileName,
silent,
range,
outputFileName): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10279
Druckt ein Etikettenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
media | string | Ausgabe-Medium |
fileName | string | Dateiname inkl. Pfad der Druckvorlage |
silent | boolean | Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll. |
range | boolean | true : Es werden alle Datensätze im aktuellen Filter/Datenbank ausgegeben, entspricht dem Seriendruck. false : Es wird nur der aktuelle Datensatz ausgegeben, entspricht dem Einzeldruck |
outputFileName | string | Evtl. Name und Pfad der zu erzeugenden Ausgabe-Datei bei Ausgabe-Medien wie z.B. "RTF" oder "HTML". In allen anderen Fällen kann ein leerer String übergeben werden. |
Rückgabewert
boolean
Aufrufsignatur
PrintLabel(
media,
fileName,
silent,
range,
outputFileName,
useModalPreviewWindow): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10292
Druckt ein Etikettenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
media | string | Ausgabe-Medium |
fileName | string | Dateiname inkl. Pfad der Druckvorlage |
silent | boolean | Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll. |
range | boolean | true : Es werden alle Datensätze im aktuellen Filter/Datenbank ausgegeben, entspricht dem Seriendruck. false : Es wird nur der aktuelle Datensatz ausgegeben, entspricht dem Einzeldruck |
outputFileName | string | Evtl. Name und Pfad der zu erzeugenden Ausgabe-Datei bei Ausgabe-Medien wie z.B. "RTF" oder "HTML". In allen anderen Fällen kann ein leerer String übergeben werden. |
useModalPreviewWindow | boolean | Legt fest, ob der Druck auf Vorschau (PRV) in das normale Vorschaufenster gedruckt wird oder in die Berichtsansicht( false ). |
Rückgabewert
boolean
PrintReport()
Aufrufsignatur
PrintReport(
media,
fileName,
silent,
range,
outputFileName): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10317
Druckt ein Listenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
media | string | Ausgabe-Medium |
fileName | string | Dateiname inkl. Pfad der Druckvorlage |
silent | boolean | Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll. |
range | boolean | true : Es werden alle Datensätze im aktuellen Filter/Datenbank ausgegeben, entspricht dem Seriendruck. false : Es wird nur der aktuelle Datensatz ausgegeben, entspricht dem Einzeldruck |
outputFileName | string | Evtl. Name und Pfad der zu erzeugenden Ausgabe-Datei bei Ausgabe-Medien wie z.B. "RTF" oder "HTML". In allen anderen Fällen kann ein leerer String übergeben werden. |
Rückgabewert
boolean
Aufrufsignatur
PrintReport(
media,
fileName,
silent,
range,
outputFileName,
useModalPreviewWindow): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10330
Druckt ein Listenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
media | string | Ausgabe-Medium |
fileName | string | Dateiname inkl. Pfad der Druckvorlage |
silent | boolean | Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll. |
range | boolean | true : Es werden alle Datensätze im aktuellen Filter/Datenbank ausgegeben, entspricht dem Seriendruck. false : Es wird nur der aktuelle Datensatz ausgegeben, entspricht dem Einzeldruck |
outputFileName | string | Evtl. Name und Pfad der zu erzeugenden Ausgabe-Datei bei Ausgabe-Medien wie z.B. "RTF" oder "HTML". In allen anderen Fällen kann ein leerer String übergeben werden. |
useModalPreviewWindow | boolean | Legt fest, ob der Druck auf Vorschau (PRV) in das normale Vorschaufenster gedruckt wird oder in die Berichtsansicht( false ). |
Rückgabewert
boolean
RecCountWithoutGeoCoordinates()
RecCountWithoutGeoCoordinates(aliasName): number;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10350
Gibt die Anzahl der unkodierten Datensätze für eine Adress-Definition zurück. Die Geokodierung der Adresse ist Voraussetzung für den Umkreis-Filter, siehe auch SetFilterByGeo(geoFilterType: number, filterOperation: number, uncodedRecordAction: number, multipleResultAction: number, aliasName: string, address: string, distance: number) .
Parameter
| Parameter | Type | Description |
|---|---|---|
aliasName | string | Name der Adresse (siehe Ansichtskonfiguration > Adressen) |
Rückgabewert
number
RelationalAppend()
RelationalAppend(name): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10361
Führt eine abgespeicherte Vorlage für relationales Ergänzen über den Namen aus. Diese kann über den Menüpunkt Organisieren > Relational Ergänzen > Allgemein erzeugt werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Name der abgespeicherten Vorlage. Hinweis: Bitte beachten Sie, dass nicht die Bezeichnung des Filterausdrucks verwendet wird, sondern der 'Name für Scripte' |
Rückgabewert
boolean
RelationalAppendDirect()
RelationalAppendDirect(relation, parameter): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10373
Direktes relationales Ergänzen in einer Relationsansicht. Die Übergabe der Werte erfolgt in folgendem Format:
{FeldName1}={Inhalt/Formel1}\t{FeldName2}={Inhalt/Formel2}\t...
Parameter
| Parameter | Type | Description |
|---|---|---|
relation | Relation | Relationsobjekt |
parameter | string | Wertepaar |
Rückgabewert
boolean
SendBulkMail()
Aufrufsignatur
SendBulkMail(templatePath, errorTagFilePath): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10391
Sendet eine Serien-eMail. Der Mailversand über diese Methode verhält sich analog zum Serien-Mailversand in der Anwendung.
Parameter
| Parameter | Type | Description |
|---|---|---|
templatePath | string | Pfad zur Mailvorlage |
errorTagFilePath | string | Pfad zur .tag-Datei für manuelles Filtern. Diese wird erstellt, wenn es im RecordSet Datensätze mit leeren eMail-Feldern gibt und enthält alle diese Datensätze. Falls ein leerer String übergeben wird, wird eine Datei im temp-Verzeichnis mit Standardnamen angelegt. |
Rückgabewert
boolean
true Der Versand war erfolgreich und es waren keine Datensätze mit leeren eMail-Feldern enthalten, andernfalls false
Aufrufsignatur
SendBulkMail(
templatePath,
errorTagFilePath,
silent): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10405
Sendet eine Serien-eMail. Der Mailversand über diese Methode verhält sich analog zum Serien-Mailversand in der Anwendung.
Parameter
| Parameter | Type | Description |
|---|---|---|
templatePath | string | Pfad zur Mailvorlage |
errorTagFilePath | string | Pfad zur .tag-Datei für manuelles Filtern. Diese wird erstellt, wenn es im RecordSet Datensätze mit leeren eMail-Feldern gibt und enthält alle diese Datensätze. Falls ein leerer String übergeben wird, wird eine Datei im temp-Verzeichnis mit Standardnamen angelegt. |
silent | boolean | Optional. false = Hinweisdialoge werden angezeigt. true = Hinweisdialoge werden ausgeblendet. |
Rückgabewert
boolean
true Der Versand war erfolgreich und es waren keine Datensätze mit leeren eMail-Feldern enthalten, andernfalls false
Aufrufsignatur
SendBulkMail(
templatePath,
errorTagFilePath,
silent,
tagFileRecordsSuccessfullySent): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10421
Sendet eine Serien-eMail. Der Mailversand über diese Methode verhält sich analog zum Serien-Mailversand in der Anwendung.
Parameter
| Parameter | Type | Description |
|---|---|---|
templatePath | string | Pfad zur Mailvorlage |
errorTagFilePath | string | Pfad zur .tag-Datei für manuelles Filtern. Diese wird erstellt, wenn es im RecordSet Datensätze mit leeren eMail-Feldern gibt und enthält alle diese Datensätze. Falls ein leerer String übergeben wird, wird eine Datei im temp-Verzeichnis mit Standardnamen angelegt. |
silent | boolean | Optional. false = Hinweisdialoge werden angezeigt. true = Hinweisdialoge werden ausgeblendet. |
tagFileRecordsSuccessfullySent | string | Pfad zur .tag-Datei für manuelles Filtern. Diese Datei enthält alle Datensätze, an die eine eMail versendet werden konnte. Über diesen Parameter kann der Pfad und Name der Datei geändert werden. Ohne Angabe dieses Parameters wird die Datei in %TEMP%\MailsSentTo.tag gespeichert und bei jedem Serienmailing (auch mittels „Ausgeben > SerieneMail“) überschrieben. |
Rückgabewert
boolean
true Der Versand war erfolgreich und es waren keine Datensätze mit leeren eMail-Feldern enthalten, andernfalls false
Aufrufsignatur
SendBulkMail(
templatePath,
errorTagFilePath,
silent,
tagFileRecordsSuccessfullySent,
attachmentFiles): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10439
Sendet eine Serien-eMail. Der Mailversand über diese Methode verhält sich analog zum Serien-Mailversand in der Anwendung.
Parameter
| Parameter | Type | Description |
|---|---|---|
templatePath | string | Pfad zur Mailvorlage |
errorTagFilePath | string | Pfad zur .tag-Datei für manuelles Filtern. Diese wird erstellt, wenn es im RecordSet Datensätze mit leeren eMail-Feldern gibt und enthält alle diese Datensätze. Falls ein leerer String übergeben wird, wird eine Datei im temp-Verzeichnis mit Standardnamen angelegt. |
silent | boolean | Optional. false = Hinweisdialoge werden angezeigt. true = Hinweisdialoge werden ausgeblendet. |
tagFileRecordsSuccessfullySent | string | Pfad zur .tag-Datei für manuelles Filtern. Diese Datei enthält alle Datensätze, an die eine eMail versendet werden konnte. Über diesen Parameter kann der Pfad und Name der Datei geändert werden. Ohne Angabe dieses Parameters wird die Datei in %TEMP%\MailsSentTo.tag gespeichert und bei jedem Serienmailing (auch mittels „Ausgeben > SerieneMail“) überschrieben. |
attachmentFiles | string | Kann eine Liste von E-Mail-Anhängen beinhalten. Diese müssen dann per Semikolon separiert übergeben werden. Beachten Sie bitte, dass die übergebenen Anhänge stets zusätzlich zu den evtl. bereits in einer über den Parameter " templatePath " definierten Mailvorlage hinterlegten Anhängen versendet werden. Dies gilt auch dann, wenn ein übergebener eMail Anhang denselben Pfad hat wie in der Mailvorlage. |
Rückgabewert
boolean
true Der Versand war erfolgreich und es waren keine Datensätze mit leeren eMail-Feldern enthalten, andernfalls false
Aufrufsignatur
SendBulkMail(
templatePath,
errorTagFilePath,
silent,
tagFileRecordsSuccessfullySent,
attachmentFiles,
showDialog): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10460
Sendet eine Serien-eMail. Der Mailversand über diese Methode verhält sich analog zum Serien-Mailversand in der Anwendung.
Parameter
| Parameter | Type | Description |
|---|---|---|
templatePath | string | Pfad zur Mailvorlage |
errorTagFilePath | string | Pfad zur .tag-Datei für manuelles Filtern. Diese wird erstellt, wenn es im RecordSet Datensätze mit leeren eMail-Feldern gibt und enthält alle diese Datensätze. Falls ein leerer String übergeben wird, wird eine Datei im temp-Verzeichnis mit Standardnamen angelegt. |
silent | boolean | Optional. false = Hinweisdialoge werden angezeigt. true = Hinweisdialoge werden ausgeblendet. |
tagFileRecordsSuccessfullySent | string | Pfad zur .tag-Datei für manuelles Filtern. Diese Datei enthält alle Datensätze, an die eine eMail versendet werden konnte. Über diesen Parameter kann der Pfad und Name der Datei geändert werden. Ohne Angabe dieses Parameters wird die Datei in %TEMP%\MailsSentTo.tag gespeichert und bei jedem Serienmailing (auch mittels „Ausgeben > SerieneMail“) überschrieben. |
attachmentFiles | string | Kann eine Liste von E-Mail-Anhängen beinhalten. Diese müssen dann per Semikolon separiert übergeben werden. Beachten Sie bitte, dass die übergebenen Anhänge stets zusätzlich zu den evtl. bereits in einer über den Parameter " templatePath " definierten Mailvorlage hinterlegten Anhängen versendet werden. Dies gilt auch dann, wenn ein übergebener eMail Anhang denselben Pfad hat wie in der Mailvorlage. |
showDialog | boolean | Ermöglicht die Anzeige des integrierten MailEditors für ein(nicht-sichtbares) RecordSet Objekt. Wird dieser Parameter auf true gesetzt hat der silent -Parameter keine Auswirkungen mehr. Es erfolgt zudem die Anzeige eines Fortschrittsdialogs. Wird der Silent-Parameter auf false gesetzt und ein RecordSet-Objekt verwendet, welches auf einem sichtbaren View-Objekt beruht, dann wird dieser Paramter (ShowDialog) ignoriert.Es erfolgt dann ebenfalls die Anzeige eines Fortschrittsdialogs. |
Rückgabewert
boolean
true Der Versand war erfolgreich und es waren keine Datensätze mit leeren eMail-Feldern enthalten, andernfalls false
SendMailDialog()
Aufrufsignatur
SendMailDialog(
address,
subject,
contents): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10491
Sendet eine eMail. Der Mailversand über diese Methode verhält sich analog zum Kontextmenü.
Parameter
| Parameter | Type | Description |
|---|---|---|
address | string | Empfänger eMail-Adresse |
subject | string | Betreff der eMail. |
contents | string | Text der eMail. |
Rückgabewert
boolean
Aufrufsignatur
SendMailDialog(
address,
subject,
contents,
files): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10502
Sendet eine eMail. Der Mailversand über diese Methode verhält sich analog zum Kontextmenü.
Parameter
| Parameter | Type | Description |
|---|---|---|
address | string | Empfänger eMail-Adresse |
subject | string | Betreff der eMail. |
contents | string | Text der eMail. |
files | string | Kann eine Liste von E-Mail-Anhängen beinhalten. Diese müssen dann per Semikolon separiert übergeben werden. Hinweis: Wenn in den allgemeinen Einstellungen "Mail per Kontextmenü über" auf "auf 'mailto:' registrierten Mail-Client" gestellt ist, hat dieser Parameter keine Auswirkung. |
Rückgabewert
boolean
SendMAPIMail()
SendMAPIMail(
address,
subject,
contents,
files,
showDialog): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10528
Sendet eine eMail über die MAPI-Schnittstelle.
Parameter
| Parameter | Type | Description |
|---|---|---|
address | string | Empfänger eMail-Adresse |
subject | string | Betreff der eMail. |
contents | string | Text der eMail. |
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
SetFilter()
Aufrufsignatur
SetFilter(filterContents): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10539
Erstellt einen Filter auf Basis des übergebenen Filter-Ausdruckes.
Der Filter kann immer nur für die jeweilige Ansicht/RecordSet ausgeführt werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
filterContents | string | Filterausdruck, entspricht den Formeln unter Filtern > Allgemein.Weitere Informationen finden Sie dort. |
Rückgabewert
boolean
Aufrufsignatur
SetFilter(filterContents, useCurrentQuery): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10549
Erstellt einen Filter auf Basis des übergebenen Filter-Ausdruckes.
Der Filter kann immer nur für die jeweilige Ansicht/RecordSet ausgeführt werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
filterContents | string | Filterausdruck, entspricht den Formeln unter Filtern > Allgemein.Weitere Informationen finden Sie dort. |
useCurrentQuery | boolean | true : Der Filter basiert auf dem aktuell bestehenden Filter. false : Es wird ein neuer Filter erstellt |
Rückgabewert
boolean
SetFilterByCurrentSortOrder()
Aufrufsignatur
SetFilterByCurrentSortOrder(
filterContents,
searchType,
caseSensitive): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10577
Erzeugt einen Filter basierend auf den Feldern der aktuellen Sortierung.
Parameter
| Parameter | Type | Description |
|---|---|---|
filterContents | string | Das Suchkriterium. |
searchType | number | 0 - Normal 1 - Exakt 2 - Wildcard 3 - Phonetisch 4 - Enthält |
caseSensitive | number | Gross-/Kleinschreibung beachten: 0 - nicht CaseSensitive 1 - CaseSensitive |
Rückgabewert
boolean
Aufrufsignatur
SetFilterByCurrentSortOrder(
filterContents,
searchType,
caseSensitive,
useCurrentQuery): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10594
Erzeugt einen Filter basierend auf den Feldern der aktuellen Sortierung.
Parameter
| Parameter | Type | Description |
|---|---|---|
filterContents | string | Das Suchkriterium. |
searchType | number | 0 - Normal 1 - Exakt 2 - Wildcard 3 - Phonetisch 4 - Enthält |
caseSensitive | number | Gross-/Kleinschreibung beachten: 0 - nicht CaseSensitive 1 - CaseSensitive |
useCurrentQuery | boolean | true : Der Filter basiert auf dem aktuell bestehenden Filter. false : Es wird ein neuer Filtererstellt. |
Rückgabewert
boolean
SetFilterByFieldName()
Aufrufsignatur
SetFilterByFieldName(
fieldName,
contents,
searchType,
caseSensitive): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10623
Setzt einen Filter anhand eines Feldinhalts.
Parameter
| Parameter | Type | Description |
|---|---|---|
fieldName | string | Name des Feldes bzw. mehrere Felder, welche mittels "+" getrennt angegeben werden. Hierbei können auch 1:1-relational oder 1:1:1 relational verknüpfte Felder angegeben werden.Bei 1:1(:1) verknüpften relationalen Feldern muss der vollständige relationale Pfad verwendet werden, z. B. "CompanyID.Firmen.ID.Company". |
contents | string | Suchbegriff(e). Suchbegriffe für mehrere Felder werden per Leerzeichen-Separator übergeben.Wenn ein Suchbegriff ein Leerzeichen enthalten soll, dann werden die Suchbegriffe mit einem Komma getrennt.Das Komma kann zudem verwendet werden, um ein Suchfeld (siehe Parameter fieldName ) auszulassen |
searchType | number | 0 - Normal 1 - Exakt 2 - Wildcard 3 - Phonetisch 4 - Enthält |
caseSensitive | number | Gross-/Kleinschreibung beachten: 0 - nicht CaseSensitive 1 - CaseSensitive |
Rückgabewert
boolean
Aufrufsignatur
SetFilterByFieldName(
fieldName,
contents,
searchType,
caseSensitive,
useCurrentQuery): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10641
Setzt einen Filter anhand eines Feldinhalts.
Parameter
| Parameter | Type | Description |
|---|---|---|
fieldName | string | Name des Feldes bzw. mehrere Felder, welche mittels "+" getrennt angegeben werden. Hierbei können auch 1:1-relational oder 1:1:1 relational verknüpfte Felder angegeben werden.Bei 1:1(:1) verknüpften relationalen Feldern muss der vollständige relationale Pfad verwendet werden, z. B. "CompanyID.Firmen.ID.Company". |
contents | string | Suchbegriff(e). Suchbegriffe für mehrere Felder werden per Leerzeichen-Separator übergeben.Wenn ein Suchbegriff ein Leerzeichen enthalten soll, dann werden die Suchbegriffe mit einem Komma getrennt.Das Komma kann zudem verwendet werden, um ein Suchfeld (siehe Parameter fieldName ) auszulassen |
searchType | number | 0 - Normal 1 - Exakt 2 - Wildcard 3 - Phonetisch 4 - Enthält |
caseSensitive | number | Gross-/Kleinschreibung beachten: 0 - nicht CaseSensitive 1 - CaseSensitive |
useCurrentQuery | boolean | true : Der Filter basiert auf dem aktuell bestehenden Filter. false : Es wird ein neuer Filtererstellt. |
Rückgabewert
boolean
SetFilterByGeo()
Aufrufsignatur
SetFilterByGeo(
geoFilterType,
filterOperation,
uncodedRecordAction,
multipleResultAction,
aliasName,
address,
distance): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10676
Setzt einen Filter anhand eines bestimmten geographischen Punktes.
Parameter
| Parameter | Type | Description |
|---|---|---|
geoFilterType | number | Gibt den Suchtyp an 1 Berechnung anhand der Luftlinie |
filterOperation | number | Gibt den Filtertyp an 1 Im Umkreis von 2 Nicht im Umkreis von |
uncodedRecordAction | number | Wie sollen für die Umkreissuche unkodierte Datensätze behandelt werden 1 Visuell anzeigen 2 Datensätze geokodieren 3 Filter ohne Geokodierung durchführen 4 Filtervorgang abbrechen |
multipleResultAction | number | Gibt die Aktion an wenn mehrere Ergebnisse zurückgeliefert werden. 1 Auswahldialog anzeigen, wenn mehrere Adressen für den Umkreispunkt gefunden wurden 2 Immer den ersten Datensatz verwenden, wenn mehrere Adressen für den Umkreispunkt gefunden wurden |
aliasName | string | Name der Feldliste der Adresse |
address | string | Adresse des Umkreispunkt |
distance | number | Umkreis in Kilometern, in dem gesucht werden soll |
Rückgabewert
boolean
Aufrufsignatur
SetFilterByGeo(
geoFilterType,
filterOperation,
uncodedRecordAction,
multipleResultAction,
aliasName,
address,
distance,
useCurrentQuery): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10700
Setzt einen Filter anhand eines bestimmten geographischen Punktes.
Parameter
| Parameter | Type | Description |
|---|---|---|
geoFilterType | number | Gibt den Suchtyp an 1 Berechnung anhand der Luftlinie |
filterOperation | number | Gibt den Filtertyp an 1 Im Umkreis von 2 Nicht im Umkreis von |
uncodedRecordAction | number | Wie sollen für die Umkreissuche unkodierte Datensätze behandelt werden 1 Visuell anzeigen 2 Datensätze geokodieren 3 Filter ohne Geokodierung durchführen 4 Filtervorgang abbrechen |
multipleResultAction | number | Gibt die Aktion an wenn mehrere Ergebnisse zurückgeliefert werden. 1 Auswahldialog anzeigen, wenn mehrere Adressen für den Umkreispunkt gefunden wurden 2 Immer den ersten Datensatz verwenden, wenn mehrere Adressen für den Umkreispunkt gefunden wurden |
aliasName | string | Name der Feldliste der Adresse |
address | string | Adresse des Umkreispunkt |
distance | number | Umkreis in Kilometern, in dem gesucht werden soll |
useCurrentQuery | boolean | true : Der Filter basiert auf dem aktuell bestehenden Filter. false : Es wird ein neuer Filter erstellt |
Rückgabewert
boolean
SetFilterByName()
Aufrufsignatur
SetFilterByName(name): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10722
Führt einen abgespeicherten Filterausdruck über den Namen aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Name des abgespeicherten Filters. Hinweis: Bitte beachten Sie, dass nicht die Bezeichnung des Filterausdrucks verwendet wird, sondern der "Name für Scripte". Alternativ kann der vollständige Pfad zu einer .crmshare-Datei, welche einen Filterausdruck beinhaltet, angegeben werden.Diese Datei kann über die Funktion „Filter teilen“ erstellt werden |
Rückgabewert
boolean
Aufrufsignatur
SetFilterByName(name, useCurrentQuery): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10733
Führt einen abgespeicherten Filterausdruck über den Namen aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Name des abgespeicherten Filters. Hinweis: Bitte beachten Sie, dass nicht die Bezeichnung des Filterausdrucks verwendet wird, sondern der "Name für Scripte". Alternativ kann der vollständige Pfad zu einer .crmshare-Datei, welche einen Filterausdruck beinhaltet, angegeben werden.Diese Datei kann über die Funktion „Filter teilen“ erstellt werden |
useCurrentQuery | boolean | true : Der Filter basiert auf dem aktuell bestehenden Filter. false : Es wird ein neuer Filter erstellt |
Rückgabewert
boolean
SetFilterByPrimaryKey()
SetFilterByPrimaryKey(primaryKeyContent): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10754
Setzt einen Filter basierend auf dem Primärschlüssel des RecordSets.
Diese Methode funktioniert nur, wenn ein Primärschlüssel vorhanden ist, der genau aus einem Feld besteht.
Parameter
| Parameter | Type | Description |
|---|---|---|
primaryKeyContent | string | Inhalt des Primärschlüsselfeldes. |
Rückgabewert
boolean
SetFilterByTagFile()
Aufrufsignatur
SetFilterByTagFile(tagFileName): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10764
Setzt und aktiviert einen manuellen Filter basierend auf einer Datei für eine manuelle Datensatzauswahl (.tag Datei).
Parameter
| Parameter | Type | Description |
|---|---|---|
tagFileName | string | Dateipfad der .tag-Datei. |
Rückgabewert
boolean
Aufrufsignatur
SetFilterByTagFile(tagFileName, useCurrentQuery): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10773
Setzt und aktiviert einen manuellen Filter basierend auf einer Datei für eine manuelle Datensatzauswahl (.tag Datei).
Parameter
| Parameter | Type | Description |
|---|---|---|
tagFileName | string | Dateipfad der .tag-Datei. |
useCurrentQuery | boolean | true : Der Filter basiert auf dem aktuell bestehenden Filter. false : Es wird ein neuer Filter erstellt |
Rückgabewert
boolean
Aufrufsignatur
SetFilterByTagFile(
tagFileName,
useCurrentQuery,
manFltCombineOption): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10788
Setzt und aktiviert einen manuellen Filter basierend auf einer Datei für eine manuelle Datensatzauswahl (.tag Datei).
Parameter
| Parameter | Type | Description |
|---|---|---|
tagFileName | string | Dateipfad der .tag-Datei. |
useCurrentQuery | boolean | true : Der Filter basiert auf dem aktuell bestehenden Filter. false : Es wird ein neuer Filter erstellt |
manFltCombineOption | number | Bestimmt wie die Datensatzauswahl mit ei nem bereits bestehenden manuellen Filter kombiniert werden soll. 1 = Logisches UND: Wenn ein Datensatz in mindestens einem Filter ausgeschlossen ist, wird er auch im Ergebnisfilter ausgeschlossen. 2 = Logisches ODER: Wenn ein Datensatz in mindestens einem Filter eingeschlossen ist, wird er auch im Ergebnisfilter eingeschlossen. 3 = Neuere: Bei Datensätzen, die sowohl in der bestehenden, als auch in der zu ladenden Datensatzauswahl vorkommen, wird die Datensatzauswahl aus dem zu ladenden Filter übernommen. 4 = Ältere: Bei Datensätzen, die sowohl in der bestehenden, als auch in der zu ladenden Datensatzauswahl vorkommen, wird die Datensatzauswahl aus dem bestehenden Filter übernommen. 5 = Überschreiben: Eine bestehende Datensatzauswahl wird mit der zu ladenden Datensatzauswahl überschrieben |
Rückgabewert
boolean
SetFilterDirectSQL()
Aufrufsignatur
SetFilterDirectSQL(sqlQuery): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10811
Erstellt einen Filter auf Basis des übergebenen freien Filterausdruckes.
Parameter
| Parameter | Type | Description |
|---|---|---|
sqlQuery | string | Freier SQL Filterausdruck. |
Rückgabewert
boolean
Aufrufsignatur
SetFilterDirectSQL(sqlQuery, useCurrentQuery): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10820
Erstellt einen Filter auf Basis des übergebenen freien Filterausdruckes.
Parameter
| Parameter | Type | Description |
|---|---|---|
sqlQuery | string | Freier SQL Filterausdruck. |
useCurrentQuery | boolean | true : Der Filter basiert auf dem aktuell bestehenden Filter. false : Es wird ein neuer Filter erstellt |
Rückgabewert
boolean
Synchronize()
Synchronize(format): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10841
Startet den Abgleich-Assistenten und führt das übergebene Benutzerformat aus. Es werden alle Einstellungen dieses Formates verwendet.
Parameter
| Parameter | Type | Description |
|---|---|---|
format | string | Name des Abgleichformates. Es kann sich dabei um einen kompletten Dateipfad auf eine .itp Format-Datei handeln, alternativ um den Formatnamen, so wie er im Assistenten dargestellt wird, dabei werden zuerst die benutzerspezifischen Formate durchsucht, anschließend die globalen Formate. Bitte beachten Sie die Großkleinschreibung. |
Rückgabewert
boolean
[hasInstance]()
static hasInstance: boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:10884
Symbol.hasInstance welches eine benutzerdefinierte Überprüfung der 'instanceof'-Operation für Objekte ermöglicht.
Parameter
| Parameter | Type |
|---|---|
value | any |
Rückgabewert
boolean