View

Aktive Ansicht

Implementiert

• AsyncDisposable
• Disposable

Eigenschaften

Alias

get Alias(): string

Liefert den Alias der Ansicht zurück.

Rückgabewert

string

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13338

---

Config

get Config(): ViewConfig

Erzeugt ein Objekt vom Typ ViewConfig

Rückgabewert

ViewConfig

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13278

---

CurrentRecord

get CurrentRecord(): Record

Liefert das Record Objekt des aktuellen Datensatzes zurück.

Rückgabewert

Record

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13429

---

CurrentRecordSet

get CurrentRecordSet(): RecordSet

Liefert ein Objekt vom Typ RecordSet zurück.

Rückgabewert

RecordSet

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13399

---

CurrentRecordSetIterable

get CurrentRecordSetIterable(): RecordSet

Rückgabewert

RecordSet

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13412

---

Editmode

get Editmode(): boolean

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

set Editmode(val): void

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

Parameter

Parameter	Type
val	boolean

Rückgabewert

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13295

---

FilterActive

get FilterActive(): boolean

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

Rückgabewert

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13311

---

FilterRecCount

get FilterRecCount(): number

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13320

---

IsDisposed

get IsDisposed(): boolean

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13443

---

Name

get Name(): string

Liefert den Namen der Ansicht zurück.

Rückgabewert

string

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13329

---

RecCount

get RecCount(): number

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13347

---

RowGUIDFilterActive

get RowGUIDFilterActive(): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13356

---

TagID

get TagID(): string

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

set TagID(val): void

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

string

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13366

---

ViewMode

get ViewMode(): number

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

set ViewMode(val): void

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

Parameter

Parameter	Type
val	number

Rückgabewert

number

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13383

Methoden

Activate()

Activate(): boolean

Aktiviert die Ansicht und bringt sie in den Vordergrund.

Rückgabewert

boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13468

---

Close()

Close(): void

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13478

---

CurrentInputForm()

CurrentInputForm(mode): InputForm

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13488

---

CurrentRecordSetCopy()

CurrentRecordSetCopy()

CurrentRecordSetCopy(): RecordSet

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13505

CurrentRecordSetCopy(cursorMode)

CurrentRecordSetCopy(cursorMode): RecordSet

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13519

CurrentRecordSetCopy(cursorMode)

CurrentRecordSetCopy(cursorMode): RecordSet

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13533

---

Dispose()

Dispose(): void

Standardimplementierung des Dispose

Rückgabewert

void

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13686

---

DisposeAsync()

DisposeAsync(): Promise<void>

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13675

---

EditMailTemplate()

EditMailTemplate(template): void

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13566

---

EditReportTemplate()

EditReportTemplate(template): void

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13577

---

InvokeMenu()

InvokeMenu(menuId, synchron): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13591

---

SetViewModeToMap()

SetViewModeToMap(mode)

SetViewModeToMap(mode): void

Parameter

Parameter	Type
mode	number

Rückgabewert

void

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13617

SetViewModeToMap(mode, addressBlockId)

SetViewModeToMap(mode, addressBlockId): void

Parameter

Parameter	Type
mode	number
addressBlockId	string

Rückgabewert

void

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13619

SetViewModeToMap(mode, addressBlockId, boundary)

SetViewModeToMap(
   mode, 
   addressBlockId, 
   boundary): void

Parameter

Parameter	Type
mode	number
addressBlockId	string
boundary	number

Rückgabewert

void

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13621

SetViewModeToMap(mode, addressBlockId, boundary, field)

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

Parameter

Parameter	Type
mode	number
addressBlockId	string
boundary	number
field	string

Rückgabewert

void

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13623

SetViewModeToMap(mode, addressBlockId, boundary, field, threshold)

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

Parameter

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

Rückgabewert

void

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13625

SetViewModeToMap(mode, addressBlockId, boundary, field, threshold, aggregation)

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

Parameter

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

Rückgabewert

void

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13627

SetViewModeToMap(mode, addressBlockId, boundary, field, threshold, aggregation, colorFrom)

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

Parameter

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

Rückgabewert

void

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13629

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

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

Parameter

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

Rückgabewert

void

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13631

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

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

Parameter

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

Rückgabewert

void

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13633

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

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

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13635

---

StartEditNew()

StartEditNew(): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13602

---

Update()

Update(): boolean

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

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13612

---

[asyncDispose]()

asyncDispose: Promise<void>

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13681

---

[dispose]()

dispose: void

Standardimplementierung des Dispose Symbols

Rückgabewert

void

Implementierung von

Disposable.[dispose]

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:13692

---

[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:13700