RecordSet

Datensätze

Implementiert

• Iterable<Record>
• AsyncDisposable
• Disposable

Eigenschaften

CurrentRecord

get CurrentRecord(): Record

Liefert den aktuellen Datensatz als Objekt vom Typ Record zurück.

Rückgabewert

Record

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:9837

---

CurrentRecordBuffered

get CurrentRecordBuffered(): Record

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

Record

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:9854

---

CurrentRecordSynchronized

get CurrentRecordSynchronized(): Record

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

Record

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:9872

---

HasMultipleRecords

get HasMultipleRecords(): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:9791

---

IsDisposed

get IsDisposed(): boolean

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:9886

---

RecCount

get RecCount(): number

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:9801

---

SortOrder

get SortOrder(): number

Gibt die aktuell gesetzte Sortierung zurück oder setzt diese
0 = Ohne Sortierung

set SortOrder(val): void

Gibt die aktuell gesetzte Sortierung zurück oder setzt diese
0 = Ohne Sortierung

Parameter

Parameter	Type
val	number

Rückgabewert

number

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:9811

---

ViewName

get ViewName(): string

Gibt den Namen des übergeordneten View Objektes zurück.

Rückgabewert

string

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:9828

Methoden

CalcAggregationValues()

CalcAggregationValues(aggregationColumnsExpression): DataItem

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

DataItem

Example

Beispielaufruf

CalcAggregationValues("count(1) as Counter, min(\"Birthday\") as Oldest, max(\"Birthday\") as Youngest");

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:9918

---

CreateCopy()

CreateCopy()

CreateCopy(): RecordSet

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:9935

CreateCopy(cursorMode)

CreateCopy(cursorMode): RecordSet

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:9948

CreateCopy(cursorMode)

CreateCopy(cursorMode): RecordSet

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	string	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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:9961

---

DeleteAllRecords()

DeleteAllRecords(): boolean

Löscht alle Datensätze im Filter des aktuellen RecordSet -Objektes

Rückgabewert

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:9992

---

DialogEditFormula()

DialogEditFormula(title, formula)

DialogEditFormula(title, formula): string

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.

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10007

DialogEditFormula(title, formula, useRealData)

DialogEditFormula(
   title, 
   formula, 
   useRealData): string

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.

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10021

DialogEditFormula(title, formula, useRealData, allowedResultType)

DialogEditFormula(
   title, 
   formula, 
   useRealData, 
   allowedResultType): string

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.

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10040

DialogEditFormula(title, formula, useRealData, allowedResultType, parentHandle)

DialogEditFormula(
   title, 
   formula, 
   useRealData, 
   allowedResultType, 
   parentHandle): string

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.

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10060

---

DialogFilterAssistant()

DialogFilterAssistant(windowTitle, filterStatementFile)

DialogFilterAssistant(windowTitle, filterStatementFile): string

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10091

DialogFilterAssistant(windowTitle, filterStatementFile, disableAskString)

DialogFilterAssistant(
   windowTitle, 
   filterStatementFile, 
   disableAskString): string

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10104

DialogFilterAssistant(windowTitle, filterStatementFile, disableAskString, parentHandle)

DialogFilterAssistant(
   windowTitle, 
   filterStatementFile, 
   disableAskString, 
   parentHandle): string

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10118

---

DialogFilterGeneral()

DialogFilterGeneral(windowTitle, filterStatementFile)

DialogFilterGeneral(windowTitle, filterStatementFile): string

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10146

DialogFilterGeneral(windowTitle, filterStatementFile, disableAskString)

DialogFilterGeneral(
   windowTitle, 
   filterStatementFile, 
   disableAskString): string

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10159

DialogFilterGeneral(windowTitle, filterStatementFile, disableAskString, parentHandle)

DialogFilterGeneral(
   windowTitle, 
   filterStatementFile, 
   disableAskString, 
   parentHandle): string

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10173

---

DialogFilterSQLQuery()

DialogFilterSQLQuery(windowTitle, filterStatementFile)

DialogFilterSQLQuery(windowTitle, filterStatementFile): string

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10201

DialogFilterSQLQuery(windowTitle, filterStatementFile, disableAskString)

DialogFilterSQLQuery(
   windowTitle, 
   filterStatementFile, 
   disableAskString): string

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10214

DialogFilterSQLQuery(windowTitle, filterStatementFile, disableAskString, parentHandle)

