Version: 1.24.250.1124

DialogForm

Implementiert

AsyncDisposable

Eigenschaften

DLIPath

get DLIPath(): string

Setzt den Pfad inkl. Dateiname zur DLI-Eingabemaskendatei oder liefert ihn zurück.
Wichtig: Um die DLI-Eingabemaskendatei erstellen zu können, muss bereits vor dem ersten Start des Scripts ein Pfad inkl.Dateiname angegeben werden.

set DLIPath(val): void

Parameter

Parameter	Type
`val`	`string`

Rückgabewert

string

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7303

DialogTitle

get DialogTitle(): string

Setzt den Dialogtitel oder liefert ihn zurück.

set DialogTitle(val): void

Setzt den Dialogtitel oder liefert ihn zurück.

Parameter

Parameter	Type
`val`	`string`

Rückgabewert

string

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7286

HeightInPixel

get HeightInPixel(): number

Setzt die Höhe des Dialogs in Pixel (maximal 32767 Pixel) oder liefert sie zurück.

set HeightInPixel(val): void

Setzt die Höhe des Dialogs in Pixel (maximal 32767 Pixel) oder liefert sie zurück.

Parameter

Parameter	Type
`val`	`number`

Rückgabewert

number

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7338

IconPath

get IconPath(): string

Setzt oder liefert das Icon für den Dialog.
Wichtig: Es kann der Pfad zu einer .ico-, .exe- oder .dll-Datei verwendet werden.Es werden nur 16x16 Pixel große Icons unterstützt. Bei.exe- und.dll-Dateien wird immer das erste Icon der Sammlung verwendet.

set IconPath(val): void

Parameter

Parameter	Type
`val`	`string`

Rückgabewert

string

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7321

IsDisposed

get IsDisposed(): boolean

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7428

IsShowing

get IsShowing(): boolean

Gibt an, ob der Dialog geöffnet ist

Rückgabewert

boolean

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7406

ShowResult

get ShowResult(): number

Gibt den in der Methode DefineFct(name: string, tooltip: string, causeCloseDialog: boolean, action: (arg0: DialogForm, arg1: DialogEventArgs) => void, valueOnClose: number) übergebenen Wert des Parameters valueOnClose zurück, insofern der Dialog mit Klick auf diese Schaltfläche geschlossen wird, siehe Parameter causeCloseDialog.

set ShowResult(val): void

Parameter

Parameter	Type
`val`	`number`

Rückgabewert

number

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7354

Sizable

get Sizable(): boolean

Bestimmt, ob sich die Größe des Dialogs verändern lässt oder nicht bzw. liefert diesen Wert zurück

set Sizable(val): void

Bestimmt, ob sich die Größe des Dialogs verändern lässt oder nicht bzw. liefert diesen Wert zurück

Parameter

Parameter	Type
`val`	`boolean`

Rückgabewert

boolean

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7370

SizeToContent

get SizeToContent(): boolean

Bestimmt, ob sich die Größe des Dialogs an die Größe der Eingabemaske anpasst oder nicht bzw. liefert diesen Wert zurück.
true : Größe des Dialogs wird an die Eingabemaske angepasst. Größenangaben werden ignoriert.
false : Größe des Dialogs wird durch die Größenangaben bestimmt.

set SizeToContent(val): void

Parameter

Parameter	Type
`val`	`boolean`

Rückgabewert

boolean

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7388

WidthInPixel

get WidthInPixel(): number

Setzt die Breite des Dialogs in Pixel (maximal 32767 Pixel) oder liefert sie zurück.

set WidthInPixel(val): void

Setzt die Breite des Dialogs in Pixel (maximal 32767 Pixel) oder liefert sie zurück.

Parameter

Parameter	Type
`val`	`number`

Rückgabewert

number

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7415

Methoden

AddTimer()

AddTimer(name, seconds, action)

AddTimer(
   name, 
   seconds, 
   action): void

Meldet einen Timer-Event an. Dieser führt in den in Parameter Seconds angegebenen Abständen die Aktion action aus.

Parameter

Parameter	Type	Description
`name`	`string`	Name des Timers.
`seconds`	`number`	Intervall in Sekunden, in denen sich der Event meldet.
`action`	(`arg0`) => `void`	Eine Methode mit der Signatur Methode() und keinem Rückgabewert(void).

Rückgabewert

