DialogForm

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

DialogForm

Extends

• ExtendedCRMObjectBase<DialogForm>

Eigenschaften

_instance

protected _instance: DialogForm;

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

Abgeleitet von

ExtendedCRMObjectBase._instance

---

className

protected readonly className: string;

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

Abgeleitet von

ExtendedCRMObjectBase.className

---

dialogTitleAsync

Abfragesignatur

get dialogTitleAsync(): Promise<string>;

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

Gibt den Dialogtitle zurück

Rückgabewert

Promise<string>

Änderungssignatur

set dialogTitleAsync(value): void;

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

Setzt den Dialogtitle

Parameter

Parameter	Type
value	string

Rückgabewert

void

---

dliPathAsync

Abfragesignatur

get dliPathAsync(): Promise<string>;

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

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

Promise<string>

---

heightInPixelAsync

Abfragesignatur

get heightInPixelAsync(): Promise<number>;

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

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

Rückgabewert

Promise<number>

---

iconPathAsync

Abfragesignatur

get iconPathAsync(): Promise<string>;

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

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

Promise<string>

---

isShowingAsync

Abfragesignatur

get isShowingAsync(): Promise<boolean>;

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

Gibt an, ob der Dialog geöffnet ist

Rückgabewert

Promise<boolean>

---

showResultAsync

Abfragesignatur

get showResultAsync(): Promise<number>;

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

Gibt den in der Methode DialogForm.DefineFct übergebenen Wert des Parameters valueOnClose zurück, insofern der Dialog mit Klick auf diese Schaltfläche geschlossen wird, siehe Parameter causeCloseDialog.

Rückgabewert

Promise<number>

---

sizableAsync

Abfragesignatur

get sizableAsync(): Promise<boolean>;

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

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

Rückgabewert

Promise<boolean>

---

sizeToContentAsync

Abfragesignatur

get sizeToContentAsync(): Promise<boolean>;

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

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

Promise<boolean>

---

widthInPixelAsync

Abfragesignatur

get widthInPixelAsync(): Promise<number>;

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

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

Rückgabewert

Promise<number>

Konstruktoren

Konstruktor

new DialogForm(
   dialogForm, 
   combitCRMVersion, 
   disposeInstance): DialogForm;

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

Parameter

Parameter	Type	Default value
dialogForm	DialogForm	undefined
combitCRMVersion	number | CRMVersion	undefined
disposeInstance	boolean	true

Rückgabewert

DialogForm

Überschreibt

ExtendedCRMObjectBase<CoreCRM.DialogForm>.constructor

Methoden

[asyncDispose]()

asyncDispose: Promise<void>;

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

Rückgabewert

Promise<void>

Abgeleitet von

ExtendedCRMObjectBase.[asyncDispose]

---

[dispose]()

dispose: void;

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

Rückgabewert

void

Abgeleitet von

ExtendedCRMObjectBase.[dispose]

---

addTimerAsync()

addTimerAsync(
   name, 
   intervalInSeconds, 
callback): Promise<void>;

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

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

Parameter

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

Rückgabewert

Promise<void>

Example

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);
});

---

closeAsync()

closeAsync(): Promise<void>;

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

Schließt den Dialog.

Rückgabewert

Promise<void>

---

defineComboboxItemsAsync()

defineComboboxItemsAsync(fieldName, items): Promise<void>;

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

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

Promise<void>

---

defineFctAsync()

defineFctAsync(
   name, 
   tooltip, 
   causeCloseDialog, 
   callback, 
valueOnClose): Promise<void>;

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

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).
callback	(dialogForm, args) => void | 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

Promise<void>

---

defineFctStartAsync()

defineFctStartAsync(): Promise<void>;

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

Initialisiert die Funktionen.

Rückgabewert

Promise<void>

---

defineVariableAsync()

defineVariableAsync(
   name, 
   id, 
   type, 
   length, 
   precision, 
defaultValue): Promise<void>;

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

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

Promise<void>

---

defineVariableStartAsync()

defineVariableStartAsync(): Promise<void>;

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

Initialisiert die Variablen.

Rückgabewert

Promise<void>

---

dispose()

dispose(): void;

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

Rückgabewert

void

Abgeleitet von

ExtendedCRMObjectBase.dispose

---

disposeAsync()

disposeAsync(): Promise<void>;

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

