DialogForm
DialogForm
Implementiert
AsyncDisposableDisposable
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
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 |
|---|---|
val | string |
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4611
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
combitCRM.SDK.WindowsClient.v13.ts:4594
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
combitCRM.SDK.WindowsClient.v13.ts:4646
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
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 |
|---|---|
val | string |
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4629
IsDisposed
get IsDisposed(): boolean
Gibt an, ob das Objekt bereits Freigegeben wurde
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4736
IsShowing
get IsShowing(): boolean
Gibt an, ob der Dialog geöffnet ist
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4714
ShowResult
get ShowResult(): number
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.
set ShowResult(val): void
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.
Parameter
| Parameter | Type |
|---|---|
val | number |
Rückgabewert
number
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4662
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
combitCRM.SDK.WindowsClient.v13.ts:4678
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
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 |
|---|---|
val | boolean |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4696
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
combitCRM.SDK.WindowsClient.v13.ts:4723
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);
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);
});
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4777
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
combitCRM.SDK.WindowsClient.v13.ts:4786
Close()
Close(): void
Schließt den Dialog.
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4798
DefineComboboxItems()
DefineComboboxItems(fieldName, items): number
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
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4809
DefineFct()
DefineFct(name, tooltip, causeCloseDialog, action, retValOnClose)
DefineFct(
name,
tooltip,
causeCloseDialog,
action,
retValOnClose): 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 |
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);
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4838
DefineFct(name, tooltip, causeCloseDialog, action, retValOnClose)
DefineFct(
name,
tooltip,
causeCloseDialog,
action,
retValOnClose): 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 |
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
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4849
DefineFctStart()
DefineFctStart(): void
Initialisiert die Funktionen.
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4861
DefineVariable()
DefineVariable(
name,
id,
type,
length,
precision,
defaultValue): void
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
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4879
DefineVariableStart()
DefineVariableStart(): void
Initialisiert die Variablen.
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4888
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
combitCRM.SDK.WindowsClient.v13.ts:5010
Dispose()
Dispose(): void
Standardimplementierung des Dispose
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5036
DisposeAsync()
DisposeAsync(): Promise<void>
Standardimplementierung des AsyncDispose
Rückgabewert
Promise<void>
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5025
GetVariableContents()
GetVariableContents(name): string
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
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4900
GetVariableContentsVariant()
GetVariableContentsVariant(name): unknown
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
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4912
Layout()
Layout(): 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
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4921
SetFocusToField()
SetFocusToField(name, selectText): number
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
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4932
SetForeground()
SetForeground(): void
Bringt den Dialog in den Vordergrund.
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4941
SetVariableContents()
SetVariableContents(name, content): number
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
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4956
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:
dialogForm.Show();
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4974
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
{
dialogForm.Delay(500);
}
while(dialogForm.IsShowing);
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4997
Update()
Update(): 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
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5019
[asyncDispose]()
asyncDispose: Promise<void>
Standardimplementierung des AsyncDispose Symbols
Rückgabewert
Promise<void>
Implementierung von
AsyncDisposable.[asyncDispose]
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5031
[dispose]()
dispose: void
Standardimplementierung des Dispose Symbols
Rückgabewert
void
Implementierung von
Disposable.[dispose]
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5042
[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
combitCRM.SDK.WindowsClient.v13.ts:5050