// Compatibility file for non-module typescript compiles without adjustments. // Use the following line for modern code (needs adjustments to tsconfig.json#configOptions/paths) // import { TcHmiControl } from "Beckhoff.TwinCAT.HMI.Framework/index.esm.js"; // *************************************************************************** /** * Creates a prompt for writing to a symbol that requires either reauthentication or additional audit trail input like a comment. * Symbol will be written via an isolated websocket and the prompt will ask for reauthentication credentials if * this is required, allow adding further information and adjusting the new value before writing. * This prompt is not meant to be used directly but it is part of the UiProvider.PopupProvider for customization. * The framework will call the prompt via a queue system for any write request to this symbol when its necessary. */ export declare class InteractiveWritePrompt extends OkCancelPrompt { /** * Creates a new InputPrompt instance. * @param parentControl The control which owns the popup. */ constructor(symbol: TcHmi.UiProvider.PopupProvider.InteractiveWritePrompt.Symbol, options?: TcHmi.UiProvider.PopupProvider.InteractiveWritePrompt.Options | null, parentControl?: TcHmi.Controls.System.TcHmiControl | null); protected __texts: Partial | null; protected __controlTextblockMessageGeneral: TcHmiTextblock | null; protected __options: TcHmi.UiProvider.PopupProvider.InteractiveWritePrompt.Options | null; protected __symbolName: string | null; protected __schema: TcHmi.JsonSchema | null; protected __reauthenticationRequired: boolean; protected __reviewerGroups: string[] | null; protected __commentRequired: boolean; protected __domainUserNames: TcHmi.Dictionary | null; protected __reviewerDomainUserNames: TcHmi.Dictionary | null; protected __defaultDomain: string | null; protected __targetDomain: string | null; protected __targetReviewerDomain: string | null; protected __result: TcHmi.Server.IValueResultObject | undefined; protected __error: TcHmi.IErrorDetails | null; protected __done: boolean; protected __editorNewValue: Editor | null; protected __editorPrevValue: Editor | null; protected __controlTextblockSymbolName: TcHmiTextblock | null; protected __controlTextblockDescription: TcHmiTextblock | null; protected __controlTextblockMessage: TcHmiTextblock | null; protected __controlTextboxComment: TcHmiTextbox | null; protected __controlInputUsername: TcHmiInput | null; protected __controlComboboxUsername: TcHmiCombobox | null; protected __controlInputPassword: TcHmiPasswordInput | null; protected __controlTextblockDomainLabel: TcHmiTextblock | null; protected __controlComboboxDomain: TcHmiCombobox | null; protected __controlTextblockUsernameLabel: TcHmiTextblock | null; protected __controlInputReviewerUsername: TcHmiInput | null; protected __controlComboboxReviewerUsername: TcHmiCombobox | null; protected __controlInputReviewerPassword: TcHmiPasswordInput | null; protected __controlTextblockReviewerDomainLabel: TcHmiTextblock | null; protected __controlComboboxReviewerDomain: TcHmiCombobox | null; protected __controlTextblockReviewerUsernameLabel: TcHmiTextblock | null; protected __controlTextblockPrevValueLabel: TcHmiTextblock | null; protected __controlTextblockNewValueLabel: TcHmiTextblock | null; protected __controlTextblockCommentLabel: TcHmiTextblock | null; protected __controlTextblockPasswordLabel: TcHmiTextblock | null; protected __controlTextblockReviewerPasswordLabel: TcHmiTextblock | null; protected __elementContentContainerUser: HTMLElement | null; protected __elementContentContainerReviewer: HTMLElement | null; protected __elementContentContainerValue: HTMLElement | null; protected __elementContentContainerAdditionalInformation: HTMLElement | null; protected __elementHeadlineUser: HTMLElement | null; protected __elementHeadlineReviewer: HTMLElement | null; protected __elementHeadlineValue: HTMLElement | null; protected __elementHeadlineAdditionalInformation: HTMLElement | null; protected __elementNewValueEditorContainer: HTMLElement | null; protected __elementPrevValueEditorContainer: HTMLElement | null; protected __elementProgressContainer: HTMLElement | null; protected __elementLoadingSpinnerContainerContainer: HTMLElement | null; protected __destroyComboboxDomainSelectionChanged: TcHmi.DestroyFunction | null; protected __destroyReviewerComboboxDomainSelectionChanged: TcHmi.DestroyFunction | null; /** * Destroys the popup and all its controls. * @param force If true, child controls will be removed from the parent control before destruction, to ensure destruction in case of keepAlive === true. */ destroy(force?: boolean): void; /** * Raised when domain selection changes. */ protected __onComboboxDomainSelectionChanged(_event: TcHmi.EventProvider.Event, data: { id: number | null; text: string | null; value: any; }): void; /** * Raised when domain selection changes. */ protected __onComboboxReviewerDomainSelectionChanged(_event: TcHmi.EventProvider.Event, data: { id: number | null; text: string | null; value: any; }): void; /** * Performs the action for the OK button, i.e. calling prompt.answer(). */ protected __ok(): void; /** * Performs the action for the Cancel button. */ protected __cancel(): void; /** * Shows an overall error message * @param message */ protected __showError(message: string): void; /** * Clear existing overall error message * @param message */ protected __clearError(): void; /** * Enables all controls for a specified symbol area. * @param symbol */ protected __enableSymbolControls(): void; /** * Disables all controls for a specified symbol area. * @param symbol */ protected __disableSymbolControls(): void; /** * Enables all controls for a specified symbol area. * @param focus Controls whether focus should be moved to one of the popups inputs. */ protected __showSymbolControls(focus?: boolean): void; /** * Disables all controls for a specified symbol area. * @param symbol */ protected __hideSymbolControls(): void; /** * Shows the loading state for a symbol area. * @param symbol */ protected __showSymbolLoading(): void; /** * Shows an error message for a specified symbol area and disables all related controls. * @param symbol * @param message */ protected __showSymbolError(message: string): void; /** * Clears an error message for a specified symbol area and enables all related controls. * @param symbol * @param message */ protected __showSymbolSuccess(): void; /** * Clears an error message for a specified symbol area and enables all related controls. * @param symbol * @param message */ protected __showSymbolReady(): void; /** * * @param texts */ setTexts(texts: Partial): void; } export declare namespace InteractiveWritePrompt { interface LocalizableTexts extends OkCancelPrompt.LocalizableTexts { headerText: TcHmi.Localizable; editorTexts: Partial; } } import _InteractiveWritePrompt = InteractiveWritePrompt; declare global { namespace TcHmi.Controls.Helpers { let InteractiveWritePrompt: typeof _InteractiveWritePrompt; type InteractiveWritePrompt = _InteractiveWritePrompt; namespace InteractiveWritePrompt { type LocalizableTexts = _InteractiveWritePrompt.LocalizableTexts; } } }