Zum Hauptinhalt springen
Version: 25.224.0917.2

ViewConfig

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6269

Ansicht

Extends​

Eigenschaften​

_instance​

protected _instance: ViewConfig;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:12

Abgeleitet von​

ExtendedCRMObjectBase._instance

className​

protected readonly className: string;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:16

Abgeleitet von​

ExtendedCRMObjectBase.className

addressInfosAsync​

Abfragesignatur​

get addressInfosAsync(): Promise<ListAddressInfos>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6290

Liefert ein Objekt vom Typ ListAddressInfos zurück

Rückgabewert​

Promise<ListAddressInfos>


dbTableNameAsync​

Abfragesignatur​

get dbTableNameAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6307

Liefert den Datenbank-Tabellennamen der Ansicht zurück

Rückgabewert​

Promise<string>


familyNameAsync​

Abfragesignatur​

get familyNameAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6328

Liefert den definierten Familiennamen der Ansicht zurück.

Rückgabewert​

Promise<string>


fldCountAsync​

Abfragesignatur​

get fldCountAsync(): Promise<number>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6338

Liefert die Anzahl der Felder zurück.

Rückgabewert​

Promise<number>


nameAsync​

Abfragesignatur​

get nameAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6392

Rückgabewert​

Promise<string>


primaryKeyFldNameAsync​

Abfragesignatur​

get primaryKeyFldNameAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6348

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

Rückgabewert​

Promise<string>


relationsAsync​

Abfragesignatur​

get relationsAsync(): Promise<ListRelations>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6358

Liefert ein Objekt vom Typ ListRelations zurück

Rückgabewert​

Promise<ListRelations>


sortdOrderCountAsync​

Abfragesignatur​

get sortdOrderCountAsync(): Promise<number>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6375

Liefert die Anzahl der definierten Sortierungen zurück.

Rückgabewert​

Promise<number>


supportsRecycleBinAsync​

Abfragesignatur​

get supportsRecycleBinAsync(): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6385

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

Rückgabewert​

Promise<boolean>

Konstruktoren​

Konstruktor​

new ViewConfig(
viewConfig,
combitCRMVersion,
disposeInstance): ViewConfig;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6273

Parameter​

ParameterTypeDefault value
viewConfigViewConfigundefined
combitCRMVersionnumber | CRMVersionundefined
disposeInstancebooleantrue

Rückgabewert​

ViewConfig

Überschreibt​

ExtendedCRMObjectBase<CoreCRM.ViewConfig>.constructor

Methoden​

[asyncDispose]()​

asyncDispose: Promise<void>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:93

Rückgabewert​

Promise<void>

Abgeleitet von​

ExtendedCRMObjectBase.[asyncDispose]

[dispose]()​

dispose: void;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:88

Rückgabewert​

void

Abgeleitet von​

ExtendedCRMObjectBase.[dispose]

codeDefinitionsAsync()​

codeDefinitionsAsync(fieldName): Promise<ListCodeDefinitions>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6415

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

Parameter​

ParameterTypeDescription
fieldNamestringPhysikalischer Feldname des gewünschten Feldes

Rückgabewert​

Promise<ListCodeDefinitions>


createRecordSetAsync()​

createRecordSetAsync(options?): Promise<RecordSet>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6434

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

Parameter​

ParameterTypeDescription
options?{ cursorMode?: CRMCursorMode; filter?: { text: string; type: RecordSetFilterType; }; sortOrder?: number; }Optionen
options.cursorMode?CRMCursorModeVoreinstellung:CRMCursorMode.SolutionDefault Ermöglicht die Spezifikation des Datenbankcursormodells, das für den zurückgegebenen RecordSet genutzt werden soll. CRMCursorMode.ForwardOnly ist das schnellste Model, hierbei gilt jedoch die Einschränkung das keine Verzögerung durch zum Beispiel Dialoge, MessageBoxen, Mailversand oder Druck bei der Iteration über das RecordSet stattfinden darf. Für diese Anwendungsfälle empfiehlt es sich CRMCursorMode.FullDynamic zu setzen
options.filter?{ text: string; type: RecordSetFilterType; }Filteroptionen
options.filter.text?stringFiltertext
options.filter.type?RecordSetFilterTypeFiltertyp
options.sortOrder?numberVoreinstellung: 0 (Keine Sortierung) Angabe einer Sortierung die ausgeführt werden soll.

