@ctodev/cclibrary-typings

import { TccKeyValuePair, TccPrimitiveValue } from "../../../../../odata/models/shared.model"; import { TccClientClassBase } from "./tcc-client-class-base"; import { TccSingularity } from "../tcc-singularity"; export declare class TccClientFields extends TccClientClassBase { private fieldCache; constructor(singularity: TccSingularity); private getField; /** * Gibt die Anzahl der Felder in der Indexierungsmaske zurück – inkl. unsichtbarer Felder. */ get Count(): number; /** * Gibt den technischen Namen des aktiven Feldes zurück oder setzt den Fokus auf das angegebene Feld. */ get Focused(): string; /** * Gibt den technischen Namen des aktiven Feldes zurück oder setzt den Fokus auf das angegebene Feld. */ set Focused(fieldName: string); /** * AddToSelectionList fügt einen neuen Listeneintrag in die Auswahlliste des angegebenen Feldes ein. Field ist dabei entweder die Id oder der technische Name des Feldes. Das in Field angegebene Feld muss vom Typ „Combobox“ sein. * ++ * @param {string} field - fieldpath * @param {string} value - selectionoption to add * @returns {boolean} - success */ AddToSelectionList(field: string, value: string): boolean; /** * AddToSelectionListExt fügt einen neuen Listeneintrag, inkl. internem Meaning, in die Auswahlliste des angegebenen Feldes ein. Field ist dabei entweder die Id oder der technische Name des Feldes. Das in Field angegebene Feld muss vom Typ „Combobox“ sein. * @param {string} field - fieldpath * @param {string} value - selectionoption to add * @param {string} meaning - selectionoption meaning to add * @returns {boolean} - success */ AddToSelectionListExt(field: string, value: string, meaning: string): boolean; /** * ClearSelectionList löscht den Inhalt der Auswahlliste im angegebenen Feld. Field ist dabei entweder die Id oder der technische Name des Feldes. Das in Field angegebene Feld muss vom Typ „Combobox“ sein. * ++ * @param {string} field - fieldpath * @returns {boolean} - success */ ClearSelectionList(field: string): boolean; /** * Die Funktion Exists prüft ob das angegebene Feld im Schema vorhanden ist. Im Ergebnis wird true oder false zurückgegeben. Field ist dabei entweder die Id oder der technische Name des Feldes. * @param {string} field - fieldpath * @returns {boolean} - success */ Exists(field: string): boolean; /** * GetConfidence liefert den „Vertrauenswert“ des Feldes zurück. Der Wert liegt zwischen 0 und 100 Field ist dabei entweder die Id oder der technische Name des Feldes. Der Vertrauenswert entsteht i.d.R. bei einer vorherigen Belegerkennung / OCR. * @param {string} field - fieldpath * @returns {number} - confidence value */ GetConfidence(field: string): number; /** * GetDisplayText gibt den Anzeigetext des in Field angegebenen Feldes in der aktuellen Anmeldesprache zurück. Field ist dabei entweder die Id oder der technische Name des Feldes. * @param {string} field - fieldpath * @returns {string} - display text */ GetDisplayText(field: string): string; /** * GetLastValue gibt den zuletzt eingegebenen Inhalt des in Field angegebenen Feldes zurück. Field ist dabei entweder die ID oder der technische Name des Feldes. Das Ergebnis wird im entsprechenden Typ des Feldes zurück geliefert. Also zum Beispiel ein Wert vom Typ „Datum“. „Float“ oder „WideString“. * @param {string} field - fieldpath * @returns {TccPrimitiveValue} - last value */ GetLastValue(field: string): TccPrimitiveValue; /** * GetName ermittelt den technischen Namen des in FieldIndex angegebenen Feldes. Liegt der FieldIndex außerhalb des gültigen Bereichs ist das Ergebnis leer. * @param {number} fieldIndex - fieldindex * @returns {string} - fieldpath */ GetName(fieldIndex: number): string; /** * GetPropertyValue liefert den Eigenschaftswert von Property des Feldes Fields zurück. Field ist dabei entweder die Id oder der technische Name des Feldes. * @param {string} field - fieldpath * @param {string} property - propertyname * @returns {any} - property value */ GetPropertyValue(field: string, property: "name" | "enabled" | "visible" | "mandatory"): any; /** * GetRawValue gibt den nicht aufbereiteten Inhalt des in Field angegebenen Feldes als WideString zurück. Field ist dabei entweder die Id oder der technische Name des Feldes. * @param {string} field - fieldpath * @returns {string} - raw value */ GetRawValue(field: string): string; /** * GetSelectionList gibt die Auswahlliste des angegebenen Feldes zurück. Field ist dabei entweder die Id oder der technische Name des Feldes. Über GetDisplayText kann entweder der Anzeigename oder das entsprechende Meaning der Listeneinträge in der aktuellen Sprache ermittelt werden. Bei GetFromUI = True werden direkt die Werte aus der Anwenderoberfläche entnommen. Das in Field angegebene Feld muss vom Typ „Combobox“ sein. * @param {string} field - fieldpath * @param {boolean} getDisplayText - getDisplayText * @param {boolean} getFromUI - getFromUI * @returns {TccKeyValuePair[]} - Selectionlist */ GetSelectionList(field: string, getDisplayText: boolean, getFromUI: boolean): TccKeyValuePair[]; /** * GetValue gibt den Inhalt des in Field angegebenen Feldes zurück. Field ist dabei entweder die Id oder der technische Name des Feldes. Das Ergebnis wird im entsprechenden Typ des Feldes zurückgeliefert. Also zum Beispiel ein Wert vom Typ „Datum“. „Float“ oder „WideString“. * ++ * @param {string} field - fieldpath * @returns {TccPrimitiveValue} - typed value */ GetValue(field: string): TccPrimitiveValue; /** * SetConfidence setzt den „Vertrauenswert“ des angegebenen Feldes. Confidence liegt zwischen 0 und 100. Field ist dabei entweder die Id oder der technische Name des Feldes. Der Confidence Wert kann auch in einer nachgelagerten WARP Verarbeitung ausgewertet werden. * @param {string} field - fieldpath * @param {number} confidence - confidence value to set * @returns {boolean} - success */ SetConfidence(field: string, confidence: number): boolean; /** * SetDisplayText setzt den Anzeigetext des in Field angegebenen Feldes. * ++ * @param {string} field - fieldpath * @param {string} text - new display text * @returns {boolean} - success */ SetDisplayText(field: string, text: string): boolean; /** * SetLastValue setzt den zuletzt angegebenen Inhalt des angegeben Feldes. Field ist dabei entweder die Id oder der technische Name des Feldes. * @param {string} field - fieldpath * @param {TccPrimitiveValue} value - last value to set * @returns {boolean} - success */ SetLastValue(field: string, value: TccPrimitiveValue): boolean; /** * SetProperties setzt die Eigenschaften Enabled und Visible des angegebenen Feldes. Field ist dabei entweder die Id oder der technische Name des Feldes. * @param {string} field - fieldpath * @param {boolean} enabled - enabled property * @param {boolean} visible - visible property * @returns {boolean} - success */ SetProperties(field: string, enabled: boolean, visible: boolean): boolean; /** * SetState setzt das Feld auf einen der vier verfügbaren Status (TccFieldState). Field ist dabei entweder die Id oder der technische Name des Feldes. Der Benutzer sieht die angegebene Meldung beim Betreten des entsprechenden Indexfelds. * @param {string} field - fieldpath * @param {any} state - field state * @param {string} message - message * @returns {boolean} - success */ SetState(field: string, state: any, message: string): boolean; /** * SetValue setzt den Inhalt des angegeben Feldes. Field ist dabei entweder die Id oder der technische Name des Feldes. Der Wert muss dabei im entsprechenden Typ des Zielfeldes übergeben werden. Ansonsten wird versucht eine automatische Typumwandlung vorzunehmen. * ++ * @param {string} field - fieldpath * @param {TccPrimitiveValue} value - value * @returns {boolean} - success */ SetValue(field: string, value: TccPrimitiveValue): boolean; }