Container
Bietet Zugriff auf einen Container.
Implementiert
AsyncDisposableDisposable
Eigenschaften
CurrentRecord
get CurrentRecord(): Record
Liefert den aktuellen Datensatz als Objekt vom Typ Record zurück.
Rückgabewert
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2145
IsDisposed
get IsDisposed(): boolean
Gibt an, ob das Objekt bereits Freigegeben wurde
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2159
Methoden
CurrentRecordSetCopy()
CurrentRecordSetCopy()
CurrentRecordSetCopy(): RecordSet
Liefert das aktuelle RecordSet für einen Container zurück. Hierbei werden etwaig angewandte Container Filter und aktive Sortierungen beachtet. Werden im Container keine Datensätze angezeigt, liefert die Methode null zurück
Rückgabewert
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2182
CurrentRecordSetCopy(cursorMode)
CurrentRecordSetCopy(cursorMode): RecordSet
Liefert das aktuelle RecordSet für einen Container zurück. Hierbei werden etwaig angewandte Container Filter und aktive Sortierungen beachtet. Werden im Container keine Datensätze angezeigt, liefert die Methode null zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
cursorMode | number | 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
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2195
CurrentRecordSetCopy(cursorMode)
CurrentRecordSetCopy(cursorMode): RecordSet
Liefert das aktuelle RecordSet für einen Container zurück. Hierbei werden etwaig angewandte Container Filter und aktive Sortierungen beachtet. Werden im Container keine Datensätze angezeigt, liefert die Methode null zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
cursorMode | string | 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
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2208
Dispose()
Dispose(): void
Standardimplementierung des Dispose
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2289
DisposeAsync()
DisposeAsync(): Promise<void>
Standardimplementierung des AsyncDispose
Rückgabewert
Promise<void>
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2278
InvokeDataContextMenu()
InvokeDataContextMenu(menuId, containerFieldName): boolean
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 |
|---|---|---|
menuId | number | Menü-ID des Kontextmenübefehls. |
containerFieldName | string | Name des gewünschten Feldes. Sollte kein Feld verwendet werden, kann der Parameterwert mit einer leeren Zeichenkette übergeben werden. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2241
InvokeTitleContextMenu()
InvokeTitleContextMenu(menuId, containerFieldName): boolean
Führt den übergebenen Kontextmenübefehl eines Rechtsklick auf die aktuell dargestellte Container-Titelzeile aus
Parameter
| Parameter | Type | Description |
|---|---|---|
menuId | number | Menü-ID des Kontextmenübefehls. |
containerFieldName | string | Name des gewünschten Feldes. Sollte kein Feld verwendet werden, kann der Parameterwert mit einer leeren Zeichenkette übergeben werden. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2252
SetFilterByName()
SetFilterByName(filterScriptName): number
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 |
|---|---|---|
filterScriptName | string | Name für Scripte/Workflows des gewünschten Filterausdrucks |
Rückgabewert
number
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2263
Update()
Update(): boolean
Aktualisiert den Container.
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2272
[asyncDispose]()
asyncDispose: Promise<void>
Standardimplementierung des AsyncDispose Symbols
Rückgabewert
Promise<void>
Implementierung von
AsyncDisposable.[asyncDispose]
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2284
[dispose]()
dispose: void
Standardimplementierung des Dispose Symbols
Rückgabewert
void
Implementierung von
Disposable.[dispose]
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:2295
[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:2303