ViewConfig

Ansicht

Implementiert

• AsyncDisposable
• Disposable

Eigenschaften

AddressInfos

get AddressInfos(): ListAddressInfos

Liefert ein Objekt vom Typ ListAddressInfos zurück

Rückgabewert

ListAddressInfos

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13729

---

Alias

get Alias(): string

Liefert den Alias der definierten Ansicht zurück.

Rückgabewert

string

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13791

---

DBTableName

get DBTableName(): string

Liefert den Datenbank-Tabellennamen der Ansicht zurück

Rückgabewert

string

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13746

---

DBTableType

get DBTableType(): number

Liefert den Typ der Datenquelle die als Basis der Ansicht verwendet wird zurück.

Rückgabewert

number

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13755

---

DupeCheckCriteria

get DupeCheckCriteria(): string

Liefert die Felder, welche für die Dublettenprüfung verwenden werden, als TAB-separierte Liste zurück.

Rückgabewert

string

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13835

---

FamilyName

get FamilyName(): string

Liefert den definierten Familiennamen der Ansicht zurück.

Rückgabewert

string

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13764

---

FldCount

get FldCount(): number

Liefert die Anzahl der Felder zurück.

Rückgabewert

number

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13773

---

IsDisposed

get IsDisposed(): boolean

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13859

---

Name

get Name(): string

Liefert den Namen der definierten Ansicht zurück.

Rückgabewert

string

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13782

---

PrimaryKeyFldName

get PrimaryKeyFldName(): string

Liefert den Namen des Primärschlüsselfeldes, sofern der Primärschlüssel aus genau einem Feld besteht.

Rückgabewert

string

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13800

---

Relations

get Relations(): ListRelations

Liefert ein Objekt vom Typ ListRelations zurück

Rückgabewert

ListRelations

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13809

---

RowIDFldName

get RowIDFldName(): string

Liefert die echte RowID-Spalte zurück.

Rückgabewert

string

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13853

---

SortOrderCount

get SortOrderCount(): number

Liefert die Anzahl der definierten Sortierungen zurück.

Rückgabewert

number

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13826

---

SupportsRecycleBin

get SupportsRecycleBin(): boolean

Liefert zurück, ob die Ansicht den Papierkorb unterstützt.

Rückgabewert

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13844

Methoden

CodeDefinitions()

CodeDefinitions(fieldName): ListCodeDefinitions

Liefert für das übergebene Feld eine Collection ListCodeDefinitions der dafür hinterlegten Codedefinitionen.

Parameter

Parameter	Type	Description
fieldName	string	Physikalischer Feldname des gewünschten Feldes

Rückgabewert

ListCodeDefinitions

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13883

---

CreateRecordSet()

CreateRecordSet()

CreateRecordSet(): RecordSet

Erzeugt ein Objekt vom Typ RecordSet . Es wird daher keine Ansicht visuell geöffnet.

Rückgabewert

RecordSet

Rückgabe: ViewConfig wenn der Zugriff möglich ist, andernfalls null

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13902

CreateRecordSet(initialFilter)

CreateRecordSet(initialFilter): RecordSet

Erzeugt ein Objekt vom Typ RecordSet . Es wird daher keine Ansicht visuell geöffnet.

Parameter

Parameter	Type	Description
initialFilter	string	Ermöglicht die Übergabe einer Sortierung mittels "SetSortOrder:n" (n = Nummer der gewünschten Sortierung, 0 = unsortiert, -n = invertierte Sortierung). Verhindert weitere Datenbankabfragen, die durch das Setzen der SortOrder-Eigenschaft ausgeführt werden müssten und erhöht so die Performance. Dieses Schlüsselwort muss als erstes angegeben werden, wenn es benutzt werden soll. Nachfolgende SetFilter*-Schlüsselworte können mit Leerzeichen oder Komma angehängt werden. Ein Filter kann mit Leerzeichen oder Komma getrennt dahinter aufgeführt werden. Der Filterausdruck muss dabei mit einer der folgenden Zeichenfolgen beginnen: "SetFilter: <Filterausdruck aus dem Filter Allgemein-Dialog>" "SetFilterByName:<Name für Scripte/Workflows des abgespeicherten Filters oder Pfad zu einer .crmshare-Datei mit enthaltenem Filterausdruck>" "SetFilterDirectSQL:<Freier SQL Filterausdruck>" "SetFilterByPrimaryKey:<Inhalt des Primärschlüsselfeldes>" Ersetzen Sie den Teil <...> durch den entsprechenden Wert.

Rückgabewert

RecordSet

Rückgabe: ViewConfig wenn der Zugriff möglich ist, andernfalls null

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13916

