Types ¶ Visu_TypeString (Alias)

File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 23.05.2024, 09:51:50 companyName string 3S-Smart Software Solutions GmbH libraryFile VisuElemBase.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile VisuElemBase.clean.json version version 2.0.0.0 ProjectInformation PreserveCompiledLibComments bool True Released True VisuStructural True LastModificationDateTime date 23.05.2024, 09:51:44 LibraryCategories library-category-list Intern|Visu Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 Patch 3 Description See: Description Placeholder System_VisuElemBase Project VisuElemBase Title VisuElemBase UnitTestingDefine UT_Visualization Version version 4.6.0.0

Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. 3SLicense ¶ Library Identification ¶ Placeholder: 3SLicense Default Resolution: 3SLicense, * (3S - Smart Software Solutions GmbH) Namespace: _3S_LICENSE Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: 3SLicense Base Interfaces ¶ Library Identification ¶ Name: Base Interfaces Version: newest Company: System Namespace: IBaseLibrary Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Base Interfaces, * (System) CAA FB Factory ¶ Library Identification ¶ Placeholder: CAA FB Factory Default Resolution: CAA FB Factory, * (CAA Technical Workgroup) Namespace: FBF Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA FB Factory CAA Memory Block Manager Extern ¶ Library Identification ¶ Placeholder: CAA MemBlockMan Default Resolution: CAA Memory Block Manager Extern, * (CAA Technical Workgroup) Namespace: MBM Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA MemBlockMan CAA Types Extern ¶ Library Identification ¶ Placeholder: CAA Types Default Resolution: CAA Types Extern, * (CAA Technical Workgroup) Namespace: CAA Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Types CmpApp ¶ Library Identification ¶ Placeholder: CmpApp Default Resolution: CmpApp, * (System) Namespace: CmpApp Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpApp CmpBitmapPool ¶ Library Identification ¶ Placeholder: CmpBitmapPool Default Resolution: CmpBitmapPool, * (System) Namespace: CmpBitmapPool Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpBitmapPool CmpCodeMeter ¶ Library Identification ¶ Placeholder: CmpCodeMeter Default Resolution: CmpCodeMeter, * (System) Namespace: CmpCodeMeter Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpCodeMeter CmpCrypto Implementation ¶ Library Identification ¶ Placeholder: CmpCrypto Implementation Default Resolution: CmpCrypto Implementation, * (System) Namespace: CmpCrypto_Implementation Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpCrypto Implementation CmpCrypto Interfaces ¶ Library Identification ¶ Name: CmpCrypto Interfaces Version: newest Company: System Namespace: CmpCrypto_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpCrypto Interfaces, * (System) CmpDynamicText ¶ Library Identification ¶ Placeholder: CmpDynamicText Default Resolution: CmpDynamicText, * (System) Namespace: CmpDynamicText Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpDynamicText CmpErrors2 Interfaces ¶ Library Identification ¶ Name: CmpErrors2 Interfaces Version: newest Company: System Namespace: CmpErrors Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpErrors2 Interfaces, * (System) CmpEventMgr Implementation ¶ Library Identification ¶ Placeholder: CmpEventMgr Implementation Default Resolution: CmpEventMgr Implementation, * (System) Namespace: CmpEventMgr_Implementation Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: False Key: CmpEventMgr Implementation CmpEventMgr Interfaces ¶ Library Identification ¶ Name: CmpEventMgr Interfaces Version: newest Company: System Namespace: CmpEventMgr_Interfaces Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: False Key: CmpEventMgr Interfaces, * (System) CmpLog ¶ Library Identification ¶ Placeholder: CmpLog Default Resolution: CmpLog, * (System) Namespace: CmpLog Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpLog CmpSchedule ¶ Library Identification ¶ Placeholder: CmpSchedule Default Resolution: CmpSchedule, * (System) Namespace: CmpSchedule Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpSchedule CmpTargetVisu ¶ Library Identification ¶ Placeholder: CmpTargetVisu Default Resolution: CmpTargetVisu, * (System) Namespace: CmpTargetVisu Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpTargetVisu CmpUserMgr ¶ Library Identification ¶ Name: CmpUserMgr Version: 3.5.17.0 Company: System Namespace: CmpUserMgr Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpUserMgr, 3.5.17.0 (System) CmpVisuHandler ¶ Library Identification ¶ Placeholder: CmpVisuHandler Default Resolution: CmpVisuHandler, * (System) Namespace: CmpVisuHandler Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpVisuHandler Collections ¶ Library Identification ¶ Placeholder: Collections Default Resolution: Collections, * (System) Namespace: Collections Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Collections Component Manager ¶ Library Identification ¶ Placeholder: Component Manager Default Resolution: Component Manager, * (System) Namespace: Component_Manager Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Component Manager Data Server Interfaces ¶ Library Identification ¶ Name: Data Server Interfaces Version: newest Company: System Namespace: Dataserver_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Data Server Interfaces, * (System) Datasources Interfaces ¶ Library Identification ¶ Name: Datasources Interfaces Version: newest Company: 3S - Smart Software Solutions GmbH Namespace: IDatasources Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: Datasources Interfaces, * (3S - Smart Software Solutions GmbH) Element Collections ¶ Library Identification ¶ Placeholder: ElementCollections Default Resolution: Element Collections, * (3S - Smart Software Solutions GmbH) Namespace: COL Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: ElementCollections FloatingPointUtils ¶ Library Identification ¶ Placeholder: FloatingPointUtils Default Resolution: FloatingPointUtils, * (System) Namespace: FPU Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: FloatingPointUtils IecVarAccess3 Interfaces ¶ Library Identification ¶ Name: IecVarAccess3 Interfaces Version: newest Company: System Namespace: IecVarAccess_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: IecVarAccess3 Interfaces, * (System) Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard Standard64 ¶ Library Identification ¶ Placeholder: Standard64 Default Resolution: Standard64, * (System) Namespace: Standard64 Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard64 StringUtils ¶ Library Identification ¶ Placeholder: StringUtils Default Resolution: StringUtils, * (System) Namespace: Stu Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: StringUtils SysCpuHandling ¶ Library Identification ¶ Placeholder: SysCpuHandling Default Resolution: SysCpuHandling, * (System) Namespace: SysCpuHandling Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysCpuHandling SysFile ¶ Library Identification ¶ Placeholder: SysFile Default Resolution: SysFile, * (System) Namespace: SysFile Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysFile SysMem ¶ Library Identification ¶ Placeholder: SysMem Default Resolution: SysMem, * (System) Namespace: SysMem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysMem SysProcess ¶ Library Identification ¶ Placeholder: SysProcess Default Resolution: SysProcess, * (System) Namespace: SysProcess Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysProcess SysShm ¶ Library Identification ¶ Placeholder: SysShm Default Resolution: SysShm, * (System) Namespace: SysShm Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysShm SysTarget ¶ Library Identification ¶ Placeholder: SysTarget Default Resolution: SysTarget, * (System) Namespace: SysTarget Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTarget SysTime ¶ Library Identification ¶ Placeholder: SysTime Default Resolution: SysTime, * (System) Namespace: SysTime Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTime SysTimeRtc ¶ Library Identification ¶ Placeholder: SysTimeRtc Default Resolution: SysTimeRtc, * (System) Namespace: SysTimeRtc Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: False Key: SysTimeRtc SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System) Unit Conversion Interfaces ¶ Library Identification ¶ Name: Unit Conversion Interfaces Version: newest Company: Intern Namespace: UC Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: Unit Conversion Interfaces, * (Intern) Util ¶ Library Identification ¶ Placeholder: Util Default Resolution: Util, * (System) Namespace: Util Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Util Library Parameter ¶ Parameter: IBLOCKSIZE = 22800 Visu Interfaces ¶ Library Identification ¶ Name: Visu Interfaces Version: newest Company: System Namespace: Visu_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Visu Interfaces, * (System) VisuUserMgmt3 Interfaces ¶ Library Identification ¶ Name: VisuUserMgmt3 Interfaces Version: newest Company: System Namespace: VisuUserManagement_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: VisuUserMgmt3 Interfaces, * (System)

