View

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3346

Extends

• ExtendedCRMObjectBase<View>

Eigenschaften

_instance

protected _instance: View;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11

Abgeleitet von

ExtendedCRMObjectBase._instance

---

className

protected readonly className: string;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:15

Abgeleitet von

ExtendedCRMObjectBase.className

---

configAsync

Abfragesignatur

get configAsync(): Promise<ViewConfig>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3367

Erzeugt die ViewConfig für diese Ansicht.

Rückgabewert

Promise<ViewConfig>

---

currentRecordSetAsync

Abfragesignatur

get currentRecordSetAsync(): Promise<RecordSet>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3545

Liefert ein Objekt vom Typ RecordSet zurück.

Rückgabewert

Promise<RecordSet>

---

editmodeAsync

Abfragesignatur

get editmodeAsync(): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3384

Liefert den Status des Bearbeitungsmodus der aktuellen Ansicht

Rückgabewert

Promise<boolean>

---

filterRecCountAsync

Abfragesignatur

get filterRecCountAsync(): Promise<number>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3416

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 View.recCount).

Rückgabewert

Promise<number>

---

isFilterActiveAsync

Abfragesignatur

get isFilterActiveAsync(): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3406

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

Rückgabewert

Promise<boolean>

---

isRowGUIDFilterActiveAsync

Abfragesignatur

get isRowGUIDFilterActiveAsync(): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3446

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

Promise<boolean>

---

nameAsync

Abfragesignatur

get nameAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3426

Liefert den Namen der Ansicht zurück.

Rückgabewert

Promise<string>

---

recCountAsync

Abfragesignatur

get recCountAsync(): Promise<number>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3436

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

Rückgabewert

Promise<number>

---

tagIDAsync

Abfragesignatur

get tagIDAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3456

Mit Hilfe dieser Eigenschaft kann die eigene View.tagID (Identifiername) für eine aktive Ansicht ausgelesen werden.

Rückgabewert

Promise<string>

---

viewModeAsync

Abfragesignatur

get viewModeAsync(): Promise<ViewMode>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3480

Gibt den ViewMode der betreffenden Ansicht zurück

Rückgabewert

Promise<ViewMode>

Konstruktoren

Konstruktor

new View(
   view, 
   internalVersion, 
   disposeInstance): View;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3350

Parameter

Parameter	Type	Default value
view	View	undefined
internalVersion	number | CRMVersion	undefined
disposeInstance	boolean	true

Rückgabewert

View

Überschreibt

ExtendedCRMObjectBase<CoreCRM.View>.constructor

Methoden

[asyncDispose]()

asyncDispose: Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:92

Rückgabewert

Promise<void>

Abgeleitet von

ExtendedCRMObjectBase.[asyncDispose]

---

[dispose]()

dispose: void;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:87

Rückgabewert

void

Abgeleitet von

ExtendedCRMObjectBase.[dispose]

---

activateAsync()

activateAsync(): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3503

Aktiviert die Ansicht und bringt sie in den Vordergrund.

Rückgabewert

Promise<boolean>

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

---

closeAsync()

closeAsync(): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3514

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

Promise<void>

---

currentInputFormAsync()

currentInputFormAsync(mode): Promise<InputForm>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3528

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

Parameter

Parameter	Type	Default value	Description
mode	InputFormMode	InputFormMode.KeepCurrentMode	Optional Voreinstellung: InputFormMode.KeepCurrentMode - Ermöglicht die Spezifikation des Anzeigemodus, in dem das InputForm-Objekt zurückgegeben werden soll.

Rückgabewert

Promise<InputForm>

---

currentRecordSetCopyAsync()

currentRecordSetCopyAsync(cursorMode): Promise<RecordSet>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3565

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.v13.Extended.ts:71

Rückgabewert

void

Abgeleitet von

ExtendedCRMObjectBase.dispose

---

disposeAsync()

disposeAsync(): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:55

Rückgabewert

Promise<void>

Abgeleitet von

ExtendedCRMObjectBase.disposeAsync

---

editMailTemplateAsync()

editMailTemplateAsync(templateFilePath): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3596

Diese Methode öffnet eine Mailvorlage im Mail-Editor

Parameter

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

Rückgabewert

Promise<void>

---

editReportTemplateAsync()

editReportTemplateAsync(templateFilePath): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3610

Diese Methode öffnet eine Druckvorlage im Druckvorlagen-Designer

Parameter

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

Rückgabewert

Promise<void>

---

guardDisposed()

protected guardDisposed(): void;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:28

Wift einen Error, wenn die Instanz bereits freigegeben wurde.

Rückgabewert

void

Throws

Error wenn die Instanz bereits freigegeben wurde.

Abgeleitet von

ExtendedCRMObjectBase.guardDisposed

---

invokeMenuAsync()

invokeMenuAsync(menuId, synchronous): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3625

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.
synchronous	boolean	true: synchrone Ausführung / false: asynchrone Ausführung

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.v13.Extended.ts:50

Gibt an, ob die Instanz bereits freigegeben wurde.

Rückgabewert

boolean

true wenn die Instanz bereits freigegeben wurde, andernfalls false.

Abgeleitet von

ExtendedCRMObjectBase.isDisposed

---

setEditmodeAsync()

setEditmodeAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3394

Setzt den Status des Bearbeitungsmodus der aktuellen Ansicht

Parameter

Parameter	Type
value	boolean

Rückgabewert

Promise<void>

---

setTagIDAsync()

setTagIDAsync(tagID): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3468

Mit Hilfe dieser Eigenschaft kann die eigene View.tagID (Identifiername) für eine aktive Ansicht gesetzt werden.
Ein Objekt vom Typ View (aktive Ansicht) kann anschließend über ListViews.itemByTagID erzeugt werden

Parameter

Parameter	Type	Description
tagID	string	Identifiername

Rückgabewert

Promise<void>

---

setViewModeAsync()

setViewModeAsync(viewMode): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3490

Setzt den ViewMode der betreffenden Ansicht

Parameter

Parameter	Type
viewMode	ViewMode

Rückgabewert

Promise<void>

---

setViewModeToMap()

setViewModeToMap(mode, options?): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3654

Parameter

Parameter	Type
mode	number
options?	{ addressBlockId: string; aggregation: number; boundary: number; colorFrom: number; colorTo: number; field: string; threshold: number; transparencyFrom: number; transparencyTo: number; }
options.addressBlockId?	string
options.aggregation?	number
options.boundary?	number
options.colorFrom?	number
options.colorTo?	number
options.field?	string
options.threshold?	number
options.transparencyFrom?	number
options.transparencyTo?	number

Rückgabewert

Promise<void>

---

startEditNewAsync()

startEditNewAsync(): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3636

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

Rückgabewert

Promise<boolean>

true wenn der Datensatz angelegt werden konnte, andernfalls false.

---

updateAsync()

updateAsync(): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:3647

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

Promise<boolean>