DialogFilterSQLQuery(
   windowTitle, 
   filterStatementFile, 
   disableAskString, 
   parentHandle): string

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10228

---

DialogSelectRecord()

DialogSelectRecord(windowTitle)

DialogSelectRecord(windowTitle): Record

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

Record

Rückgabe: Record wenn ein Datensatz ausgewählt wurde, andernfalls null

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10254

DialogSelectRecord(windowTitle, allowUserDefinedSortOrder)

DialogSelectRecord(windowTitle, allowUserDefinedSortOrder): Record

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

Record

Rückgabe: Record wenn ein Datensatz ausgewählt wurde, andernfalls null

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10266

DialogSelectRecord(windowTitle, allowUserDefinedSortOrder, parentHandle)

DialogSelectRecord(
   windowTitle, 
   allowUserDefinedSortOrder, 
   parentHandle): Record

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

Record

Rückgabe: Record wenn ein Datensatz ausgewählt wurde, andernfalls null

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10279

---

DialogSelectRecordMultiple()

DialogSelectRecordMultiple(windowTitle)

DialogSelectRecordMultiple(windowTitle): RecordSet

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10330

DialogSelectRecordMultiple(windowTitle, allowUserDefinedSortOrder)

DialogSelectRecordMultiple(windowTitle, allowUserDefinedSortOrder): RecordSet

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10343

DialogSelectRecordMultiple(windowTitle, allowUserDefinedSortOrder, parentHandle)

DialogSelectRecordMultiple(
   windowTitle, 
   allowUserDefinedSortOrder, 
   parentHandle): RecordSet

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10357

---

Dispose()

Dispose(): void

Standardimplementierung des Dispose

Rückgabewert

void

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11359

---

DisposeAsync()

DisposeAsync(): Promise<void>

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11348

---

ExecuteInstantReportByName()

ExecuteInstantReportByName(name): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10404

---

Export()

Export(format): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10415

---

FindRecordByDupeCheckCriteria()

FindRecordByDupeCheckCriteria(recordId, fieldContent1)

FindRecordByDupeCheckCriteria(recordId, fieldContent1): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10428

FindRecordByDupeCheckCriteria(recordId, fieldContent1, fieldContent2)

FindRecordByDupeCheckCriteria(
   recordId, 
   fieldContent1, 
   fieldContent2): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10439

FindRecordByDupeCheckCriteria(recordId, fieldContent1, fieldContent2, fieldContent3)

FindRecordByDupeCheckCriteria(
   recordId, 
   fieldContent1, 
   fieldContent2, 
   fieldContent3): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10451

FindRecordByDupeCheckCriteria(recordId, fieldContent1, fieldContent2, fieldContent3, fieldContent4)

FindRecordByDupeCheckCriteria(
   recordId, 
   fieldContent1, 
   fieldContent2, 
   fieldContent3, 
   fieldContent4): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10464

FindRecordByDupeCheckCriteria(recordId, fieldContent1, fieldContent2, fieldContent3, fieldContent4, fieldContent5)

FindRecordByDupeCheckCriteria(
   recordId, 
   fieldContent1, 
   fieldContent2, 
   fieldContent3, 
   fieldContent4, 
   fieldContent5): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10478

FindRecordByDupeCheckCriteria(recordId, fieldContent1, fieldContent2, fieldContent3, fieldContent4, fieldContent5, fieldContent6)

FindRecordByDupeCheckCriteria(
   recordId, 
   fieldContent1, 
   fieldContent2, 
   fieldContent3, 
   fieldContent4, 
   fieldContent5, 
   fieldContent6): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10493

FindRecordByDupeCheckCriteria(recordId, fieldContent1, fieldContent2, fieldContent3, fieldContent4, fieldContent5, fieldContent6, fieldContent7)

FindRecordByDupeCheckCriteria(
   recordId, 
   fieldContent1, 
   fieldContent2, 
   fieldContent3, 
   fieldContent4, 
   fieldContent5, 
   fieldContent6, 
   fieldContent7): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10509

FindRecordByDupeCheckCriteria(recordId, fieldContent1, fieldContent2, fieldContent3, fieldContent4, fieldContent5, fieldContent6, fieldContent7, fieldContent8)

FindRecordByDupeCheckCriteria(
   recordId, 
   fieldContent1, 
   fieldContent2, 
   fieldContent3, 
   fieldContent4, 
   fieldContent5, 
   fieldContent6, 
   fieldContent7, 
   fieldContent8): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10526