IVisualizationStyle.GetFont (METH) ¶ METHOD GetFont : VisuStructFont This method searches for a style entry of type Font and returns the according value if found. The returned font evaluates the style entry ‘Font-Default-Color’ for determination of the color. If this setting is not defined, the returned font will use the black color. InOut: Scope Name Type Comment Return GetFont VisuStructFont Input stStyleKey STRING The name of the style entry to seach for. fontDefault VisuStructFont The default value to use if the entry is not found. pOptResult POINTER TO UDINT An optional result error code. Common result values are Errors.ERR_OK if a valid style was found or Errors.ERR_INVALIDID if no style entry was found. In this case, the method will return the default value.

IVisualizationStyle.GetFontWithColor (METH) ¶ METHOD GetFontWithColor : VisuStructFont This method searches for a style entry of type Font and returns the according value if found. Additionally, the passed style name for the font color will be evaluated. InOut: Scope Name Type Comment Return GetFontWithColor VisuStructFont Input stStyleKey STRING The name of the style entry to seach for. fontDefault VisuStructFont The default value to use if the entry is not found. stColorStyleKey STRING The name of the style entry to seach for. udiColorDefault UDINT The default value to use if the entry is not found. pOptResult POINTER TO UDINT An optional result error code. Common result values are Errors.ERR_OK if a valid style was found or Errors.ERR_INVALIDID if no style entry was found. In this case, the method will return the default value.