void

Example

Ein Aufruf dieser Methode könnte wie folgt aussehen:

dialogForm.AddTimer("timer1", 5, runTimer);
async function runTimer(dialog: DialogForm)
{
	await cRM.DialogMessageBox("Timer 1:", "Timer 1 wurde ausgeführt (5 Sekunden)", dialog.DialogTitle, MsgBoxButton.OkOnly, MsgBoxIcon.Information);
}
//Oder alternativ Inline
dialogForm.AddTimer("timer1", 5, async(dialog: DialogForm) => {
	await cRM.DialogMessageBox("Timer 1:", "Timer 1 wurde ausgeführt (5 Sekunden)", dialog.DialogTitle, MsgBoxButton.OkOnly, MsgBoxIcon.Information);
});

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7463

AddTimer(name, seconds, action)

AddTimer(
   name, 
   seconds, 
   action): void

Meldet einen Timer-Event an. Dieser führt in den in Parameter Seconds angegebenen Abständen die Aktion action aus.

Parameter

Parameter	Type	Description
`name`	`string`	Name des Timers.
`seconds`	`number`	Intervall in Sekunden, in denen sich der Event meldet.
`action`	(`arg0`) => `Promise`<`void`>	Eine Methode mit der Signatur Methode() und keinem Rückgabewert(void).

Rückgabewert

void

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7472

Close()

Close(): Promise<void>

Schließt den Dialog.

Rückgabewert

Promise<void>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7484

DefineComboboxItems()

DefineComboboxItems(fieldName, items): void

Fügt zu einer in der Eingabemaske bestehenden Combobox Auswahleinträge hinzu.

Parameter

Parameter	Type	Description
`fieldName`	`string`	Feldname
`items`	`string`	Liste mit Einträgen. Mehrere Einträge werden dabei mit dem Separator \r getrennt

Rückgabewert

void

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7495

DefineFct()

DefineFct(
   name, 
   tooltip, 
   causeCloseDialog, 
   action, 
   valueOnClose): void

Meldet eine Schaltfläche an.

Parameter

Parameter	Type	Description
`name`	`string`	Anzeigename
`tooltip`	`string`	Tooltip
`causeCloseDialog`	`boolean`	Bestimmt ob der Dialog wird beim Drücken geschlossen wird (z.B. bei OK oder Abbrechen).
`action`	(`arg0`, `arg1`) => `void`	Aktion die ausgeführt werden soll, sobald der Button betätigt wurde
`valueOnClose`	`number`	Rückgabewert, den die ShowResult Eigenschaft später liefern soll, wenn über die Schaltfläche der Dialog geschlossen wird (wenn Parameter `causeCloseDialog` = `true` )

Rückgabewert

void

Example

Ein Aufruf dieser Methode könnte wie folgt aussehen:

