QueryGrid

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:668

Stellt das QueryGrid bereit.

Implementiert

• AsyncDisposable
• Disposable

Eigenschaften

columnMaxWidth

Abfragesignatur

get columnMaxWidth(): number;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:778

Die maximale Breite einer Spalte

Rückgabewert

number

Änderungssignatur

set columnMaxWidth(val): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:786

Die maximale Breite einer Spalte

Parameter

Parameter	Type
val	number

Rückgabewert

void

---

columnMinWidth

Abfragesignatur

get columnMinWidth(): number;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:762

Die minimale Breite einer Spalte

Rückgabewert

number

Änderungssignatur

set columnMinWidth(val): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:770

Die minimale Breite einer Spalte

Parameter

Parameter	Type
val	number

Rückgabewert

void

---

columnsEditable

Abfragesignatur

get columnsEditable(): boolean;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:844

Sagt aus, ob alle Spalten editierbar sind.
Ist dieser Wert false ist nur noch die Selektierspalte bearbeitbar
readOnly oder readOnly verwenden, um Spalten und Zellen gezielter zu steuern.

Rückgabewert

boolean

Änderungssignatur

set columnsEditable(val): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:854

Sagt aus, ob alle Spalten editierbar sind.
Ist dieser Wert false ist nur noch die Selektierspalte bearbeitbar
readOnly oder readOnly verwenden, um Spalten und Zellen gezielter zu steuern.

Parameter

Parameter	Type
val	boolean

Rückgabewert

void

---

enableDragAndDrop

Abfragesignatur

get enableDragAndDrop(): boolean;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:863

Ob Drag and Drop der QueryGridRow 's im Grid erlaubt ist
Default: false

Rückgabewert

boolean

Änderungssignatur

set enableDragAndDrop(val): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:872

Ob Drag and Drop der QueryGridRow 's im Grid erlaubt ist
Default: false

Parameter

Parameter	Type
val	boolean

Rückgabewert

void

---

formHandle

Abfragesignatur

get formHandle(): number;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:699

Das Handle der Form.
Kann nur aufgerufen werden, wenn die Form angezeigt wird. Ansonsten wird -1 zurückgeliefert

Rückgabewert

number

---

height

Abfragesignatur

get height(): number;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:826

Die Höhe des Fensters

Rückgabewert

number

Änderungssignatur

set height(val): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:834

Die Höhe des Fensters

Parameter

Parameter	Type
val	number

Rückgabewert

void

---

isCancelled

Abfragesignatur

get isCancelled(): boolean;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:753

Sagt aus, ob der Dialog vom User abgebrochen wurde

Rückgabewert

boolean

---

isModified

Abfragesignatur

get isModified(): boolean;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:682

Ob eine der Reihen im Grid vom User über die UI angepasst wurde

Rückgabewert

boolean

Änderungssignatur

set isModified(val): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:690

Ob eine der Reihen im Grid vom User über die UI angepasst wurde

Parameter

Parameter	Type
val	boolean

Rückgabewert

void

---

name

Abfragesignatur

get name(): string;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:794

Der Name des Fensters

Rückgabewert

string

Änderungssignatur

set name(val): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:802

Der Name des Fensters

Parameter

Parameter	Type
val	string

Rückgabewert

void

---

rowCount

Abfragesignatur

get rowCount(): number;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:708

Liefert die Anzahl der QueryGridRow 's zurück

Rückgabewert

number

---

rowsCounterEnabled

Abfragesignatur

get rowsCounterEnabled(): boolean;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:736

Bestimmt, ob Reihen nummeriert werden
Default: true

Rückgabewert

boolean

Änderungssignatur

set rowsCounterEnabled(val): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:745

Bestimmt, ob Reihen nummeriert werden
Default: true

Parameter

Parameter	Type
val	boolean

Rückgabewert

void

---

rowsSelectable

Abfragesignatur

get rowsSelectable(): boolean;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:718

Bestimmt, ob Reihen ausgewählt werden können
Default: true

Rückgabewert

boolean

Änderungssignatur

set rowsSelectable(val): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:727

Bestimmt, ob Reihen ausgewählt werden können
Default: true

Parameter

Parameter	Type
val	boolean

Rückgabewert

void

---

width

Abfragesignatur

get width(): number;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:810

Die Breite des Fensters

Rückgabewert

number

Änderungssignatur

set width(val): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:818

Die Breite des Fensters

Parameter

Parameter	Type
val	number

Rückgabewert

void

Konstruktoren

Konstruktor

new QueryGrid(): QueryGrid;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:884

Das Grid, in dem alle Daten angezeigt werden

Rückgabewert

QueryGrid

Methoden

[asyncDispose]()

asyncDispose: Promise<void>;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1237

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

---

[dispose]()

dispose: void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1248

Standardimplementierung des Dispose Symbols

Rückgabewert

void

Implementierung von

