InputForm
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6509
Eingabemaske
Implementiert
AsyncDisposableDisposable
Eigenschaften
Containers
Abfragesignatur
get Containers(): ListContainers;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6523
Liefert alle Container der Eingabemaske als Objekt vom Typ ListContainers zurück.
Rückgabewert
IsDisposed
Abfragesignatur
get IsDisposed(): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6563
Gibt an, ob das Objekt bereits Freigegeben wurde
Rückgabewert
boolean
ViewName
Abfragesignatur
get ViewName(): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6557
Gibt den Ansichtennamen zurück, auf dem diese Eingabemaske basiert.
Rückgabewert
string
WebElements
Abfragesignatur
get WebElements(): ListWebElements;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6540
Liefert alle Web-Elemente der Eingabemaske als Objekt vom Typ ListWebElements zurück.
Rückgabewert
Methoden
[asyncDispose]()
asyncDispose: Promise<void>;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6846
Standardimplementierung des AsyncDispose Symbols
Rückgabewert
Promise<void>
Implementierung von
AsyncDisposable.[asyncDispose]
[dispose]()
dispose: void;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6857
Standardimplementierung des Dispose Symbols
Rückgabewert
void
Implementierung von
Disposable.[dispose]
ActivateCardPage()
ActivateCardPage(cardPageTitle): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6587
Aktiviert die erste Registerkarte mit dem übergebenen Namen.
Parameter
| Parameter | Type | Description |
|---|---|---|
cardPageTitle | string | Registerkartentitel |
Rückgabewert
boolean
ConvertToLatestVersion()
ConvertToLatestVersion(): void;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6596
Konvertiert die Eingabemasken-Dialogdefinition (Ansichtenname.dli) sowie die etwaige zugehörige WebAccess Eingabemaske (Ansichtenname.web.dli) automatisch in das aktuelle Format.
Rückgabewert
void
DialogSelectRecordDropDown()
Aufrufsignatur
DialogSelectRecordDropDown(recordSet): Record;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6606
Es wird eine Auswahlliste für einen Datensatz aus dem übergebenen (nicht-visuellen!) RecordSet angezeigt und als Record Objekt zurückgegeben. Die Auswahlliste wird als Drop-Down-Auswahlliste analog zur 1:1-relationalen Datensatzauswahl dargestellt
Parameter
| Parameter | Type | Description |
|---|---|---|
recordSet | RecordSet | Das RecordSet, auf dem die Auswahlliste basieren soll. |
Rückgabewert
Aufrufsignatur
DialogSelectRecordDropDown(recordSet, parentControlHandle): Record;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6614
Es wird eine Auswahlliste für einen Datensatz aus dem übergebenen (nicht-visuellen!) RecordSet angezeigt und als Record Objekt zurückgegeben. Die Auswahlliste wird als Drop-Down-Auswahlliste analog zur 1:1-relationalen Datensatzauswahl dargestellt
Parameter
| Parameter | Type | Description |
|---|---|---|
recordSet | RecordSet | Das RecordSet, auf dem die Auswahlliste basieren soll. |
parentControlHandle | number | Handle eines Fensters. Die dargestellte Auswahlliste wird an diesem Fenster ausgerichtet, andernfalls an das Fenster unterhalb der aktuellen Mauszeigerposition |
Rückgabewert
Aufrufsignatur
DialogSelectRecordDropDown(
recordSet,
parentControlHandle,
profileName): Record;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6623
Es wird eine Auswahlliste für einen Datensatz aus dem übergebenen (nicht-visuellen!) RecordSet angezeigt und als Record Objekt zurückgegeben. Die Auswahlliste wird als Drop-Down-Auswahlliste analog zur 1:1-relationalen Datensatzauswahl dargestellt
Parameter
| Parameter | Type | Description |
|---|---|---|
recordSet | RecordSet | Das RecordSet, auf dem die Auswahlliste basieren soll. |
parentControlHandle | number | Handle eines Fensters. Die dargestellte Auswahlliste wird an diesem Fenster ausgerichtet, andernfalls an das Fenster unterhalb der aktuellen Mauszeigerposition |
profileName | string | Unter diesem Profilnamen werden die Einstellungen für den nächsten Aufruf gespeichert. Wird hier ein Feldname angegeben, von welchem aus eine 1:1-Relation wegführt, so teilen sich beide Auswahllisten automatisch ein identisches Erscheinungsbild. |
Rückgabewert
Aufrufsignatur
DialogSelectRecordDropDown(
recordSet,
parentControlHandle,
profileName,
allowUserDefinedSortOrder): Record;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6633
Es wird eine Auswahlliste für einen Datensatz aus dem übergebenen (nicht-visuellen!) RecordSet angezeigt und als Record Objekt zurückgegeben. Die Auswahlliste wird als Drop-Down-Auswahlliste analog zur 1:1-relationalen Datensatzauswahl dargestellt
Parameter
| Parameter | Type | Description |
|---|---|---|
recordSet | RecordSet | Das RecordSet, auf dem die Auswahlliste basieren soll. |
parentControlHandle | number | Handle eines Fensters. Die dargestellte Auswahlliste wird an diesem Fenster ausgerichtet, andernfalls an das Fenster unterhalb der aktuellen Mauszeigerposition |
profileName | string | Unter diesem Profilnamen werden die Einstellungen für den nächsten Aufruf gespeichert. Wird hier ein Feldname angegeben, von welchem aus eine 1:1-Relation wegführt, so teilen sich beide Auswahllisten automatisch ein identisches Erscheinungsbild. |
allowUserDefinedSortOrder | boolean | Bestimmt, ob eine vom Benutzer in diesem Dialog zuletzt eingestellte Sortierung verwendet werden soll( true ) oder die Sortierung des RecordSets verwendet wird( false ). Wird kein Wert übergeben wird die erste Sortierung aktiviert, die in der zum RecordSet gehörenden Ansicht definiert wurde |
Rückgabewert
Dispose()
Dispose(): void;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6851
Standardimplementierung des Dispose
Rückgabewert
void
DisposeAsync()
DisposeAsync(): Promise<void>;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6840
Standardimplementierung des AsyncDispose
Rückgabewert
Promise<void>
GetContentsByFormula()
GetContentsByFormula(formula): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6695
Liefert das Ergebnis einer Formel auf Basis des aktuellen Datensatzes zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
formula | string | Auszuwertende Formel. |
Rückgabewert
string
GetContentsByName()
GetContentsByName(name): string;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6717
Liefert den Inhalt des Feldes als Zeichenkette zurück, dessen physikalischer Feldname übergeben wurde.
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Physikalischer Name des gewünschten Feldes. |
Rückgabewert
string
Inhalt des Feldes oder '' (Leere Zeichenfolge) wenn das Feld nicht vorhanden ist
GetContentsValueByFormula()
GetContentsValueByFormula(formula): unknown;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6705
Liefert das Ergebnis einer Formel auf Basis des aktuellen Datensatzes zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
formula | string | Auszuwertende Formel. |
Rückgabewert
unknown
GetContentsValueByName()
GetContentsValueByName(fieldName): unknown;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6735
Liefert den Inhalt entsprechend des Feldtyps des Feldes zurück, dessen Feldname übergeben wurde, z.B. Datumzeit-Typen als Datumsvariable, numerische Typen als numerische Variable etc.Somit werden bspw. Lokalisierungsprobleme (Komma oder Punkt als Dezimalzeichen? Datumsformatierung?) bei der Weiterverarbeitung des Wertes vermieden.
Parameter
| Parameter | Type | Description |
|---|---|---|
fieldName | string | Physikalischer Name des gewünschten Feldes. |
Rückgabewert
unknown
Inhalt des Feldes oder null wenn das Feld nicht vorhanden ist
Example
const dateValue : Date = inputForm.GetContentsValueByName(CLType.Date,"Datumsfeld");
GetHwndByName()
GetHwndByName(fieldName): number;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6745
Gibt das Handle des übergebenen Feldes zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
fieldName | string | Physikalischer Name des gewünschten Feldes. |
Rückgabewert
number
InvokeContextMenu()
InvokeContextMenu(cardPageTitle, menuId): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6758
Mit dieser Funktion ist es möglich Kontext-Menü-Befehle für ein bestimmtes Feld auszulösen. Die Menü IDs sind im Kapitel "Menü-IDs" dokumentiert.
Parameter
| Parameter | Type | Description |
|---|---|---|
cardPageTitle | string | Physikalischer Name des gewünschten Feldes. |
menuId | number | Menü ID der auszuführenden Aktion |
Rückgabewert
boolean
true der Befehl wurde erfolgreich ausgeführt, andernfalls false
Save()
Save(): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6767
Speichert die Inhalte der Eingabemaske ohne Rückfrage, ob Änderungen gespeichert werden sollen.
Rückgabewert
boolean
SetContentsByName()
SetContentsByName(name, contents): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6780
Legt den Inhalt des Feldes fest, dessen physikalischer Feldname übergeben wurde. Das Setzen eines Primärschlüssels ist möglich, sofern das Schreiben erlaubt ist.
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Physikalischer Name des gewünschten Feldes. |
contents | string | (Neuer) Feldinhalt |
Rückgabewert
boolean
true wenn der Wert gesetzt werden konnte, andernfalls false
SetContentsValueByName()
SetContentsValueByName(fieldName, contents): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6793
Legt den Inhalt des Feldes fest, dessen physikalischer Feldname übergeben wurde. Die übergebene Variable für den Inhalt kann dabei einen zum Feldtyp korrespondierenden Typ haben und muss nicht vorher in eine Zeichenkette umgewandelt werden.Somit werden bspw. Lokalisierungsprobleme (Komma oder Punkt als Dezimalzeichen? Datumsformatierung?) bei der Weiterverarbeitung des Wertes vermieden. Das Setzen eines Primärschlüssels ist möglich, sofern das Schreiben erlaubt ist.
Parameter
| Parameter | Type | Description |
|---|---|---|
fieldName | string | Physikalischer Name des gewünschten Feldes. |
contents | any | (Neuer) Feldinhalt |
Rückgabewert
boolean
true wenn der Wert gesetzt werden konnte, andernfalls false
SetFocusToField()
SetFocusToField(fieldName, selectText): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6804
Diese Methode setzt den Eingabecursor in ein bestimmtes Feld.
Parameter
| Parameter | Type | Description |
|---|---|---|
fieldName | string | Name des gewünschten Feldes |
selectText | number | Wenn SelectText auf 1 (True) gesetzt wurde, wird der bereits existierende Text in dem Feld auch selektiert. |
Rückgabewert
boolean
ShowField()
ShowField(fieldName): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6816
Stellt das übergebene Feld dar, sofern es in der Eingabemaske platziert wurde, ggf. wird hierzu auch eine Karteikarten-Seite umgeschaltet.
Falls das Feld mehrfach platziert wurde, wird das erste Vorkommen dargestellt.
Parameter
| Parameter | Type | Description |
|---|---|---|
fieldName | string | Name des gewünschten Feldes. Zum Anzeigen von Containern muss der Feldname in der Form 'Schlüsselfeld.Zielansicht.Fremdschlüsselfeld' übergeben werden, also z.B.'ID.Kontakte.CompanyID' für den Container mit den Kontakten der Firma. |
Rückgabewert
boolean
Update()
Update(): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6825
Aktualisiert die Eingabemaske und Datenbankinhalte für den aktuellen Datensatz. Es erfolgt keine Veränderung der Position im RecordSet (verglichen mit Update() ).
Rückgabewert
boolean
UpdateAllContainers()
UpdateAllContainers(): boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6834
Führt für alle sichtbaren Container eine Aktualisierung in der Ansicht durch. Der Datensatz der Ansicht selbst wird dabei nicht explizit aktualisiert(siehe Update() ). Der aktuelle Filter und die aktuelle Position innerhalb der Datensätze der Ansicht werden somit nicht verändert.
Rückgabewert
boolean
[hasInstance]()
static hasInstance: boolean;
Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:6865
Symbol.hasInstance welches eine benutzerdefinierte Überprüfung der 'instanceof'-Operation für Objekte ermöglicht.
Parameter
| Parameter | Type |
|---|---|
value | any |
Rückgabewert
boolean