import { TccClientClassBase } from "./tcc-client-class-base"; import { TccField } from "../Infinity/tcc-field"; import { TccSingularity } from "../tcc-singularity"; import { TccTableField } from "../Infinity/tcc-table-field"; export declare class TccClientApplication extends TccClientClassBase { constructor(singularity: TccSingularity); /** * New * CurrentField * @returns {TccField} Field object of currently active field */ get CurrentField(): TccField | TccTableField; /** * AllowErrorRelease * Mit der Eigenschaft AllowErrorRelease kann im Feld-Event „EventOnRelease“ die Freigabeverhinderung aufgehoben werden. */ set AllowErrorRelease(bool: boolean); get AllowErrorRelease(): boolean; /** * AllowExecuteUserexit * Mit der Eigenschaft AllowExecuteUserexit kann im Feld-Event „EventOnUserexit“ die Ausführung von Userexits gesteuert werden. Zum Beispiel könnte auf Grund von Feldinhalten die Ausführung verhindert werden. */ set AllowExecuteUserexit(bool: boolean); get AllowExecuteUserexit(): boolean; /** * AutoImportPath * AutoImportPath gibt den an der Anwendung konfigurierten Automatischen Importpfad zurück. */ get AutoImportPath(): string; /** * BatchMode * Gibt den aktuellen Status der Applikation zurück in Bezug auf die Ausführung einer automatischen Stapel-Erkennung. */ get BatchMode(): boolean; /** * Id * Id gibt die aktuelle QHIX-Application-Id zurück. */ get Id(): string; /** * Language * Language gibt die aktuelle Anmeldesprache zurück. Zum Beispiel „DE“. */ get Language(): string; /** * Name * Name gibt den aktuellen QHIX-Anwendungsnamen zurück. */ get Name(): string; /** * Version * Version gibt die aktuelle Datei-Version des Clients zurück. */ get Version(): string; /** * WorkStack * Über die Eigenschaft WorkStack kann die aktuelle Arbeitsumgebung ermittelt werden: * ccWS_Stack * ccWS_Reserve * ccWS_Tacks */ get WorkStack(): string; /** * CancelTacks * Die Funktion ccApplication.CancelTacks hebt alle in der Liste übergebenen Heftungen auf und stellt die enthaltenen Blobs in den Stapel. Im Ergebnis wird die Anzahl der tatsächlich aufgehobenen Heftungen zurückgegeben. * @param {string[]} Tacks - Liste von Heftungs-Id * @returns {number} - count of canceled tacks */ CancelTacks(Tacks: string[]): number; /** * ChangeBlob * Die Funktion ändert das angegebene Blob mit der Id BlobId indem es den Status und die zugehörige HeftungsId anpassen kann. Mit dieser Funktion können zum Beispiel Blobs vom Stapel in die Rückstellung gestellt werden. * @param {string} BlobId - Id des Blobs * @param {number} State - neuer Status des Blobs ccQS_IDLE ccQS_OnHold * @param {string} TackId - Id der Heftung * @returns {boolean} - success */ ChangeBlob(BlobId: string, State: number, TackId: string): boolean; /** * CloseStatus * Die Funktion schließt das Statusfenster. * @returns {boolean} - success */ CloseStatus(): boolean; /** * CreateTack * Die Funktion erzeugt eine neue Heftung aus allen im Bereich Stapel markierten Dokumente. Im Erfolgsfall wird im Ergebnis true zurückgegeben. Im Fehlerfall false. TackId ist derzeit noch ungenutzt. * @param {string} TackId - Id der Heftung * @returns {boolean} - success */ CreateTack(TackId: string): boolean; /** * DeleteBlob * Die Funktion löscht das angegebene Blob mit der Id BlobId. Im Erfolgsfall wird im Ergebnis true zurückgegeben. Im Fehlerfall false. * @param {string} BlobId - Id des Blobs * @returns {boolean} - success */ DeleteBlob(BlobId: string): boolean; /** * DeleteTacks * Die Funktion ccApplication.DeleteTacks löscht alle in der Liste übergebenen Heftungen. Im Ergebnis wird die Anzahl der tatsächlich gelöschten Heftungen zurückgegeben. * @param {any} Tacks - Liste von Heftungs-Id * @returns {boolean} - success */ DeleteTacks(Tacks: any): boolean; /** * DisableDesktop * DisableDesktop sperrt den Desktop für Benutzereingaben. */ DisableDesktop(): any; /** * EnableDesktop * EnableDesktop gibt den Desktop des Benutzers zur Bearbeitung frei. */ EnableDesktop(): any; /** * ExecuteUserExit * Die Funktion führt den Userexit im angegebenen Feld aus. Field ist dabei die Id des Feldes. Entsprechende Feldevents werden dabei ebenfalls ausgeführt. * @param {number} Field - Feldindex * @returns {boolean} - success */ ExecuteUserExit(Field: number): boolean; /** * Export * Die Funktion Export exportiert das über TackId angegebene Dokument. Bleibt TackId leer oder wird nicht angegeben, werden alle vorhandenen Heftungen exportiert. Im Ergebnis wird die Anzahl der erfolgreich exportierten Dokumente zurückgeliefert. * @param {string} TackId - Heftungsid * @param {boolean} ShowStatus - Status anzeigen * @returns {number} - Anzahl exportierter Elemente */ Export(TackId?: string, ShowStatus?: boolean): number; /** * ExportBlobs * Die Funktion ExportBlobs exportiert alle in BlobIdList angegebenen Blobs nach TargetPath. * @param {any} BlobIdList - Liste von Blobids * @param {string} TargetPath - Zielpfad * @returns {number} - Anzahl exportierter Elemente */ ExportBlobs(BlobIdList: any, TargetPath: string): number; /** * ExportDocuments * Die Funktion ExportDocuments exportiert alle in DocIdList angegebenen Dokumente nach TargetPath. * @param {any} DocIdList - Liste von DocIds * @param {string} TargetPath - Zielpfad * @returns {number} - Anzahl exportierter Elemente */ ExportDocuments(DocIdList: any, TargetPath: string): number; /** * GetBlobFileName * Die Funktion gibt den kompletten Pfad inkl. Dateiname und Extension des Blobs mit der Id BlobId zurück. * @param {string} BlobId - Id des Blobs * @returns {string} - Dateipfad des Blobs */ GetBlobFileName(BlobId: string): string; /** * GetBlobList * Die Funktion ermittelt eine entsprechende Liste von BlobId‘s aus den gegebenen Selektionskriterien. Im Ergebnis wird ein Variantenarray mit den entsprechenden Id‘s zurückgeliefert. * @param {string} Stack - Stapel * @param {boolean} Selected - Nur die vom User selektierten zurückgeben * @param {string} TackId - Nur in der Heftung suchen * @returns {string[]} - Liste von BlobIds */ GetBlobList(Stack: string, Selected: boolean, TackId?: string): string[]; /** * GetBlobName * Die Funktion gibt den Anzeigenamen des Blobs mit der Id BlobId zurück. * @param {string} BlobId - BlobId * @returns {string} - Blobname */ GetBlobName(BlobId: string): string; /** * GetBlobOrgFileName * Die Funktion gibt den kompletten Quell-Pfad inkl. Dateiname und Extension des Blobs mit der Id BlobId zurück. Gilt nur für den Betrieb im eWork BatchServer. Am Client ist die Funktion identisch mit GetBlobFileName. * @param {string} BlobId - BlobId * @returns {string} - OrgFileName */ GetBlobOrgFileName(BlobId: string): string; /** * GetCurrentBlobId * Die Funktion gibt die jeweilige BlobId als String aus. * @returns {string} - BlobId */ GetCurrentBlobId(): string; /** * GetCurrentPageNum * Über die Funktion kann die Seitennummer beginnend bei 0 des aktuellen Dokuments abgefragt werden. * @returns {number} - Pagenumber */ GetCurrentPageNum(): number; /** * GetCurrentTackId * Diese Funktion gibt die HeftungsId des aktuellen Dokuments zurück. * @returns {string} - Heftungsid */ GetCurrentTackId(): string; /** * GetTackList * Gibt eine Liste aller Heftungs-Id's zurück. Bei der Option Selected = true werden nur die jeweils ausgewählten Id's zurückgegeben. * @param {boolean} Selected - nur ausgewählte Heftungen * @returns {any} - Heftungsids */ GetTackList(Selected?: boolean): any; /** * ImportBlobs * Die Funktion ImportBlobs importiert alle über Path gefundenen Blobs in den in Stack angegebenen Stapel. FileAge ist das min. Dateialter in Minuten – 0 importiert alle Dateien unabhängig von Ihrem Alter. Recursive bezieht bei true alle Unterordner mit ein. Ist DeleteSource true, werden alle importierten Dateien aus dem Ursprungsverzeichnis gelöscht. * @param {string} Stack - Stapel * @param {string} Path - Dateipfad * @param {number} FileAge - Dateialter * @param {boolean} Recursive - Rekursiv * @param {boolean} DeleteSource - Datei löschen nach import * @returns {boolean} - success */ ImportBlobs(Stack: string, Path: string, FileAge: number, Recursive: boolean, DeleteSource: boolean): boolean; /** * ImportDocuments * Die Funktion ImportDocuments importiert Dokumente in den in Stack angegebenen Stapel. FileAge ist das min. Dateialter in Minuten – 0 importiert alle Dateien unabhängig von Ihrem Alter. Recursive bezieht bei true alle Unterordner mit ein. Ist DeleteSource true, werden alle importierten Dateien aus dem Ursprungsverzeichnis gelöscht. * @param {string} SourcePath - Dateipfad * @param {number} FileAge - Dateialter * @param {boolean} Recursive - Rekursiv * @param {boolean} DeleteSource - Datei löschen nach import * @returns {boolean} - success */ ImportDocuments(SourcePath: string, FileAge: number, Recursive: boolean, DeleteSource: boolean): boolean; /** * PrepareIndexMask * Die Funktion initialisiert die Eingabemaske mit den Vorgabewerten. Entsprechende Feldevents werden dabei ebenfalls ausgeführt. * @returns {boolean} - success */ PrepareIndexMask(): boolean; /** * PrepareTableRow * Die Funktion initialisiert eine Zeile im Positionsgrid und löst das EventOnAddRow Event aus. * @param {number} Row - Zeile * @returns {boolean} - success */ PrepareTableRow(Row: number): boolean; /** * RefreshTacks * Die Methode ccApplication.RefreshTacks aktualisiert die Liste der verfügbaren Heftungen für den Benutzer. * Während der Aktualisierung wird ein Statusfenster angezeigt welches im Anschluss via ccApplication.CloseStatus geschlossen werden muss. */ RefreshTacks(): void; /** * SaveCurrentTack * Die Methode ccApplication.SaveCurrentTack speichert die Änderungen der aktuell vom Benutzer geöffneten Heftung. Zuvor wird das Event EventOnCheck ausgelöst. Ist keine Heftung geöffnet, passiert nichts. */ SaveCurrentTack(): void; /** * Scan * Scan führt einen Stapelscan unter Einbeziehung des aktuellen Scanprofils durch. */ Scan(): void; /** * SelectBlob * Die Funktion markiert das angegebene Blob. Ist MakeVisible true, wird ggf. ein Bildlauf der Liste durchgeführt um das Blob sichtbar zu machen. * @param {string} BlobId - BlobId * @param {boolean} MakeVisible - Scroll to selected Blob * @returns {boolean} - success */ SelectBlob(BlobId: string, MakeVisible: boolean): boolean; /** * ShowStatus * Die Funktion zeigt das Statusfenster mit den entsprechenden Infos an. Progress nimmt einen Wert zwischen -1 und 100 an. * @param {string} Operation - Überschrift * @param {string} Status - Body * @param {number} Progress - Fortschritt * @returns {boolean} - success */ ShowStatus(Operation: string, Status: string, Progress: number): boolean; /** * ShowTack * Die Methode ccApplication.ShowTack öffnet die in TackId angegebene Heftung und zeigt diese an. * @param {string} TackId - Heftungsid */ ShowTack(TackId: string): void; /** * StackProcessing * StackProcessing führt die in der Anwendung definierte Stapelverarbeitung aus. In Msg wird beim Ergebnis false die entsprechende Fehlermeldung zurückgegeben. * @returns {{success:boolean,message:string}} - success & message */ StackProcessing(): { success: boolean; message: string; }; /** * UnSelectAllBlobs * Die Funktion demarkiert alle Blobs im angegebenen Stapel (Stack). * @param {string} Stack - Stapel * @returns {boolean} - success */ UnSelectAllBlobs(Stack: string): boolean; }