dialogForm.DefineFct("button1","ToolTip von Button1", false, executeButton1, 1);
async function executeButton1(dialog: DialogForm){
{
	await cRM.DialogMessageBox("Schaltfläche 1:", "Schaltfläche 1 wurde ausgeführt", dialog.DialogTitle, MsgBoxButton.OkOnly, MsgBoxIcon.Information);
}
//Oder alternativ Inline
dialogForm.DefineFct("button1","ToolTip von Button1", false, async(dialog: DialogForm) => {
	await cRM.DialogMessageBox("Schaltfläche 1:", "Schaltfläche 1 wurde ausgeführt", dialog.DialogTitle, MsgBoxButton.OkOnly, MsgBoxIcon.Information);
}, 1);

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7524

DefineFct(
   name, 
   tooltip, 
   causeCloseDialog, 
   action, 
   valueOnClose): void

Meldet einen Button an.

Parameter

Parameter	Type	Description
`name`	`string`	Anzeigename
`tooltip`	`string`	Tooltip
`causeCloseDialog`	`boolean`	Bestimmt ob der Dialog wird beim Drücken geschlossen wird (z.B. bei OK oder Abbrechen).
`action`	(`arg0`, `arg1`) => `Promise`<`void`>	Aktion die ausgeführt werden soll, sobald der Button betätigt wurde
`valueOnClose`	`number`	Rückgabewert, den die ShowResult Eigenschaft später liefern soll, wenn über die Schaltfläche der Dialog geschlossen wird (wenn Parameter `causeCloseDialog` = `true` )

Rückgabewert

void

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7535

DefineFctStart()

DefineFctStart(): void

Initialisiert die Funktionen.

Rückgabewert

void

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7547

DefineVariable()

DefineVariable(
   name, 
   id, 
   type, 
   length, 
   precision, 
   defaultValue): void

Meldet ein Eingabefeld an.

Parameter

Parameter	Type	Description
`name`	`string`	Anzeigename
`id`	`number`	ID
`type`	`DialogFormVarType`	Feldtyp
`length`	`number`	Feldlänge
`precision`	`number`	Präzision bei Nachkommastellen
`defaultValue`	`string`	Initieller Wert. Verwenden Sie die folgenden Formate für den DefaultValue: Bei Datumsfeldern: YYYYMMDD Bei Datumsfeldern mit Zeitanteil: YYYYMMDDHHMMSS

Rückgabewert

void

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7565

DefineVariableStart()

DefineVariableStart(): void

Initialisiert die Variablen.

Rückgabewert

void

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7579

Delay()

Delay(milliseconds): Promise<void>

Wartet eine angegebene Zeit.
Wird für ShowModeless() benötigt

Parameter

Parameter	Type	Description
`milliseconds`	`number`	Wartezeit in Millisekunden

Rückgabewert

Promise<void>

Gibt seinen Promise | Promise<void> zurück auf den gewartet werden muss

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7713

DisposeAsync()

DisposeAsync(): Promise<void>

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7728

GetVariableContentsValueByName()

GetVariableContentsValueByName<T>(t, name): T

Liefert den Inhalt der Variable zurück. Der Rückgabewert sollte dem Wert der Variable entsprechen, da es sonst zu Konvertierungsfehlern kommen kann.

Type Parameters

Type Parameter
`T` extends `string` \| `number` \| `boolean` \| `Date`

Parameter

Parameter	Type	Description
`t`	`CLType`<`T`>	Generischer Parameter. Der Wert muss einem Wert von CLType entsprechen
`name`	`string`	Name der gewünschten Variable.

Rückgabewert

T

Inhalt der Variable oder null wenn die Variable nicht angemeldet wurde

Example

const dateValue : Date = dialogForm.GetVariableContentsValueByName(CLType.Date,"Datumsfeld");

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7610

GetVariableContentsVariant()

GetVariableContentsVariant(name): string

Liefert den aktuellen Inhalt einer Variablen

Parameter

Parameter	Type	Description
`name`	`string`	Anzeigename.

Rückgabewert

string

Rückgabewert des Feldes oder null wenn das Feld nicht gefunden wurde

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7591

Layout()

Layout(): Promise<void>

Öffnen des Dialoges im Eingabemaskendesigner. Dieser kann auch durch Drücken der Tastenkombination STRG+J direkt nach dem Öffnen des Dialogs erreicht werden(nur wenn die Methode Show() verwendet wird, nicht aber bei Methode ShowModeless() ).

Rückgabewert

Promise<void>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7624

SetFocusToField()

SetFocusToField(name, selectText): Promise<void>

Setzt den Eingabecursor in ein bestimmtes Feld und wechselt in den Bearbeitungsmodus.

Parameter

Parameter	Type	Description
`name`	`string`	Anzeigename
`selectText`	`boolean`	Bestimmt ob der bereits bestehende Text des Feldes selektiert wird

Rückgabewert

Promise<void>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7635

SetForeground()

SetForeground(): Promise<void>

Bringt den Dialog in den Vordergrund.

Rückgabewert

Promise<void>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7644

SetVariableContents()

SetVariableContents(name, content): Promise<boolean>

Setzt den aktuellen Inhalt einer Variablen

Parameter

Parameter	Type	Description
`name`	`string`	Anzeigename
`content`	`string`	Neuer Inhalt der Variable Bei Datumsfeldern: YYYYMMDD Bei Datumsfeldern mit Zeitanteil: YYYYMMDDHHMMSS

Rückgabewert

Promise<boolean>

true wenn der Feldwert gesetzt werden konnte, andernfalls false

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7659

Show()

Show(): Promise<void>

Stellt den Dialog im modalen Anzeigemodus dar. Dies verhindert Eingaben in den cRM außerhalb des Dialogs.

Rückgabewert

Promise<void>

Gibt einen Promise | Promise<void> zurück auf denn gewartet werden muss

Example

Die Methode muss wie folgt aufgerufen werden:

await dialogForm.Show();

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7677

ShowModeless()

ShowModeless(): void

Stellt den Dialog im nicht modalen Anzeigemodus dar. Dies erlaubt die Benutzung der Anwendung (z.B. der Ansichten) während der Dialog geöffnet ist.
Hinweis: Die Methode kehrt sofort zurück, Anschließend MUSS das Script auf das Schließen des Dialoges durch den Benutzer aktiv warten
Das Skript muss asynchron ausgeführt werden.

Rückgabewert

void

Example

Die Methode muss wie folgt aufgerufen werden:

dialogForm.ShowModeless();
do
{
	await dialogForm.Delay(500);
}
while(dialogForm.IsShowing);

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7700

Update()

Update(): Promise<void>

Aktualisiert die Ansicht der geladenen Eingabemaske. Dies kann nötig werden um bspw. Mit der Methode DefineComboboxItems(fieldName: string, items: string) neu hinzugefügte Comboboxeinträge zu aktualisieren

Rückgabewert

Promise<void>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7722

[asyncDispose]()

asyncDispose: Promise<void>

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7734

[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

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7742

Implementiert​

Eigenschaften​

DLIPath​

Parameter​

Rückgabewert​

Definiert in​

DialogTitle​

Parameter​

Rückgabewert​

Definiert in​

HeightInPixel​

Parameter​

Rückgabewert​

Definiert in​

IconPath​

Parameter​

Rückgabewert​

Definiert in​

IsDisposed​

Rückgabewert​

Definiert in​

IsShowing​

Rückgabewert​

Definiert in​

ShowResult​

Parameter​

Rückgabewert​

Definiert in​

Sizable​

Parameter​

Rückgabewert​

Definiert in​

SizeToContent​

Parameter​

Rückgabewert​

Definiert in​

WidthInPixel​

Parameter​

Rückgabewert​

Definiert in​

Methoden​

AddTimer()​

AddTimer(name, seconds, action)​

Parameter​

Rückgabewert​

Example​

Definiert in​

AddTimer(name, seconds, action)​

Parameter​

Rückgabewert​

Definiert in​

Close()​

Rückgabewert​

Definiert in​

DefineComboboxItems()​

Parameter​

Rückgabewert​

Definiert in​

DefineFct()​

DefineFct(name, tooltip, causeCloseDialog, action, valueOnClose)​

Parameter​

Rückgabewert​

Example​

Definiert in​

DefineFct(name, tooltip, causeCloseDialog, action, valueOnClose)​

Parameter​

Rückgabewert​

Definiert in​

DefineFctStart()​

Rückgabewert​

Definiert in​

DefineVariable()​

Parameter​

Rückgabewert​

Definiert in​

DefineVariableStart()​

Rückgabewert​

Definiert in​

Delay()​

Parameter​

Implementiert

Eigenschaften

DLIPath

Parameter

Rückgabewert

Definiert in

DialogTitle

Parameter

Rückgabewert

Definiert in

HeightInPixel

Parameter

Rückgabewert

Definiert in

IconPath

Parameter

Rückgabewert

Definiert in

IsDisposed

Rückgabewert

Definiert in

IsShowing

Rückgabewert

Definiert in

ShowResult

Parameter

Rückgabewert

Definiert in

Sizable

Parameter

Rückgabewert

Definiert in

SizeToContent

Parameter

Rückgabewert

Definiert in

WidthInPixel

Parameter

Rückgabewert

Definiert in

Methoden

AddTimer()

AddTimer(name, seconds, action)

Parameter

Rückgabewert

Example

Definiert in

AddTimer(name, seconds, action)

Parameter

Rückgabewert

Definiert in

Close()

Rückgabewert

Definiert in

DefineComboboxItems()

Parameter

Rückgabewert

Definiert in

DefineFct()

DefineFct(name, tooltip, causeCloseDialog, action, valueOnClose)

Parameter

Rückgabewert

Example

Definiert in

DefineFct(name, tooltip, causeCloseDialog, action, valueOnClose)

Parameter

Rückgabewert

Definiert in

DefineFctStart()

Rückgabewert

Definiert in

DefineVariable()

Parameter

Rückgabewert

Definiert in

DefineVariableStart()

Rückgabewert

Definiert in

Delay()

Parameter