Rückgabewert​

Promise<RecordSet>


dispose()​

dispose(): void;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:72

Rückgabewert​

void

Abgeleitet von​

ExtendedCRMObjectBase.dispose

disposeAsync()​

disposeAsync(): Promise<void>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:56

Rückgabewert​

Promise<void>

Abgeleitet von​

ExtendedCRMObjectBase.disposeAsync

dupeCheckCriteriaAsync()​

dupeCheckCriteriaAsync(): Promise<string[]>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6511

Liefert die Felder, welche für die Dublettenprüfung verwenden werden zurück.

Rückgabewert​

Promise<string[]>


fldAliasAsync()​

fldAliasAsync(index): Promise<string>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6523

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 ViewConfig.fldCount.

Rückgabewert​

Promise<string>


fldAliasByNameAsync()​

fldAliasByNameAsync(fieldName): Promise<string>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6535

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
fieldNamestringPhysikalischer Feldname des gewünschten Feldes

Rückgabewert​

Promise<string>


fldCaseSensitiveAsync()​

fldCaseSensitiveAsync(index): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6547

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 ViewConfig.fldCountAsync.

Rückgabewert​

Promise<boolean>


fldDecAsync()​

fldDecAsync(index): Promise<number>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6559

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 ViewConfig.fldCount.

Rückgabewert​

Promise<number>


fldExistsAsync()​

fldExistsAsync(fieldName): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6571

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

Parameter​

ParameterTypeDescription
fieldNamestringPhysikalischer Feldname des gewünschten Feldes

Rückgabewert​

Promise<boolean>


fldGDPRActiveAsync()​

fldGDPRActiveAsync(index): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6583

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 ViewConfig.fldCountAsync.

Rückgabewert​

Promise<boolean>


fldIndexAsync()​

fldIndexAsync(fieldName): Promise<number>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6595

Liefert den Index des Feldes zurück.

Parameter​

ParameterTypeDescription
fieldNamestringPhysikalischer Feldname des gewünschten Feldes

Rückgabewert​

Promise<number>


fldLenAsync()​

fldLenAsync(index): Promise<number>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6619

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 ViewConfig.fldCountAsync.

Rückgabewert​

Promise<number>


fldNameAsync()​

fldNameAsync(index): Promise<string>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6607

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 ViewConfig.fldCountAsync.

Rückgabewert​

Promise<string>


fldReadOnlyAsync()​

fldReadOnlyAsync(index): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6631

Ü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 ViewConfig.fldCountAsync.

Rückgabewert​

Promise<boolean>


fldTypeAsync()​

fldTypeAsync(index): Promise<FldType>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6643

Liefert den internen Typ des Feldes zurück.

Parameter​

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

Rückgabewert​

Promise<FldType>


fldTypePhysAsync()​

fldTypePhysAsync(index): Promise<FldTypePhys>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6655

Liefert den physikalischen Feldtyp zurück.

Parameter​

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

Rückgabewert​

Promise<FldTypePhys>


fldTypePhysNativeAsync()​

fldTypePhysNativeAsync(index): Promise<string>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6667

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 ViewConfig.fldCountAsync.

Rückgabewert​

Promise<string>


guardDisposed()​

protected guardDisposed(): void;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:29

Wift einen Error, wenn die Instanz bereits freigegeben wurde.

Rückgabewert​

void

Throws​

Error wenn die Instanz bereits freigegeben wurde.

Abgeleitet von​

ExtendedCRMObjectBase.guardDisposed

isDisposed()​

isDisposed(): boolean;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:51

Gibt an, ob die Instanz bereits freigegeben wurde.

Rückgabewert​

boolean

true wenn die Instanz bereits freigegeben wurde, andernfalls false.

Abgeleitet von​

ExtendedCRMObjectBase.isDisposed

sortOrderNameAsync()​

sortOrderNameAsync(index): Promise<string>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:6679

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

Parameter​

ParameterTypeDescription
indexnumberSortierungsnummer

Rückgabewert​

Promise<string>