Zum Hauptinhalt springen
Version: 25.346.842.1

InputForm

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

Extends​

Eigenschaften​

_instance​

protected _instance: InputForm;

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

Abgeleitet von​

ExtendedCRMObjectBase._instance

className​

protected readonly className: string;

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

Abgeleitet von​

ExtendedCRMObjectBase.className

containersAsync​

Abfragesignatur​

get containersAsync(): Promise<ListContainers>;

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

Liefert alle Container der Eingabemaske als Objekt vom Typ ListContainers zurück.

Rückgabewert​

Promise<ListContainers>


webElementsAsync​

Abfragesignatur​

get webElementsAsync(): Promise<ListWebElements>;

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

Liefert alle WebElements der Eingabemaske als Objekt vom Typ ListWebElements zurück.

Rückgabewert​

Promise<ListWebElements>

Konstruktoren​

Konstruktor​

new InputForm(
inputForm,
combitCRMVersion,
disposeInstance): InputForm;

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

Parameter​

ParameterTypeDefault value
inputFormInputFormundefined
combitCRMVersionnumber | CRMVersionundefined
disposeInstancebooleantrue

Rückgabewert​

InputForm

Überschreibt​

ExtendedCRMObjectBase<CoreCRM.InputForm>.constructor

Methoden​

[asyncDispose]()​

asyncDispose: Promise<void>;

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

Rückgabewert​

Promise<void>

Abgeleitet von​

ExtendedCRMObjectBase.[asyncDispose]

[dispose]()​

dispose: void;

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

Rückgabewert​

void

Abgeleitet von​

ExtendedCRMObjectBase.[dispose]

activateCardPageAsync()​

activateCardPageAsync(name): Promise<boolean>;

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

Aktiviert die erste Registerkarte mit dem übergebenen Namen.

Parameter​

ParameterTypeDescription
namestringRegisterkartentitel

Rückgabewert​

Promise<boolean>


convertToLatestVersionAsync()​

convertToLatestVersionAsync(): Promise<void>;

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

Konvertiert die Eingabemasken-Dialogdefinition (Ansichtenname.dli) sowie die etwaige zugehörige WebAccess Eingabemaske (Ansichtenname.web.dli) automatisch in das aktuelle Format.

Rückgabewert​

Promise<void>


dialogSelectRecordDropDownAsync()​

dialogSelectRecordDropDownAsync(recordSet, options?): Promise<Record>;

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

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​

ParameterTypeDescription
recordSetRecordSetDas RecordSet, auf dem die Auswahlliste basieren soll.
options?{ allowUserDefinedSortOrder?: boolean; parentControlHandle?: number; profileName?: string; }Optionen
options.allowUserDefinedSortOrder?booleanVoreinstellung: true 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
options.parentControlHandle?numberVoreinstellung: 0 Handle eines Fensters. Die dargestellte Auswahlliste wird an diesem Fenster ausgerichtet, andernfalls an das Fenster unterhalb der aktuellen Mauszeigerposition
options.profileName?stringUnter 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​

Promise<Record>


dispose()​

dispose(): void;

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

Rückgabewert​

void

Abgeleitet von​

ExtendedCRMObjectBase.dispose

disposeAsync()​

disposeAsync(): Promise<void>;

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

Rückgabewert​

Promise<void>

Abgeleitet von​

ExtendedCRMObjectBase.disposeAsync

getContentsByNameAsync()​

getContentsByNameAsync(name): Promise<string>;

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

Liefert den Inhalt des Feldes als Zeichenkette zurück, dessen physikalischer Feldname übergeben wurde.

Parameter​

ParameterTypeDescription
namestringPhysikalischer Name des gewünschten Feldes.

Rückgabewert​

Promise<string>

Inhalt des Feldes oder ''(leerer String) wenn das Feld nicht vorhanden ist


getContentsValueByNameAsync()​

getContentsValueByNameAsync<T>(clType, name): Promise<T>;

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

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.

