Version: 25.143.1202.1

DialogForm

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4176

DialogForm

Implementiert

AsyncDisposable
Disposable

Eigenschaften

DialogTitle

Abfragesignatur

get DialogTitle(): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4190

Setzt den Dialogtitel oder liefert ihn zurück.

Rückgabewert

string

Änderungssignatur

set DialogTitle(val): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4198

Setzt den Dialogtitel oder liefert ihn zurück.

Parameter

Parameter	Type
`val`	`string`

Rückgabewert

void

DLIPath

Abfragesignatur

get DLIPath(): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4207

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.

Rückgabewert

string

Änderungssignatur

set DLIPath(val): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4216

Parameter

Parameter	Type
`val`	`string`

Rückgabewert

void

HeightInPixel

Abfragesignatur

get HeightInPixel(): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4242

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

Rückgabewert

number

Änderungssignatur

set HeightInPixel(val): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4250

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

Parameter

Parameter	Type
`val`	`number`

Rückgabewert

void

IconPath

Abfragesignatur

get IconPath(): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4225

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.

Rückgabewert

string

Änderungssignatur

set IconPath(val): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4234

Parameter

Parameter	Type
`val`	`string`

Rückgabewert

void

IsDisposed

Abfragesignatur

get IsDisposed(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4332

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean

IsShowing

Abfragesignatur

get IsShowing(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4310

Gibt an, ob der Dialog geöffnet ist

Rückgabewert

boolean

ShowResult

Abfragesignatur

get ShowResult(): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4258

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

Rückgabewert

number

Änderungssignatur

set ShowResult(val): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4266

Parameter

Parameter	Type
`val`	`number`

Rückgabewert

void

Sizable

Abfragesignatur

get Sizable(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4274

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

Rückgabewert

boolean

Änderungssignatur

set Sizable(val): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4282

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

void

SizeToContent

Abfragesignatur

get SizeToContent(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4292

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.

Rückgabewert

boolean

Änderungssignatur

set SizeToContent(val): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4302

Parameter

Parameter	Type
`val`	`boolean`

Rückgabewert

void

WidthInPixel

Abfragesignatur

get WidthInPixel(): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4319

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

Rückgabewert

number

Änderungssignatur

set WidthInPixel(val): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4327

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

Parameter

Parameter	Type
`val`	`number`

Rückgabewert

void

Methoden

[asyncDispose]()

asyncDispose: Promise<void>;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4627

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

[dispose]()

dispose: void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4638

Standardimplementierung des Dispose Symbols

Rückgabewert

void

Implementierung von

Disposable.[dispose]

AddTimer()

Aufrufsignatur

AddTimer(
   name, 
   seconds, 
   action): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4373

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);
function runTimer(dialog: DialogForm)
{
	cRM.DialogMessageBox("Timer 1:\nTimer 1 wurde ausgeführt (5 Sekunden)",dialog.DialogTitle, 0);
}
//Oder alternativ Inline
dialogForm.AddTimer("timer1", 5, (dialog: DialogForm) => {
	cRM.DialogMessageBox("Timer 1:\nTimer 1 wurde ausgeführt (5 Sekunden)",dialog.DialogTitle, 0);
});

Aufrufsignatur

AddTimer(
   name, 
   seconds, 
   action): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4382

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

Close()

Close(): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4394

Schließt den Dialog.

Rückgabewert

void

DefineComboboxItems()

DefineComboboxItems(fieldName, items): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4405

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

number

DefineFct()

Aufrufsignatur

DefineFct(
   name, 
   tooltip, 
   causeCloseDialog, 
   action, 
   retValOnClose): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4434

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
`retValOnClose`	`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);
function executeButton1(dialog: DialogForm){
{
	cRM.DialogMessageBox("Schaltfläche 1:\nSchaltfläche 1 wurde ausgeführt",dialog.DialogTitle, 0);
}
//Oder alternativ Inline
dialogForm.DefineFct("button1","ToolTip von Button1", false, (dialog: DialogForm) => {
	cRM.DialogMessageBox("Schaltfläche 1:\nSchaltfläche 1 wurde ausgeführt",dialog.DialogTitle, 0);
}, 1);

Aufrufsignatur

DefineFct(
   name, 
   tooltip, 
   causeCloseDialog, 
   action, 
   retValOnClose): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4445

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
`retValOnClose`	`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

DefineFctStart()

DefineFctStart(): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4457

Initialisiert die Funktionen.

Rückgabewert

void

DefineVariable()

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

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4475

Meldet ein Eingabefeld an.

Parameter

Parameter	Type	Description
`name`	`string`	Anzeigename
`id`	`number`	ID
`type`	`string`	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

DefineVariableStart()

DefineVariableStart(): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4484

Initialisiert die Variablen.

Rückgabewert

void

Delay()

Delay(milliseconds): Promise<void>;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4606

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

Dispose()

Dispose(): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4632

Standardimplementierung des Dispose

Rückgabewert

void

DisposeAsync()

DisposeAsync(): Promise<void>;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4621

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>

GetVariableContents()

GetVariableContents(name): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4496

Liefert den aktuellen Inhalt einer Variabel

Parameter

Parameter	Type	Description
`name`	`string`	Anzeigename.

Rückgabewert

string

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

GetVariableContentsVariant()

GetVariableContentsVariant(name): unknown;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4508

Liefert den aktuellen Inhalt einer Variabel

Parameter

Parameter	Type	Description
`name`	`string`	Anzeigename.

Rückgabewert

unknown

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

Layout()

Layout(): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4517

Ö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

void

SetFocusToField()

SetFocusToField(name, selectText): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4528

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

number

SetForeground()

SetForeground(): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4537

Bringt den Dialog in den Vordergrund.

Rückgabewert

void

SetVariableContents()

SetVariableContents(name, content): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4552

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

number

true wenn der Feldwert gesetzt werden konnte, andernfalls false

Show()

Show(): Promise<void>;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4570

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:

dialogForm.Show();

ShowModeless()

ShowModeless(): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4593

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
{
	dialogForm.Delay(500);
}
while(dialogForm.IsShowing);

Update()

Update(): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4615

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

void

[hasInstance]()

static hasInstance: boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v12.ts:4646

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

Parameter

Parameter	Type
`value`	`any`

Rückgabewert

boolean

Implementiert​

Eigenschaften​

DialogTitle​

Abfragesignatur​

Rückgabewert​

Änderungssignatur​

Parameter​

Rückgabewert​

DLIPath​

Abfragesignatur​

Rückgabewert​

Änderungssignatur​

Parameter​

Rückgabewert​

HeightInPixel​

Abfragesignatur​

Rückgabewert​

Änderungssignatur​

Parameter​

Rückgabewert​

IconPath​

Abfragesignatur​

Rückgabewert​

Änderungssignatur​

Parameter​

Rückgabewert​

IsDisposed​

Abfragesignatur​

Rückgabewert​

IsShowing​

Abfragesignatur​

Rückgabewert​

ShowResult​

Abfragesignatur​

Rückgabewert​

Änderungssignatur​

Parameter​

Rückgabewert​

Sizable​

Abfragesignatur​

Rückgabewert​

Änderungssignatur​

Parameter​

Rückgabewert​

SizeToContent​

Abfragesignatur​

Rückgabewert​

Änderungssignatur​

Parameter​

Rückgabewert​

WidthInPixel​

Abfragesignatur​

Rückgabewert​

Änderungssignatur​

Parameter​

Rückgabewert​

Methoden​

[asyncDispose]()​

Rückgabewert​

Implementierung von​

[dispose]()​

Rückgabewert​

Implementierung von​

AddTimer()​

Aufrufsignatur​

Parameter​

Rückgabewert​

Example​

Aufrufsignatur​

Parameter​

Rückgabewert​

Close()​

Rückgabewert​

DefineComboboxItems()​

Parameter​

Rückgabewert​

DefineFct()​

Aufrufsignatur​

Parameter​

Rückgabewert​

Implementiert

Eigenschaften

DialogTitle

Abfragesignatur

Rückgabewert

Änderungssignatur

Parameter

Rückgabewert

DLIPath

Abfragesignatur

Rückgabewert

Änderungssignatur

Parameter

Rückgabewert

HeightInPixel

Abfragesignatur

Rückgabewert

Änderungssignatur

Parameter

Rückgabewert

IconPath

Abfragesignatur

Rückgabewert

Änderungssignatur

Parameter

Rückgabewert

IsDisposed

Abfragesignatur

Rückgabewert

IsShowing

Abfragesignatur

Rückgabewert

ShowResult

Abfragesignatur

Rückgabewert

Änderungssignatur

Parameter

Rückgabewert

Sizable

Abfragesignatur

Rückgabewert

Änderungssignatur

Parameter

Rückgabewert

SizeToContent

Abfragesignatur

Rückgabewert

Änderungssignatur

Parameter

Rückgabewert

WidthInPixel

Abfragesignatur

Rückgabewert

Änderungssignatur

Parameter

Rückgabewert

Methoden

[asyncDispose]()

Rückgabewert

Implementierung von

[dispose]()

Rückgabewert

Implementierung von

AddTimer()

Aufrufsignatur

Parameter

Rückgabewert

Example

Aufrufsignatur

Parameter

Rückgabewert

Close()

Rückgabewert

DefineComboboxItems()

Parameter

Rückgabewert

DefineFct()

Aufrufsignatur

Parameter

Rückgabewert