FindRecordByDupeCheckCriteria(recordId, fieldContent1, fieldContent2, fieldContent3, fieldContent4, fieldContent5, fieldContent6, fieldContent7, fieldContent8, useCurrentQuery)

FindRecordByDupeCheckCriteria(
   recordId, 
   fieldContent1, 
   fieldContent2, 
   fieldContent3, 
   fieldContent4, 
   fieldContent5, 
   fieldContent6, 
   fieldContent7, 
   fieldContent8, 
   useCurrentQuery): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10544

---

FindRecordByEmail()

FindRecordByEmail(email, reduceMail)

FindRecordByEmail(email, reduceMail): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10588

FindRecordByEmail(email, reduceMail, useCurrentQuery)

FindRecordByEmail(
   email, 
   reduceMail, 
   useCurrentQuery): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10599

---

FindRecordByPhoneNumber()

FindRecordByPhoneNumber(phoneNo, reducePhoneNo)

FindRecordByPhoneNumber(phoneNo, reducePhoneNo): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10622

FindRecordByPhoneNumber(phoneNo, reducePhoneNo, useCurrentQuery)

FindRecordByPhoneNumber(
   phoneNo, 
   reducePhoneNo, 
   useCurrentQuery): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10633

---

Import()

Import(format): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10654

---

MoveFirst()

MoveFirst(): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10665

---

MoveLast()

MoveLast(): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10676

---

MoveNext()

MoveNext(): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10687

---

MovePrevious()

MovePrevious(): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10698

---

NewRecord()

NewRecord(): Record

Erzeugt einen neuen Datensatz und liefert diesen als Objekt vom Typ Record zurück.

Rückgabewert

Record

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10707

---

PrintCard()

PrintCard(media, fileName, silent, range, outputFileName)

PrintCard(
   media, 
   fileName, 
   silent, 
   range, 
   outputFileName): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10730

PrintCard(media, fileName, silent, range, outputFileName, useModalPreviewWindow)

PrintCard(
   media, 
   fileName, 
   silent, 
   range, 
   outputFileName, 
   useModalPreviewWindow): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10743

---

PrintLabel()

PrintLabel(media, fileName, silent, range, outputFileName)

PrintLabel(
   media, 
   fileName, 
   silent, 
   range, 
   outputFileName): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10768

PrintLabel(media, fileName, silent, range, outputFileName, useModalPreviewWindow)

PrintLabel(
   media, 
   fileName, 
   silent, 
   range, 
   outputFileName, 
   useModalPreviewWindow): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10781

---

PrintReport()

PrintReport(media, fileName, silent, range, outputFileName)

PrintReport(
   media, 
   fileName, 
   silent, 
   range, 
   outputFileName): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10806

PrintReport(media, fileName, silent, range, outputFileName, useModalPreviewWindow)

PrintReport(
   media, 
   fileName, 
   silent, 
   range, 
   outputFileName, 
   useModalPreviewWindow): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10819

---

RecCountWithoutGeoCoordinates()

RecCountWithoutGeoCoordinates(aliasName): number

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10839

---

RelationalAppend()

RelationalAppend(name): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10850

---

RelationalAppendDirect()

RelationalAppendDirect(relation, parameter): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10862

---

SendBulkMail()

SendBulkMail(templatePath, errorTagFilePath)

SendBulkMail(templatePath, errorTagFilePath): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10880

SendBulkMail(templatePath, errorTagFilePath, silent)

SendBulkMail(
   templatePath, 
   errorTagFilePath, 
   silent): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10894

SendBulkMail(templatePath, errorTagFilePath, silent, tagFileRecordsSuccessfullySent)

SendBulkMail(
   templatePath, 
   errorTagFilePath, 
   silent, 
   tagFileRecordsSuccessfullySent): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10910

SendBulkMail(templatePath, errorTagFilePath, silent, tagFileRecordsSuccessfullySent, attachmentFiles)

SendBulkMail(
   templatePath, 
   errorTagFilePath, 
   silent, 
   tagFileRecordsSuccessfullySent, 
   attachmentFiles): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10928

SendBulkMail(templatePath, errorTagFilePath, silent, tagFileRecordsSuccessfullySent, attachmentFiles, showDialog)

