Container

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

Extends

• ExtendedCRMObjectBase<Container>

Eigenschaften

_instance

protected _instance: Container;

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

---

currentRecordAsync

Abfragesignatur

get currentRecordAsync(): Promise<Record>;

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

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

Rückgabewert

Promise<Record>

Konstruktoren

Konstruktor

new Container(
   container, 
   combitCRMVersion, 
   disposeInstance): Container;

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

Parameter

Parameter	Type	Default value
container	Container	undefined
combitCRMVersion	number | CRMVersion	undefined
disposeInstance	boolean	true

Rückgabewert

Container

Überschreibt

ExtendedCRMObjectBase<CoreCRM.Container>.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]

---

currentRecordSetCopyAsync()

currentRecordSetCopyAsync(cursorMode): Promise<RecordSet>;

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

Liefert das aktuelle RecordSet für einen Container zurück. Hierbei werden etwaig angewandte Container Filter und aktive Sortierungen beachtet.

Parameter

Parameter	Type	Default value	Description
cursorMode	CRMCursorMode	CRMCursorMode.SolutionDefault	Optional Voreinstellung: 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

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

---

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

---

invokeDataContextMenuAsync()

invokeDataContextMenuAsync(menueId, fieldName): Promise<boolean>;

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

Führt den übergebenen Kontextmenübefehl eines Rechtsklick auf den aktuell gewählten Container-Datensatz und für das angegebene Feld (insofern die Menü-ID einen Bezug zu einem Feld erfordert) aus.

Parameter

Parameter	Type	Description
menueId	number	Die ID des Menüeintrages.
fieldName	string	Name des gewünschten Feldes. Sollte kein Feld verwendet werden, kann der Parameterwert mit einer leeren Zeichenkette übergeben werden.

Rückgabewert

Promise<boolean>

true wenn der Befehl zum Aufrufen eines Menüeintrags erfolgreich übermittelt wurde, false wenn der Befehl nicht übermittelt werden konnte, weil z.B. der Menüeintrag nicht zur Verfügung steht

---

invokeTitleContextMenuAsync()

invokeTitleContextMenuAsync(menueId, fieldName): Promise<boolean>;

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

Führt den übergebenen Kontextmenübefehl eines Rechtsklick auf die aktuell dargestellte Container-Titelzeile aus.

Parameter

Parameter	Type	Description
menueId	number	Die ID des Menüeintrages.
fieldName	string	Name des gewünschten Feldes. Sollte kein Feld verwendet werden, kann der Parameterwert mit einer leeren Zeichenkette übergeben werden.

Rückgabewert

Promise<boolean>

true wenn der Befehl zum Aufrufen eines Menüeintrags erfolgreich übermittelt wurde, false wenn der Befehl nicht übermittelt werden konnte, weil z.B. der Menüeintrag nicht zur Verfügung steht

---

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

---

setFilterByNameAsync()

setFilterByNameAsync(name): Promise<ContainerSetFilterResult>;

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

Aktiviert einen der verfügbaren Containerfilter, welche in der Containerfilter-Auswahlliste angeboten werden.
Voraussetzung: Es gibt eine derartige Containerfilter-Auswahlliste als Element der Eingabemaske.Der Filter muss ein Containerfilter sein.Der zu übergebene Name ist der in der Filtereigenschaft „Name für Scripte/Workflows“ hinterlegte Wert

Parameter

Parameter	Type	Description
name	string	Name für Scripte/Workflows des gewünschten Filterausdrucks

Rückgabewert

Promise<ContainerSetFilterResult>

---

updateAsync()

updateAsync(): Promise<boolean>;

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

Aktualisiert den Container.

Rückgabewert

Promise<boolean>