VisuDlg_ProcessChar (FUN) ¶ FUNCTION VisuDlg_ProcessChar This function takes a given character and appends/inserts it in the string representing the variable value. To decide, which action has to be performed, the current caret position and the currently selected text is evaluated. InOut: Scope Name Type Comment Inout stOutputValue STRING This is the string representation of the variable value, that will be displayed in the visualization. If the flag xPassword is TRUE the variable value will be display with password characters stVariableValue STRING This parameter is the variable value, where the character is appended/inserted iCaretPosition INT The current position of the caret. Either within the text or at the end of the text iSelectionStart INT The start of the selected text (1-relative) iSelectionEnd INT The end of the selected text (1-relative). If the complete text is selected this parameter is textlength + 1 Input xPassword BOOL Inidicates, whether the entered value should be readable (FALSE) or displayed with password characters cToConsume STRING(4) The character to append/insert
VisuDlg_ProcessCharW (FUN) ¶ FUNCTION VisuDlg_ProcessCharW This function is the WSTRING counterpart of the function VisuDlg_ProcessChar. InOut: Scope Name Type Comment Inout wstOutputValue WSTRING This is the string representation of the variable value, that will be displayed in the visualization. If the flag xPassword is TRUE the variable value will be display with password characters wstVariableValue WSTRING This parameter is the variable value, where the character is appended/inserted iCaretPosition INT The current position of the caret. Either within the text or at the end of the text iSelectionStart INT The start of the selected text (1-relative) iSelectionEnd INT The end of the selected text (1-relative). If the complete text is selected this parameter is textlength + 1 Input xPassword BOOL Inidicates, whether the entered value should be readable (FALSE) or displayed with password characters cToConsume WSTRING(1) The character to append/insert
VisuDlg_ProcessCharW_WithInit (FUN) ¶ FUNCTION VisuDlg_ProcessCharW_WithInit This function is the WSTRING counterpart of the function VisuDlg_ProcessChar. InOut: Scope Name Type Comment Inout wstOutputValue WSTRING This is the string representation of the variable value, that will be displayed in the visualization. If the flag xPassword is TRUE the variable value will be display with password characters wstVariableValue WSTRING This parameter is the variable value, where the character is appended/inserted iCaretPosition INT The current position of the caret. Either within the text or at the end of the text iSelectionStart INT The start of the selected text (1-relative) iSelectionEnd INT The end of the selected text (1-relative). If the complete text is selected this parameter is textlength + 1 bInit BOOL Initialize of global value for extended numpad, should be done with the first action. Input xPassword BOOL Inidicates, whether the entered value should be readable (FALSE) or displayed with password characters cToConsume WSTRING(1) The character to append/insert
VisuDlg_ProcessCharWithInit (FUN) ¶ FUNCTION VisuDlg_ProcessCharWithInit This function takes a given character and appends/inserts it in the string representing the variable value. To decide, which action has to be performed, the current caret position and the currently selected text is evaluated. Additional, values for the numpadextended will be initialised once InOut: Scope Name Type Comment Inout stOutputValue STRING This is the string representation of the variable value, that will be displayed in the visualization. If the flag xPassword is TRUE the variable value will be display with password characters stVariableValue STRING This parameter is the variable value, where the character is appended/inserted iCaretPosition INT The current position of the caret. Either within the text or at the end of the text iSelectionStart INT The start of the selected text (1-relative) iSelectionEnd INT The end of the selected text (1-relative). If the complete text is selected this parameter is textlength + 1 bInit BOOL Initialize of global value, for numpadextended, should be done with the first action. Input xPassword BOOL Inidicates, whether the entered value should be readable (FALSE) or displayed with password characters cToConsume STRING(4) The character to append/insert
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 13.12.2023, 11:06:15 companyName string 3S-Smart Software Solutions GmbH libraryFile VisuCommandInterface.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile VisuCommandInterface.clean.json version version 2.0.0.0 ProjectInformation Released bool True LastModificationDateTime date 13.12.2023, 11:06:14 LibraryCategories library-category-list Intern|Visu Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Description See: Description Placeholder VisuCommandInterface Project VisuCommandInterface Title VisuCommandInterface Version version 4.5.0.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces.
VisuDialogs Library Documentation ¶ Company : System Title : VisuDialogs Version : 4.5.0.0 Categories : Intern|Visu Author : CODESYS Development GmbH Placeholder : VisuDialogs Description [ 1 ] ¶ This library contains standard dialogs. Contents: ¶ DialogCheckInit (Function) DialogCheckInitForExponential (Function) DialogCheckInitForExponentialW (Function) DialogCheckInitW (Function) Dialog_Constants (GVL) Dialog_FormatTypes (Enum) Dialog_Variables (GVL) Dialog_Variables_Exp (GVL) GlobalTextList (GlobalTextList) IFileListProvider (Interface) Count (Property) Initialize (Method) Next (Method) Previous (Method) ImagePoolDialogs (ImagePool) MessageBoxDialog_Types (Enum) MinMaxLabels (TextList) Utils VisuDlgUtil_AdjustCaretAndSelectionAfterNumberFormatChange (Function) VisuDlgUtil_CloseNumpadExtended (Function) VisuDlgUtil_CloseNumpadExtended2 (Function) VisuDlgUtil_FormatExpToG (Function) VisuDlgUtil_FormatValueToDec (Function) VisuDlgUtil_FormatValueToHex (Function) VisuDlgUtil_InitValueFromFlags (Function) VisuDlgUtil_IsDialogOpen (Function) VisuDlgUtil_SetbInitFormatValue (Function) VisuDlgUtil_UpdateOutputValue (Function) VisuDlg_CheckedAppend (Function) VisuDlg_CheckedAppendExp (Function) VisuDlg_CheckedAppendW (Function) VisuDlg_CheckedBack (Function) VisuDlg_CheckedBackW (Function) VisuDlg_CheckedChangeNumberFormat (Function) VisuDlg_CheckedChangeSign (Function) VisuDlg_CheckedChangeSignExtended (Function) VisuDlg_CheckedClear (Function) VisuDlg_CheckedExpFloatFormatSwitch (Function) VisuDlg_GetPasswordString (Function) VisuDlg_ProcessBack (Function) VisuDlg_ProcessBack2 (Function) VisuDlg_ProcessBackPrepare (Function) VisuDlg_ProcessBackW (Function) VisuDlg_ProcessChangeNumberFormat (Function) VisuDlg_ProcessChangeSign (Function) VisuDlg_ProcessChangeSignExtended (Function) VisuDlg_ProcessChar (Function) VisuDlg_ProcessCharW (Function) VisuDlg_ProcessCharW_WithInit (Function) VisuDlg_ProcessCharWithInit (Function) VisuDlg_ProcessClear (Function) VisuDlg_ProcessExp (Function) VisuDlg_ProcessExpFloatFormatSwitch (Function) VisuDlg_SetErrorColor (Function) VisuDlg_Utf8PasswordCaretPosition (Function) VisuDlg_Utf8RuneLen (Function) Visu_FbDialogLoginProvider (FunctionBlock) GetCredentials (Method) IsGetCredentialsFinished (Method) LoginFailed (Method) LoginSucceeded (Method) Password (Property) PasswordLabelText (Property) RetryWaitTime (Property) RetryWaitTime_Ms (Property) StartGetCredentials (Method) Title (Property) TitlePrefix (Property) TrialCount (Property) UserLabelText (Property) Visu_FbFileListProvider (FunctionBlock) Count (Property) Dummy (Method) GetSelectedDirectory (Method) GetSelectedFileName (Method) Initialize (Method) Next (Method) Previous (Method) private Visu_SortedFileList GVL_SortedFileList (GVL) IDirectoryFileElement (Interface) SortedDirectoryFileElementFactory (FunctionBlock) Visu_UserPasswordCredentials (FunctionBlock) Password (Property) Username (Property) Indices and tables ¶ [ 1 ] Based on VisuDialogs.library, last modified 13.12.2023, 11:06:31. LibDoc 4.4.0.0-b.37 The content file VisuDialogs.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 13.12.2023, 11:06:43.
DialogCheckInit (FUN) ¶ FUNCTION DialogCheckInit : BOOL InOut: Scope Name Type Return DialogCheckInit BOOL Inout stValue STRING stOutput STRING bInit BOOL
DialogCheckInitForExponential (FUN) ¶ FUNCTION DialogCheckInitForExponential : BOOL On opening of the NumpadExtended, we have to check the display value. It can be displayed in exponential notation. New function used with the VisuDlg_Process.. functions InOut: Scope Name Type Return DialogCheckInitForExponential BOOL Inout bInit BOOL Input stValue STRING
VisuDlg_ProcessClear (FUN) ¶ FUNCTION VisuDlg_ProcessClear : BOOL This function is an enhancement of function VisuDlg_CheckedClear, that also resets the caret and selection. InOut: Scope Name Type Comment Return VisuDlg_ProcessClear BOOL Not used, always FALSE Inout stOutputValue STRING This is the string representation of the variable value, that will be displayed in the visualization. stVariableValue STRING This parameter is the variable value, that will be cleared flags DWORD See VisuDlg_CheckedClear iCaretPosition INT The current position of the caret. Either within the text or at the end of the text iSelectionStart INT The start of the selected text (1-relative) iSelectionEnd INT The end of the selected text (1-relative).