IVisualizationStyle.GetString (METH) ¶ METHOD GetString : POINTER TO STRING This method searches for a style entry of type STRING and returns the according value if found. The returned pointer to a string might point to values that are larger than 80 characters! InOut: Scope Name Type Comment Return GetString POINTER TO STRING Input stStyleKey STRING The name of the style entry to seach for. pstDefault POINTER TO STRING The default value to use if the entry is not found. In case of a NULL value passed here, an empty string will be returned as default! pOptResult POINTER TO UDINT An optional result error code. Common result values are Errors.ERR_OK if a valid style was found or Errors.ERR_INVALIDID if no style entry was found. In this case, the method will return the default value.

IVisualizationStyle.GetUDINT (METH) ¶ METHOD GetUDINT : UDINT This method searches for a style entry of type UDINT and returns the according value if found. InOut: Scope Name Type Comment Return GetUDINT UDINT Input stStyleKey STRING The name of the style entry to seach for. udiDefault UDINT The default value to use if the entry is not found. pOptResult POINTER TO UDINT An optional result error code. Common result values are Errors.ERR_OK if a valid style was found or Errors.ERR_INVALIDID if no style entry was found. In this case, the method will return the default value.

Structures ¶ VisuStructClientTagData (Struct) VisuStructColors (Struct) VisuStructColorsInfo (Struct) VisuStructElementState (Struct) VisuStructFont (Struct) VisuStructPointD (Struct) VisuStructRadius (Struct) VisuStructSimpleRectWithBorder (Struct) VisuStructSimpleRectangleD (Struct) VisuStructSingleIECTouchInfo (Struct) VisuStructTextProperties (Struct) Visu_StructSelectionChangedData (Struct)

VisuStructClientTagData (STRUCT) ¶ TYPE VisuStructClientTagData : STRUCT This struct must be used only when it is guaranteed that we work with CmpVisuHandler >= 3.5.5 InOut: Name Type Comment numTags INT CHECKED_OMIT pTags POINTER TO ARRAY [0..5] OF Visu_ClientTagData CHECKED_OMIT

IScrollValueProvider.CurrentValueY (PROP) ¶ PROPERTY CurrentValueY : DINT