CreateRecordSet(initialFilter, cursorMode)

CreateRecordSet(initialFilter, cursorMode): RecordSet

Erzeugt ein Objekt vom Typ RecordSet . Es wird daher keine Ansicht visuell geöffnet.

Parameter

Parameter	Type	Description
initialFilter	string	Ermöglicht die Übergabe einer Sortierung mittels "SetSortOrder:n" (n = Nummer der gewünschten Sortierung, 0 = unsortiert, -n = invertierte Sortierung). Verhindert weitere Datenbankabfragen, die durch das Setzen der SortOrder-Eigenschaft ausgeführt werden müssten und erhöht so die Performance. Dieses Schlüsselwort muss als erstes angegeben werden, wenn es benutzt werden soll. Nachfolgende SetFilter*-Schlüsselworte können mit Leerzeichen oder Komma angehängt werden. Ein Filter kann mit Leerzeichen oder Komma getrennt dahinter aufgeführt werden. Der Filterausdruck muss dabei mit einer der folgenden Zeichenfolgen beginnen: "SetFilter: <Filterausdruck aus dem Filter Allgemein-Dialog>" "SetFilterByName:<Name für Scripte/Workflows des abgespeicherten Filters oder Pfad zu einer .crmshare-Datei mit enthaltenem Filterausdruck>" "SetFilterDirectSQL:<Freier SQL Filterausdruck>" "SetFilterByPrimaryKey:<Inhalt des Primärschlüsselfeldes>" Ersetzen Sie den Teil <...> durch den entsprechenden Wert.
cursorMode	number	Optional. Ermöglicht die Spezifikation des Datenbankcursormodells, das für den zurückgegebenen RecordSet genutzt werden soll. Werte: 0 (Standardwert): 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

Rückgabe: ViewConfig wenn der Zugriff möglich ist, andernfalls null

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13938

CreateRecordSet(initialFilter, cursorMode)

CreateRecordSet(initialFilter, cursorMode): RecordSet

Erzeugt ein Objekt vom Typ RecordSet . Es wird daher keine Ansicht visuell geöffnet.

Parameter

Parameter	Type	Description
initialFilter	string	Ermöglicht die Übergabe einer Sortierung mittels "SetSortOrder:n" (n = Nummer der gewünschten Sortierung, 0 = unsortiert, -n = invertierte Sortierung). Verhindert weitere Datenbankabfragen, die durch das Setzen der SortOrder-Eigenschaft ausgeführt werden müssten und erhöht so die Performance. Dieses Schlüsselwort muss als erstes angegeben werden, wenn es benutzt werden soll. Nachfolgende SetFilter*-Schlüsselworte können mit Leerzeichen oder Komma angehängt werden. Ein Filter kann mit Leerzeichen oder Komma getrennt dahinter aufgeführt werden. Der Filterausdruck muss dabei mit einer der folgenden Zeichenfolgen beginnen: "SetFilter: <Filterausdruck aus dem Filter Allgemein-Dialog>" "SetFilterByName:<Name für Scripte/Workflows des abgespeicherten Filters oder Pfad zu einer .crmshare-Datei mit enthaltenem Filterausdruck>" "SetFilterDirectSQL:<Freier SQL Filterausdruck>" "SetFilterByPrimaryKey:<Inhalt des Primärschlüsselfeldes>" Ersetzen Sie den Teil <...> durch den entsprechenden Wert.
cursorMode	string	Optional. Ermöglicht die Spezifikation des Datenbankcursormodells, das für den zurückgegebenen RecordSet genutzt werden soll. Werte: 0 (Standardwert): 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

Rückgabe: ViewConfig wenn der Zugriff möglich ist, andernfalls null

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13960

---

Dispose()

Dispose(): void

Standardimplementierung des Dispose

Rückgabewert

void

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:14209

---

DisposeAsync()

DisposeAsync(): Promise<void>

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:14198

---

FldAlias()

FldAlias(index): string

Liefert den Aliasnamen des Feldes zurück, das als fortlaufende Nummer übergeben wurde. Ist der Aliasname leer, wird der entsprechende physikalische Feldname zurückgegeben.

Parameter

Parameter	Type	Description
index	number	Die fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

string

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:14003

---

FldAliasByName()

FldAliasByName(name): string

Liefert den Aliasnamen des Feldes zurück, dessen physikalischer Feldname übergeben wurde. Ist der Aliasname leer, wird der entsprechende physikalische Feldname zurückgegeben.

Parameter

Parameter	Type	Description
name	string	Physikalischer Feldname des gewünschten Feldes.

Rückgabewert

string

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:14013

---

FldCaseSensitive()

FldCaseSensitive(index): boolean