Disposable.[dispose]

---

close()

close(): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1216

schließt die Dialogform

Rückgabewert

void

---

deleteOptions()

deleteOptions(name): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1006

Löscht die IQueryGridColumnOptions anhand des Spaltennamen

Parameter

Parameter	Type	Description
name	string

Rückgabewert

void

---

dispose()

dispose(): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1198

Gibt alle Ressourcen frei

Rückgabewert

void

---

Dispose()

Dispose(): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1242

Standardimplementierung des Dispose

Rückgabewert

void

---

DisposeAsync()

DisposeAsync(): Promise<void>;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1231

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>

---

extendOptions()

extendOptions(columnName, options): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:910

Erweitert die Optionen für eine Spalte - Bestehende Optionen bleiben erhalten und werden nur mit den gesetzten Werten überschrieben

Parameter

Parameter	Type	Description
columnName	string
options	IQueryGridColumnOptions

Rückgabewert

void

---

fillByRecordSet()

fillByRecordSet(recordSet): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1052

Befüllt die Form mit dem übergebenen RecordSet. Dabei werden alle Felder übernommen

Parameter

Parameter	Type	Description
recordSet	ADORecordSet

Rückgabewert

void

Deprecated

Bitte fillByRecordSetAsync verwenden

---

fillByRecordSetAsync()

fillByRecordSetAsync(recordSet, makeSelectedRowsReadOnly?): Promise<void>;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1067

Befüllt die Form mit dem übergebenen RecordSet. Dabei werden alle Felder übernommen

Parameter

Parameter	Type	Description
recordSet	ADORecordSet
makeSelectedRowsReadOnly?	boolean	Optional: Default false : Ob die Reihen / Zellen alle Readonly gemacht werden sollen

Rückgabewert

Promise<void>

---

getAllRows()

getAllRows(): QueryGridRow[];

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1180

Liefert alle Reihen zurück.

Rückgabewert

QueryGridRow[]

Deprecated

Bitte getAllRowsAsync verwenden

---

getAllRowsAsync()

Aufrufsignatur

getAllRowsAsync(func): Promise<QueryGridRow[]>;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1129

Liefert alle Reihen zurück.
Es kann optional eine Funktion übergeben werden, um nur bestimmte Reihen als Ergebnis zu erhalten

Parameter

Parameter	Type	Description
func	(arg0) => Promise<boolean>	Optional: Funktion, welche eine QueryGridRow als Input und bool als Output hat. Alle Reihen werden nacheinander in diese Funktion gesteckt. Liefert die Funktion für eine Reihe true zurück, ist diese im Ergebnis enthalten Bei false wird diese Reihe nicht zurückgegeben.

Rückgabewert

Promise<QueryGridRow[]>

Aufrufsignatur

getAllRowsAsync(func): Promise<QueryGridRow[]>;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1140

Liefert alle Reihen zurück, die nicht gelöscht wurden.
Es kann optional eine Funktion übergeben werden, um nur bestimmte Reihen als Ergebnis zu erhalten

Parameter

Parameter	Type	Description
func	(arg0) => boolean	Funktion, welche eine QueryGridRow als Input und bool als Output hat. Alle Reihen werden nacheinander in diese Funktion gesteckt. Liefert die Funktion für eine Reihe true zurück, ist diese im Ergebnis enthalten Bei false wird diese Reihe nicht zurückgegeben

Rückgabewert

Promise<QueryGridRow[]>

Aufrufsignatur

getAllRowsAsync(): Promise<QueryGridRow[]>;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1146

Liefert alle Reihen zurück, die nicht gelöscht wurden.

Rückgabewert

Promise<QueryGridRow[]>

---

getSelectedRows()

getSelectedRows(): QueryGridRow[];

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1087

Liefert alle selektierten Reihen zurück. Funktioniert erst, wenn das Grid angezeigt wurde.

Rückgabewert

QueryGridRow[]

---

getVisibleRows()

getVisibleRows(): QueryGridRow[];

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1106

Liefert alle sichtbaren Reihen zurück ( isVisible ). Funktioniert erst, wenn das Grid angezeigt wird.
Entspricht dem aktuellen Filter.

Rückgabewert

QueryGridRow[]

---

newRow()

newRow(): QueryGridRow;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1016

Erstellt eine neue QueryGridRow und liefert diese zurück

Rückgabewert

QueryGridRow

Deprecated

Bitte newRowAsync verwenden

---

newRowAsync()

newRowAsync(): Promise<QueryGridRow>;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1033

Erstellt eine neue QueryGridRow und liefert diese zurück

Rückgabewert

Promise<QueryGridRow>

---

setActionToRunAfterInitialize()

setActionToRunAfterInitialize(action): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:964

Setzt eine Aktion, die nach der Initialisierung des QueryGrid einmalig ausgeführt wird.

Parameter

Parameter	Type	Description
action	() => any

Rückgabewert

