View

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13264

Aktive Ansicht

Implementiert

• AsyncDisposable
• Disposable

Eigenschaften

Alias

Abfragesignatur

get Alias(): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13338

Liefert den Alias der Ansicht zurück.

Rückgabewert

string

---

Config

Abfragesignatur

get Config(): ViewConfig;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13278

Erzeugt ein Objekt vom Typ ViewConfig

Rückgabewert

ViewConfig

---

CurrentRecord

Abfragesignatur

get CurrentRecord(): Record;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13429

Liefert das Record Objekt des aktuellen Datensatzes zurück.

Rückgabewert

Record

---

CurrentRecordSet

Abfragesignatur

get CurrentRecordSet(): RecordSet;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13399

Liefert ein Objekt vom Typ RecordSet zurück.

Rückgabewert

RecordSet

---

CurrentRecordSetIterable

Abfragesignatur

get CurrentRecordSetIterable(): RecordSet;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13412

Rückgabewert

RecordSet

---

Editmode

Abfragesignatur

get Editmode(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13295

Liefert den Status des Bearbeitungsmodus der aktuellen Ansicht zurück oder setzt diesen

Rückgabewert

boolean

Änderungssignatur

set Editmode(val): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13303

Liefert den Status des Bearbeitungsmodus der aktuellen Ansicht zurück oder setzt diesen

Parameter

Parameter	Type
val	boolean

Rückgabewert

void

---

FilterActive

Abfragesignatur

get FilterActive(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13311

Liefert true zurück, wenn in der Ansicht ein vom Benutzer angelegter Filter aktiv is

Rückgabewert

boolean

---

FilterRecCount

Abfragesignatur

get FilterRecCount(): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13320

Gibt die Anzahl der Datensätze zurück. Ein etwaiger Filter wird dabei berücksichtigt. Ist kein Filter aktiv, wird die Anzahl aller Datensätze der Ansicht zurückgegeben(siehe RecCount ).

Rückgabewert

number

---

IsDisposed

Abfragesignatur

get IsDisposed(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13443

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean

---

Name

Abfragesignatur

get Name(): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13329

Liefert den Namen der Ansicht zurück.

Rückgabewert

string

---

RecCount

Abfragesignatur

get RecCount(): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13347

Gibt die Anzahl der Datensätze zurück. Ein etwaiger Filter wird dabei ignoriert. Soll dieser berücksichtigt werden, verwenden Sie stattdessen FilterRecCount

Rückgabewert

number

---

RowGUIDFilterActive

Abfragesignatur

get RowGUIDFilterActive(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13356

Diese Eigenschaft zeigt an, ob der interne Filter, der zu einem Datensatzsprung geführt hat, aktiv ist. Dieser wird z.B.ausgeführt, wenn man auf einen Favoriten-Datensatz springt.

Rückgabewert

boolean

---

TagID

Abfragesignatur

get TagID(): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13366

Mit Hilfe dieser Eigenschaft kann die eigene TagID (Identifiername) für eine aktive Ansicht ausgelesen werden.
Ein Objekt vom Typ View (aktive Ansicht) kann anschließend über ItemByTagID(tagId: string) erzeugt werden

Rückgabewert

string

Änderungssignatur

set TagID(val): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13375

Mit Hilfe dieser Eigenschaft kann die eigene TagID (Identifiername) für eine aktive Ansicht ausgelesen werden.
Ein Objekt vom Typ View (aktive Ansicht) kann anschließend über ItemByTagID(tagId: string) erzeugt werden

Parameter

Parameter	Type
val	string

Rückgabewert

void

---

ViewMode

Abfragesignatur

get ViewMode(): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13383

Gibt den Modus der betreffenden Ansicht zurück oder setzt diesen

Rückgabewert

number

Änderungssignatur

set ViewMode(val): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13391

Gibt den Modus der betreffenden Ansicht zurück oder setzt diesen

Parameter

Parameter	Type
val	number

Rückgabewert

void

Methoden

[asyncDispose]()

asyncDispose: Promise<void>;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13681

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

---

[dispose]()

dispose: void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13692

Standardimplementierung des Dispose Symbols

Rückgabewert

void

Implementierung von

Disposable.[dispose]

---

Activate()

Activate(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13468

Aktiviert die Ansicht und bringt sie in den Vordergrund.

Rückgabewert

boolean

true wenn die Ansicht geöffnet werden konnte, andernfalls false

---

Close()

Close(): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13478

Close versucht die Ansicht zu schließen
Wichtig: Ruft man Close in der aktuellen Ansicht auf (in der das Script läuft), kann dies zu Problemen führen. Dies sollte daher vermieden werden.

Rückgabewert

void

---

CurrentInputForm()

CurrentInputForm(mode): InputForm;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13488

Diese Methode wechselt in der aktuellen Ansicht in den Bearbeitungsmodus und liefert das InputForm Objekt der aktuellen Eingabemaske zurück.

Parameter

Parameter	Type	Description
mode	number	Anzeigemodus der Eingemaske

Rückgabewert

InputForm

---

CurrentRecordSetCopy()

Aufrufsignatur

CurrentRecordSetCopy(): RecordSet;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13505

Liefert ein Objekt vom Typ RecordSet zurück, das die Datensätze des aktiven Filters der Ansicht enthält, jedoch von der Ansicht unabhängig ist.

Rückgabewert

RecordSet

Aufrufsignatur

CurrentRecordSetCopy(cursorMode): RecordSet;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13519

Liefert ein Objekt vom Typ RecordSet zurück, das die Datensätze des aktiven Filters der Ansicht enthält, jedoch von der Ansicht unabhängig ist.

Parameter

Parameter	Type	Description
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

Aufrufsignatur

CurrentRecordSetCopy(cursorMode): RecordSet;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13533

Liefert ein Objekt vom Typ RecordSet zurück, das die Datensätze des aktiven Filters der Ansicht enthält, jedoch von der Ansicht unabhängig ist.

Parameter

Parameter	Type	Description
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

---

Dispose()

Dispose(): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13686

Standardimplementierung des Dispose

Rückgabewert

void

---

DisposeAsync()

DisposeAsync(): Promise<void>;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13675

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>

---

EditMailTemplate()

EditMailTemplate(template): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13566

Diese Methode öffnet eine Mailvorlage im Mail-Editor

Parameter

Parameter	Type	Description
template	string	Pfad der zu öffnenden Mailvorlage. Wenn kein Pfad übergeben wird, dann erfolgt die Dateiauswahl interaktiv.

Rückgabewert

void

---

EditReportTemplate()

EditReportTemplate(template): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13577

Diese Methode öffnet eine Druckvorlage im Druckvorlagen-Designer

Parameter

Parameter	Type	Description
template	string	Pfad der zu öffnenden Druckvorlage. Wenn kein Pfad übergeben wird, dann erfolgt die Dateiauswahl interaktiv.

Rückgabewert

void

---

InvokeMenu()

InvokeMenu(menuId, synchron): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13591

Ruft einen Menüeintrag der Anwendung auf. Neben der ID des Menüeintrages wird angegeben, ob das Script solange warten soll, bis der Befehl abgearbeitet wurde(und evtl. Dialoge geschlossen wurden) oder ob das Script direkt weiterlaufen soll.

Parameter

Parameter	Type	Description
menuId	number	Die ID des Menüeintrages.
synchron	boolean	true : synchrone Ausführung false : asynchrone Ausführung

Rückgabewert

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

---

SetViewModeToMap()

Aufrufsignatur

SetViewModeToMap(mode): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13617

Parameter

Parameter	Type
mode	number

Rückgabewert

void

Aufrufsignatur

SetViewModeToMap(mode, addressBlockId): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13619

Parameter

Parameter	Type
mode	number
addressBlockId	string

Rückgabewert

void

Aufrufsignatur

SetViewModeToMap(
   mode, 
   addressBlockId, 
   boundary): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13621

Parameter

Parameter	Type
mode	number
addressBlockId	string
boundary	number

Rückgabewert

void

Aufrufsignatur

SetViewModeToMap(
   mode, 
   addressBlockId, 
   boundary, 
   field): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13623

Parameter

Parameter	Type
mode	number
addressBlockId	string
boundary	number
field	string

Rückgabewert

void

Aufrufsignatur

SetViewModeToMap(
   mode, 
   addressBlockId, 
   boundary, 
   field, 
   threshold): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13625

Parameter

Parameter	Type
mode	number
addressBlockId	string
boundary	number
field	string
threshold	number

Rückgabewert

void

Aufrufsignatur

SetViewModeToMap(
   mode, 
   addressBlockId, 
   boundary, 
   field, 
   threshold, 
   aggregation): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13627

Parameter

Parameter	Type
mode	number
addressBlockId	string
boundary	number
field	string
threshold	number
aggregation	number

Rückgabewert

void

Aufrufsignatur

SetViewModeToMap(
   mode, 
   addressBlockId, 
   boundary, 
   field, 
   threshold, 
   aggregation, 
   colorFrom): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13629

Parameter

Parameter	Type
mode	number
addressBlockId	string
boundary	number
field	string
threshold	number
aggregation	number
colorFrom	number

Rückgabewert

void

Aufrufsignatur

SetViewModeToMap(
   mode, 
   addressBlockId, 
   boundary, 
   field, 
   threshold, 
   aggregation, 
   colorFrom, 
   transparencyFrom): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13631

Parameter

Parameter	Type
mode	number
addressBlockId	string
boundary	number
field	string
threshold	number
aggregation	number
colorFrom	number
transparencyFrom	number

Rückgabewert

void

Aufrufsignatur

SetViewModeToMap(
   mode, 
   addressBlockId, 
   boundary, 
   field, 
   threshold, 
   aggregation, 
   colorFrom, 
   transparencyFrom, 
   colorTo): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13633

Parameter

Parameter	Type
mode	number
addressBlockId	string
boundary	number
field	string
threshold	number
aggregation	number
colorFrom	number
transparencyFrom	number
colorTo	number

Rückgabewert

void

Aufrufsignatur

SetViewModeToMap(
   mode, 
   addressBlockId, 
   boundary, 
   field, 
   threshold, 
   aggregation, 
   colorFrom, 
   transparencyFrom, 
   colorTo, 
   transparencyTo): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13635

Parameter

Parameter	Type
mode	number
addressBlockId	string
boundary	number
field	string
threshold	number
aggregation	number
colorFrom	number
transparencyFrom	number
colorTo	number
transparencyTo	number

Rückgabewert

void

---

StartEditNew()

StartEditNew(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13602

Legt in der aktuellen Ansicht einen neuen Datensatz an und wechselt in den Änderungsmodus (analog zum Menüpunkt 'Neuer Datensatz anlegen').

Rückgabewert

boolean

true wenn der Datensatz angelegt werden konnte, andernfalls false

---

Update()

Update(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13612

Aktualisiert die aktuelle Ansicht. Dabei wird der aktuelle Datensatz neu dargestellt, und die Statusleiste wird ebenfalls aktualisiert.
Es sollten zuvor sowohl alle etwaigen von der View geholten RecordSet -Objekte als Objekt-Referenz auch alle etwaig geholten Record -Objekte freigegeben werden, keinesfalls dürfen sie anschließend noch benutzt werden

Rückgabewert

boolean

---

[hasInstance]()

static hasInstance: boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:13700

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

Parameter

Parameter	Type
value	any

Rückgabewert

boolean