SendBulkMail(
   templatePath, 
   errorTagFilePath, 
   silent, 
   tagFileRecordsSuccessfullySent, 
   attachmentFiles, 
   showDialog): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10949

---

SendMAPIMail()

SendMAPIMail(
   address, 
   subject, 
   contents, 
   files, 
   showDialog): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11017

---

SendMailDialog()

SendMailDialog(address, subject, contents)

SendMailDialog(
   address, 
   subject, 
   contents): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10980

SendMailDialog(address, subject, contents, files)

SendMailDialog(
   address, 
   subject, 
   contents, 
   files): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:10991

---

SetFilter()

SetFilter(filterContents)

SetFilter(filterContents): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11028

SetFilter(filterContents, useCurrentQuery)

SetFilter(filterContents, useCurrentQuery): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11038

---

SetFilterByCurrentSortOrder()

SetFilterByCurrentSortOrder(filterContents, searchType, caseSensitive)

SetFilterByCurrentSortOrder(
   filterContents, 
   searchType, 
   caseSensitive): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11066

SetFilterByCurrentSortOrder(filterContents, searchType, caseSensitive, useCurrentQuery)

SetFilterByCurrentSortOrder(
   filterContents, 
   searchType, 
   caseSensitive, 
   useCurrentQuery): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11083

---

SetFilterByFieldName()

SetFilterByFieldName(fieldName, contents, searchType, caseSensitive)

SetFilterByFieldName(
   fieldName, 
   contents, 
   searchType, 
   caseSensitive): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11112

SetFilterByFieldName(fieldName, contents, searchType, caseSensitive, useCurrentQuery)

SetFilterByFieldName(
   fieldName, 
   contents, 
   searchType, 
   caseSensitive, 
   useCurrentQuery): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11130

---

SetFilterByGeo()

SetFilterByGeo(geoFilterType, filterOperation, uncodedRecordAction, multipleResultAction, aliasName, address, distance)

SetFilterByGeo(
   geoFilterType, 
   filterOperation, 
   uncodedRecordAction, 
   multipleResultAction, 
   aliasName, 
   address, 
   distance): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11165

SetFilterByGeo(geoFilterType, filterOperation, uncodedRecordAction, multipleResultAction, aliasName, address, distance, useCurrentQuery)

SetFilterByGeo(
   geoFilterType, 
   filterOperation, 
   uncodedRecordAction, 
   multipleResultAction, 
   aliasName, 
   address, 
   distance, 
   useCurrentQuery): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11189

---

SetFilterByName()

SetFilterByName(name)

SetFilterByName(name): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11211

SetFilterByName(name, useCurrentQuery)

SetFilterByName(name, useCurrentQuery): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11222

---

SetFilterByPrimaryKey()

SetFilterByPrimaryKey(primaryKeyContent): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11243

---

SetFilterByTagFile()

SetFilterByTagFile(tagFileName)

SetFilterByTagFile(tagFileName): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11253

SetFilterByTagFile(tagFileName, useCurrentQuery)

SetFilterByTagFile(tagFileName, useCurrentQuery): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11262

SetFilterByTagFile(tagFileName, useCurrentQuery, manFltCombineOption)

SetFilterByTagFile(
   tagFileName, 
   useCurrentQuery, 
   manFltCombineOption): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11277

---

SetFilterDirectSQL()

SetFilterDirectSQL(sqlQuery)

SetFilterDirectSQL(sqlQuery): boolean

Erstellt einen Filter auf Basis des übergebenen freien Filterausdruckes.

Parameter

Parameter	Type	Description
sqlQuery	string	Freier SQL Filterausdruck.

Rückgabewert

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11300

SetFilterDirectSQL(sqlQuery, useCurrentQuery)

SetFilterDirectSQL(sqlQuery, useCurrentQuery): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11309

---

Synchronize()

Synchronize(format): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11330

---

[asyncDispose]()

asyncDispose: Promise<void>

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11354

---

[dispose]()

dispose: void

Standardimplementierung des Dispose Symbols

Rückgabewert

void

Implementierung von

Disposable.[dispose]

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11365

---

[iterator]()

iterator: IterableIterator<Record>

Standardimplementierung des Iterators

Rückgabewert

IterableIterator<Record>

Implementierung von

Iterable.[iterator]

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11336

---

[hasInstance]()

static hasInstance: boolean

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

Parameter

Parameter	Type
value	any

Rückgabewert

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:11373