Type Parameters​

Typenparameter
T extends | string | number | boolean | Date

Parameter​

ParameterTypeDescription
clTypeCLType<T>Generischer Parameter. Der Wert muss einem Wert von CLType entsprechen
namestringPhysikalischer Name des gewünschten Feldes.

Rückgabewert​

Promise<T>

Inhalt des Feldes oder null wenn das Feld nicht vorhanden ist


getHwndByNameAsync()​

getHwndByNameAsync(fieldName): Promise<number>;

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

Gibt das Handle des übergebenen Feldes zurück.

Parameter​

ParameterTypeDescription
fieldNamestringPhysikalischer Name des gewünschten Feldes.

Rückgabewert​

Promise<number>


guardDisposed()​

protected guardDisposed(): void;

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

Wift einen Error, wenn die Instanz bereits freigegeben wurde.

Rückgabewert​

void

Throws​

Error wenn die Instanz bereits freigegeben wurde.

Abgeleitet von​

ExtendedCRMObjectBase.guardDisposed

invokeContextMenuAsync()​

invokeContextMenuAsync(name, action): Promise<boolean>;

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

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​

ParameterTypeDescription
namestringPhysikalischer Name des gewünschten Feldes.
actionnumberMenü ID der auszuführenden Aktion

Rückgabewert​

Promise<boolean>

true der Befehl wurde erfolgreich ausgeführt, andernfalls false


isDisposed()​

isDisposed(): boolean;

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

Gibt an, ob die Instanz bereits freigegeben wurde.

Rückgabewert​

boolean

true wenn die Instanz bereits freigegeben wurde, andernfalls false.

Abgeleitet von​

ExtendedCRMObjectBase.isDisposed

saveAsync()​

saveAsync(): Promise<boolean>;

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

Speichert die Inhalte der Eingabemaske ohne Rückfrage, ob Änderungen gespeichert werden sollen.

Rückgabewert​

Promise<boolean>


setContentsByNameAsync()​

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

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

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​

ParameterTypeDescription
namestringPhysikalischer Name des gewünschten Feldes.
valuestring(Neuer) Feldinhalt

Rückgabewert​

Promise<boolean>

true wenn der Wert gesetzt werden konnte, andernfalls false


setContentsValueByNameAsync()​

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

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

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​

ParameterTypeDescription
namestringPhysikalischer Name des gewünschten Feldes.
value| string | number | boolean | Date(Neuer) Feldinhalt

Rückgabewert​

Promise<boolean>

true wenn der Wert gesetzt werden konnte, andernfalls false


setFocusToFieldAsync()​

setFocusToFieldAsync(fieldName, selectText): Promise<boolean>;

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

Diese Methode setzt den Eingabecursor in ein bestimmtes Feld.

Parameter​

ParameterTypeDescription
fieldNamestringName des gewünschten Feldes
selectTextbooleanWenn SelectText auf true gesetzt wurde, wird der bereits existierende Text in dem Feld auch selektiert.

Rückgabewert​

Promise<boolean>


showFieldAsync()​

showFieldAsync(fieldName): Promise<boolean>;

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

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​

ParameterTypeDescription
fieldNamestringName 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​

Promise<boolean>


updateAllContainersAsync()​

updateAllContainersAsync(): Promise<boolean>;

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

Führt für alle sichtbaren Container eine Aktualisierung in der Ansicht durch. Der Datensatz der Ansicht selbst wird dabei nicht explizit aktualisiert(siehe View.update). Der aktuelle Filter und die aktuelle Position innerhalb der Datensätze der Ansicht werden somit nicht verändert.

Rückgabewert​

Promise<boolean>


updateAsync()​

updateAsync(): Promise<boolean>;

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

Aktualisiert die Eingabemaske und Datenbankinhalte für den aktuellen Datensatz. Es erfolgt keine Veränderung der Position im RecordSet (verglichen mit View.update).

Rückgabewert​

Promise<boolean>