Überprüft, ob bei einem übergebenen Feld die Groß- und Kleinschreibung beachtet wird.

Parameter

Parameter	Type	Description
index	number	Die fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:14023

---

FldDec()

FldDec(index): number

Liefert die Anzahl der Dezimalstellen des Feldes zurück, das als fortlaufende Nummer übergeben wurde.

Parameter

Parameter	Type	Description
index	number	Die fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

number

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:14033

---

FldExists()

FldExists(name): boolean

Überprüft, ob ein Feld in der Ansicht existiert.

Parameter

Parameter	Type	Description
name	string	Übergabe des zu überprüfenden Feldnamens.

Rückgabewert

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:14043

---

FldGDPRActive()

FldGDPRActive(index): boolean

Liefert den Datenschutz-Status des Feldes zurück, das als fortlaufende Nummer übergeben wurde.

Parameter

Parameter	Type	Description
index	number	Die fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:14053

---

FldIndex()

FldIndex(fieldName): number

Liefert den Index des Feldes zurück.

Parameter

Parameter	Type	Description
fieldName	string	Physikalischer Name des Feldes.

Rückgabewert

number

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:14063

---

FldLen()

FldLen(index): number

Liefert die Zeichenlänge des Feldes zurück, das als fortlaufende Nummer übergeben wurde.

Parameter

Parameter	Type	Description
index	number	Die fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

number

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:14083

---

FldName()

FldName(index): string

Liefert den Namen des Feldes zurück, das als fortlaufende Nummer übergeben wurde.

Parameter

Parameter	Type	Description
index	number	Die fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

string

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:14073

---

FldReadOnly()

FldReadOnly(index): boolean

Überprüft, ob ein Feld gesetzt (verändert) werden darf.

Parameter

Parameter	Type	Description
index	number	Die fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:14093

---

FldType()

FldType(index): number

Liefert den internen Typ des Feldes zurück.
0 - Unbekannt
1 - Logisch
2 - Zeichen
3 - Notizen
4 - Numerisch
5 - Datum mit Zeit
6 - Datum
7 - Zeit
8 - Numerisch binary
9 - Telefon
10 - Mobiltelefon
11 - Internet
12 - E-Mail
13 - Code
14 - Global eindeutige ID
15 - Postleitzahl
16 - Straße
17 - Ort
18 - Land
19 - Bundesland
20 - Bankleitzahl
21 - Datensatz-ID
22 - Grafikverweis
23 - Dateiverweis
24 - Automatische Nr.
27 - Telefax
28 - Postfach Postleitzahl
29 - Postfach
30 - Erfassungsbenutzer
31 - Erfassungsdatum
32 - Änderungsbenutzer
33 - Änderungsdatum
34 - Autosequenz
35 - Symbol
37 - Eingebettete Datei
38 - Eingebettete Grafik
39 - DMS Dokument
40 - intern
41 - Belegverweis (FM) – Format: fmw://<Mandantname>/<Belegtyp>/<BelegNummer>"
43 - Notizen formatiert
44 - Papierkorb-ID

Parameter

Parameter	Type	Description
index	number	Die fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

number

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:14144

---

FldTypePhys()

FldTypePhys(index): number

Liefert den physikalischen Feldtyp zurück.
0 - Unbekannt
1 - Logisch
2 - Ganzzahl kurz
3 - Ganzzahl lang
4 - Rationale Zahl
5 - Numerisch
6 - Datum mit Zeit
7 - Zeichen
8 - Bytes
9 - Binär lang
10 - Zeichen lang
11 - BLOB
12 - CLOB
15 - Ganzzahl kurz(ohne Vorzeichen)
16 - Ganzzahl lang(ohne Vorzeichen)
18 - Ganzzahl 64-Bit
19 - Ganzzahl 64-Bit(ohne Vorzeichen)

Parameter

Parameter	Type	Description
index	number	Die fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

number

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:14171

---

FldTypePhysNative()

FldTypePhysNative(index): string

Liefert den physikalischen Namen des Feldtyps des übergebenen Feldes zurück.

Parameter

Parameter	Type	Description
index	number	Die fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

string

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:14181

---

SortOrderName()

SortOrderName(index): string

Liefert anhand der übergebenen Sortierung den Namen der Sortierung zurück.

Parameter

Parameter	Type	Description
index	number	Übergabe der Sortierung 0= {ohne Sortierung}

Rückgabewert

string

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:14192

---

[asyncDispose]()

asyncDispose: Promise<void>

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:14204

---

[dispose]()

dispose: void

Standardimplementierung des Dispose Symbols

Rückgabewert

void

Implementierung von

Disposable.[dispose]

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:14215

---

[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:14223