void

---

setFunctionToCheckOnAbortClick()

Aufrufsignatur

setFunctionToCheckOnAbortClick(func): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:943

Setzt die Funktion, die beim Klick auf den Abbrechen-Button ausgeführt wird. Diese muss true oder false zurückliefern
Damit wird entscheiden, ob der Prozess des Abbrechen-Button Klicks ausgeführt werden darf oder nicht.

Parameter

Parameter	Type	Description
func	() => Promise<boolean>	Die Funktion, die überprüft wird

Rückgabewert

void

Aufrufsignatur

setFunctionToCheckOnAbortClick(func): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:951

Setzt die Funktion, die beim Klick auf den Abbrechen-Button ausgeführt wird. Diese muss true oder false zurückliefern
Damit wird entscheiden, ob der Prozess des Abbrechen-Button Klicks ausgeführt werden darf oder nicht.

Parameter

Parameter	Type	Description
func	() => boolean	Die Funktion, die überprüft wird

Rückgabewert

void

---

setFunctionToCheckOnOkClick()

Aufrufsignatur

setFunctionToCheckOnOkClick(func): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:921

Setzt die Funktion, die beim Klick auf den OK-Button ausgeführt wird. Diese muss true oder false zurückliefern
Damit wird entscheiden, ob der Prozess des OK-Button Klicks ausgeführt werden darf oder nicht.

Parameter

Parameter	Type	Description
func	() => boolean	Die Funktion, die überprüft wird

Rückgabewert

void

Aufrufsignatur

setFunctionToCheckOnOkClick(func): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:929

Setzt die Funktion, die beim Klick auf den OK-Button ausgeführt wird. Diese muss true oder false zurückliefern
Damit wird entscheiden, ob der Prozess des OK-Button Klicks ausgeführt werden darf oder nicht.

Parameter

Parameter	Type	Description
func	() => Promise<boolean>	Die Funktion, die überprüft wird

Rückgabewert

void

---

setOnAfterDropEventFunction()

Aufrufsignatur

setOnAfterDropEventFunction(func): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:980

Setzt eine Funktion, die immer dann ausgeführt wird, nachdem ein Drop stattgefunden hat
Argument 1 - Source Row - Die Reihe, die gezogen (Drag) wurde
Argument 2 - Target Row - Die Reihe, auf die losgelassen (Drop) wurde
Argument 3 - Insert Type - Ob die Reihe vor oder nach der Zielreihe eingefügt wurde oder der Drop abgebrochen wurde.
Achtung: Bei InsertType muss für den Vergleich in TypeScript _id verwendet werden.
z.B. wenn die Reihen schon direkt übereinander standen und der Drop nichts verändert hätte oder der Drop auf der Zielreihe nicht erlaubt ist.

Parameter

Parameter	Type	Description
func	(arg0, arg1, arg2) => Promise<void>	Diese Funktion wird nach jedem Drop aufgerufen, um auf einen Drop zu reagieren. Die QueryGridRow 's sind zum Zeitpunkt des Events schon neu sortiert

Rückgabewert

void

Aufrufsignatur

setOnAfterDropEventFunction(func): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:993

Setzt eine Funktion, die immer dann ausgeführt wird, nachdem ein Drop stattgefunden hat
Argument 1 - Source Row - Die Reihe, die gezogen (Drag) wurde
Argument 2 - Target Row - Die Reihe, auf die losgelassen (Drop) wurde
Argument 3 - Insert Type - Ob die Reihe vor oder nach der Zielreihe eingefügt wurde oder der Drop abgebrochen wurde
Achtung: Bei InsertType muss für den Vergleich in TypeScript _id verwendet werden.
z.B. wenn die Reihen schon direkt übereinander standen und der Drop nichts verändert hätte oder der Drop auf der Zielreihe nicht erlaubt ist.

Parameter

Parameter	Type	Description
func	(arg0, arg1, arg2) => void	Diese Funktion wird nach jedem Drop aufgerufen, um auf einen Drop zu reagieren. Die QueryGridRow 's sind zum Zeitpunkt des Events schon neu sortiert

Rückgabewert

void

---

setOptions()

setOptions(columnName, options): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:899

Setzt die Optionen für eine Spalte

Parameter

Parameter	Type	Description
columnName	string
options	IQueryGridColumnOptions

Rückgabewert

void

---

showDialogAsync()

showDialogAsync(crmHandle): Promise<void>;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1207

Zeigt das QueryGrid an.

Parameter

Parameter	Type
crmHandle	number

Rückgabewert

Promise<void>

---

update()

update(): void;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1225

Aktualisiert die View und damit auch alle Zellen optisch

Rückgabewert

void

---

[hasInstance]()

static hasInstance: boolean;

Definiert in: sdk/cosmolink.SDK.QueryGrid.ts:1256

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

Parameter

Parameter	Type
value	any

Rückgabewert

boolean