Zum Hauptinhalt springen
Version: 25.134.1209.1

ViewConfig

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13715

Ansicht

Implementiert

  • AsyncDisposable
  • Disposable

Eigenschaften

AddressInfos

Abfragesignatur

get AddressInfos(): ListAddressInfos;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13729

Liefert ein Objekt vom Typ ListAddressInfos zurück

Rückgabewert

ListAddressInfos


Alias

Abfragesignatur

get Alias(): string;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13791

Liefert den Alias der definierten Ansicht zurück.

Rückgabewert

string


DBTableName

Abfragesignatur

get DBTableName(): string;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13746

Liefert den Datenbank-Tabellennamen der Ansicht zurück

Rückgabewert

string


DBTableType

Abfragesignatur

get DBTableType(): number;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13755

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

Rückgabewert

number


DupeCheckCriteria

Abfragesignatur

get DupeCheckCriteria(): string;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13835

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

Rückgabewert

string


FamilyName

Abfragesignatur

get FamilyName(): string;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13764

Liefert den definierten Familiennamen der Ansicht zurück.

Rückgabewert

string


FldCount

Abfragesignatur

get FldCount(): number;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13773

Liefert die Anzahl der Felder zurück.

Rückgabewert

number


IsDisposed

Abfragesignatur

get IsDisposed(): boolean;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13859

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean


Name

Abfragesignatur

get Name(): string;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13782

Liefert den Namen der definierten Ansicht zurück.

Rückgabewert

string


PrimaryKeyFldName

Abfragesignatur

get PrimaryKeyFldName(): string;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13800

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

Rückgabewert

string


Relations

Abfragesignatur

get Relations(): ListRelations;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13809

Liefert ein Objekt vom Typ ListRelations zurück

Rückgabewert

ListRelations


RowIDFldName

Abfragesignatur

get RowIDFldName(): string;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13853

Liefert die echte RowID-Spalte zurück.

Rückgabewert

string


SortOrderCount

Abfragesignatur

get SortOrderCount(): number;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13826

Liefert die Anzahl der definierten Sortierungen zurück.

Rückgabewert

number


SupportsRecycleBin

Abfragesignatur

get SupportsRecycleBin(): boolean;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13844

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

Rückgabewert

boolean

Methoden

[asyncDispose]()

asyncDispose: Promise<void>;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14204

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

[dispose]()

dispose: void;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14215

Standardimplementierung des Dispose Symbols

Rückgabewert

void

Implementierung von

Disposable.[dispose]

CodeDefinitions()

CodeDefinitions(fieldName): ListCodeDefinitions;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13883

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

Parameter

ParameterTypeDescription
fieldNamestringPhysikalischer Feldname des gewünschten Feldes

Rückgabewert

ListCodeDefinitions


CreateRecordSet()

Aufrufsignatur

CreateRecordSet(): RecordSet;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13902

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

Aufrufsignatur

CreateRecordSet(initialFilter): RecordSet;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13916

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

Parameter
ParameterTypeDescription
initialFilterstringErmö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

Aufrufsignatur

CreateRecordSet(initialFilter, cursorMode): RecordSet;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13938

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

Parameter
ParameterTypeDescription
initialFilterstringErmö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.
cursorModenumberOptional. 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

Aufrufsignatur

CreateRecordSet(initialFilter, cursorMode): RecordSet;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:13960

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

Parameter
ParameterTypeDescription
initialFilterstringErmö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.
cursorModestringOptional. 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


Dispose()

Dispose(): void;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14209

Standardimplementierung des Dispose

Rückgabewert

void


DisposeAsync()

DisposeAsync(): Promise<void>;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14198

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>


FldAlias()

FldAlias(index): string;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14003

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

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

string


FldAliasByName()

FldAliasByName(name): string;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14013

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

Parameter

ParameterTypeDescription
namestringPhysikalischer Feldname des gewünschten Feldes.

Rückgabewert

string


FldCaseSensitive()

FldCaseSensitive(index): boolean;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14023

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

Parameter

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

boolean


FldDec()

FldDec(index): number;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14033

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

Parameter

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

number


FldExists()

FldExists(name): boolean;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14043

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

Parameter

ParameterTypeDescription
namestringÜbergabe des zu überprüfenden Feldnamens.

Rückgabewert

boolean


FldGDPRActive()

FldGDPRActive(index): boolean;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14053

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

Parameter

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

boolean


FldIndex()

FldIndex(fieldName): number;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14063

Liefert den Index des Feldes zurück.

Parameter

ParameterTypeDescription
fieldNamestringPhysikalischer Name des Feldes.

Rückgabewert

number


FldLen()

FldLen(index): number;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14083

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

Parameter

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

number


FldName()

FldName(index): string;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14073

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

Parameter

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

string


FldReadOnly()

FldReadOnly(index): boolean;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14093

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

Parameter

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

boolean


FldType()

FldType(index): number;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14144

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

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

number


FldTypePhys()

FldTypePhys(index): number;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14171

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

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

number


FldTypePhysNative()

FldTypePhysNative(index): string;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14181

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

Parameter

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert

string


SortOrderName()

SortOrderName(index): string;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14192

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

Parameter

ParameterTypeDescription
indexnumberÜbergabe der Sortierung 0= {ohne Sortierung}

Rückgabewert

string


[hasInstance]()

static hasInstance: boolean;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:14223

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

Parameter

ParameterType
valueany

Rückgabewert

boolean