Rückgabewert

Promise<void>

Abgeleitet von

ExtendedCRMObjectBase.disposeAsync

---

getVariableContentsValueByNameAsync()

getVariableContentsValueByNameAsync<T>(type, name): Promise<T>;

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

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

Typenparameter
T extends | string | number | boolean | Date

Parameter

Parameter	Type	Description
type	CLType<T>	CLType des Feldes
name	string	Anzeigename

Rückgabewert

Promise<T>

Inhalt der Variable oder null wenn die Variable nicht angemeldet wurde

Example

const dateValue = dialogForm.getVariableContentsValueByName(CLType.Date, 'dateField');

---

getVariableContentsVariantAsync()

getVariableContentsVariantAsync(name): Promise<unknown>;

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

Liefert den aktuellen Inhalt einer Variablen

Parameter

Parameter	Type	Description
name	string	Anzeigename

Rückgabewert

Promise<unknown>

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

---

guardDisposed()

protected guardDisposed(): void;

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

Wift einen Error, wenn die Instanz bereits freigegeben wurde.

Rückgabewert

void

Throws

Error wenn die Instanz bereits freigegeben wurde.

Abgeleitet von

ExtendedCRMObjectBase.guardDisposed

---

isDisposed()

isDisposed(): boolean;

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

Gibt an, ob die Instanz bereits freigegeben wurde.

Rückgabewert

boolean

true wenn die Instanz bereits freigegeben wurde, andernfalls false.

Abgeleitet von

ExtendedCRMObjectBase.isDisposed

---

layoutAsync()

layoutAsync(): Promise<void>;

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

Ö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 DialogForm.Show verwendet wird, nicht aber bei Methode DialogForm.ShowModless).

Rückgabewert

Promise<void>

---

setDliPathAsync()

setDliPathAsync(value): Promise<void>;

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

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.

Parameter

Parameter	Type
value	string

Rückgabewert

Promise<void>

---

setFocusToFieldAsync()

setFocusToFieldAsync(name, selectText): Promise<void>;

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

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>

---

setForegroundAsync()

setForegroundAsync(): Promise<void>;

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

Bringt den Dialog in den Vordergrund.

Rückgabewert

Promise<void>

---

setHeightInPixelAsync()

setHeightInPixelAsync(value): Promise<void>;

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

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

Parameter

Parameter	Type
value	number

Rückgabewert

Promise<void>

---

setIconPath()

setIconPath(value): Promise<void>;

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

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.

Parameter

Parameter	Type
value	string

Rückgabewert

Promise<void>

---

setShowResultAsync()

setShowResultAsync(value): Promise<void>;

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

Gibt den in der Methode DialogForm.DefineFct übergebenen Wert des Parameters valueOnClose zurück, insofern der Dialog mit Klick auf diese Schaltfläche geschlossen wird, siehe Parameter causeCloseDialog.

Parameter

Parameter	Type
value	number

Rückgabewert

Promise<void>

---

setSizableAsync()

setSizableAsync(value): Promise<void>;

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

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

Parameter

Parameter	Type
value	boolean

Rückgabewert

Promise<void>

---

setSizeToContentAsync()

setSizeToContentAsync(value): Promise<void>;

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

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.

Parameter

Parameter	Type
value	boolean

Rückgabewert

Promise<void>

---

setVariableContentsAsync()

setVariableContentsAsync(name, value): Promise<boolean>;

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

Setzt den aktuellen Inhalt einer Variablen

Parameter

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

Rückgabewert

Promise<boolean>

true wenn der Wert gesetzt werden konnte, andernfalls false

---

setVariableContentsValueAsync()

setVariableContentsValueAsync(name, value): Promise<boolean>;

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

Setzt den aktuellen Inhalt einer Variablen

Parameter

Parameter	Type	Description
name	string	Anzeigename
value	| string | number | boolean | Date	Neuer Inhalt der Variable

Rückgabewert

Promise<boolean>

true wenn der Wert gesetzt werden konnte, andernfalls false

---

setWidthInPixelAsync()

setWidthInPixelAsync(value): Promise<void>;

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

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

Parameter

Parameter	Type
value	number

Rückgabewert

Promise<void>

---

showAsync()

showAsync(): Promise<void>;

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

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

Rückgabewert

Promise<void>

Example

await dialogForm.show();