dl-breadcrumbs__homedl-breadcrumb-item__separatorConfiguration and programmingdl-breadcrumb-item__separatorProgramming with CODESYSdl-breadcrumb-item__separator...dl-breadcrumb-item__separatorCODESYS Visualizationdl-breadcrumb-item__separatorReference, Programmingdl-breadcrumb-item__separatorVisualization Elementsdl-breadcrumb-item__separatorVisualization Element 'Text Editor'
dl-pagination__prev-inactivedl-pagination__prev-activedl-pagination__next-inactivedl-pagination__next-active
Visualization Element 'Text Editor'dl-permalink__symbolPermalink

Symbol:

_visu_img_text_editor

Category: “Special Controls”

The element shows the contents of text files that are saved on the controller. Files can be encoded in ASCII or Unicode formats.

A visualization user can also edit the text.

Element properties

“Element name”

Example: ‎GenElemInst_1‎

“Type of element”

“Text Editor”

Element property 'Position'

The position defines the location and size of the element in the visualization window. These are based on the Cartesian coordinate system. The origin is located at the upper left corner of the window. The positive horizontal x-axis runs to the right. The positive vertical y-axis runs downwards.

“X”

X coordinate of the upper left corner of the element

Specified in pixels.

Example: ‎10‎.

“Y”

Y coordinate of the upper left corner of the element

Specified in pixels.

Example: ‎10‎.

“Width”

Specified in pixels.

Example: ‎150‎

“Height”

Specified in pixels.

Example: ‎30‎

You can also change the values by dragging the box symbols (_visu_icon_position_element) to other positions in the editor.

Element property 'Font'

“Font name”

Non-proportional font used by the visualization to display the contents of the file

Example: “Courier New”

“Size”

Font size

Example: ‎12‎

Element property 'Control variables'

Table 660: Element property “Control variables --> File”

“Variable”

Variable (‎STRING‎). Contains the file names and optionally the location of the file. It is located in the file system of the controller.

Example: ‎PLC_PRG.strFile: STRING := '/Documentation/Info.txt';‎

“Open”

Variable (‎BOOL‎). Controls opening the file which is defined in the “Variable” property

Example: ‎bOpen: BOOL;‎

‎TRUE‎: The file is opened.

“Close”

Variable (‎BOOL‎). Controls closing the file which is defined in the “Variable” property

Example: ‎bClose: BOOL;‎

‎TRUE‎: The file is closed.

“Save”

Variable (‎BOOL‎). Controls saving the file which is defined in the “Variable” property

Example: ‎bStore: BOOL;‎

‎TRUE‎: The file is saved.

“New”

Variable (‎BOOL‎). Controls creating a new file. The name is defined in the “Variable” property.

Example: ‎bCreate: BOOL;‎

‎TRUE‎: A file is created and opened.
Table 661: Element property “Control variables --> Edit ”

“Variable”

Variable (‎STRING‎). Contains the string to search for in the file

Example: ‎strFind: STRING := 'abc';‎

“Find”

Variable (‎BOOL‎). Controls executing the search for the string in the “Variable” property

Example: ‎bFind: BOOL;‎

‎TRUE‎: The search is performed. The variable is automatically reset to ‎FALSE‎.

“Find next”

Variable (‎BOOL‎). Controls the location to begin the search in the file

Example: ‎bFindNext: BOOL;‎

‎TRUE‎: The search begins at the last search result location.

‎FALSE‎: The search begins at the beginning of the file.
Table 662: Element property “Control variables --> Cursor position”

“Line”

Variable (integer data type). Contains the line of the cursor

Example: ‎iRowCursor: INT;‎

“Column”

Variable (integer data type). Contains the column of the cursor

Example: ‎iColumnCursor: INT;‎

“Position”

Output variable (integer data type). Shows the absolute cursor position in the text.

Example: ‎iPosCursor: INT;‎

“Set cursor”

Variable (‎BOOL‎). Controls the setting of the cursor at a specific location

Example: ‎iSetCursor: INT;‎

‎TRUE‎: The cursor is moved. The new position is defined in the “Line” and “Column” properties.

‎ FALSE‎: The “Line”, “Column”, and “Position” properties contain the actual values.

Note: The variable is used as the control variable for an input event triggered by a visualization user.
Table 663: Element property “Control variables --> Selection”

“Start position”

Output variable (integer data type). Shows the absolute position for starting the text selection

Example: ‎iPosSelection: INT;‎

“End position”

Output variable (integer data type). Shows the absolute position for ending the text selection.

Example: ‎iPosEndSelection: INT;‎

“Start line number”

Output variable (integer data type). Shows the line where the text selection begins

Example: ‎iRowSelection: INT;‎

“Start column index”

Output variable (integer data type). Shows the column where the text selection begins

Example: ‎iColumnSelection: INT;‎

“End line number”

Output variable (integer data type). Shows the line where the text selection ends

Example: ‎iRowEndSelection: INT;‎

“End column index”

Output variable (integer data type). Shows the column where the text selection ends

Example: ‎iColumnEndSelection: INT;‎

“Line to select”

Variable (integer data type). Contains the line number that is selected

Note: The selection is controlled by the variables in the “Trigger selection” property.

“Set selection”

Variable (‎BOOL‎). Controls the selection of a line.

Example: ‎bSetSelection: BOOL;‎

‎TRUE‎: The line from the “Line to select” property is selected and highlighted in the Text Editor.

if the line is not in the current text segment of the Text Editor, then the text segment is moved to this line.

Note: The variable is used as the control variable for an input event triggered by a visualization user. The control variable is not reset automatically. You are responsible for this to occur in the visualization.
Table 664: Element property “Control variables --> Error handling”

“Variable for error code”

Variable (integer data type). Contains the error code when an error occurs

Example: ‎iError: INT;‎

The error codes are declared in ‎GVL_ErrorCodes‎ in the ‎VisuElemTextEditor‎ library. To display the error text, the ‎VisuFctTextEditorGetErrorText()‎ function of the library must be called.

“Variable for content changed”

Variable (‎BOOL‎). Shows whether the contents have changed

Example: ‎bIsContentEdited: BOOL;‎

‎TRUE‎: The contents of the Text Editor have changed.

“Variable for access mode”

Variable (‎BOOL‎). Controls the access privileges to the file

Example: ‎bIsReadOnly: BOOL;‎

‎TRUE‎: A visualization user has read-only permission. At runtime, the file contents are highlighted in gray in the Text Editor.

‎FALSE‎: A visualization user has read/write permission.

Note: The variable overwrites the setting in the “Editor mode” property.

“Maximum line length”

Maximum number of characters per line

“Editor mode”

  • “Read-only”: A visualization user has read-only permissions to the file. At runtime, the file contents are highlighted in gray in the text editor.

  • “Read/write”: A visualization user has read-write permissions.

Element property 'New files'

“Encoding”

Character encoding of the new file:

  • “ASCII”

  • “Unicode (Little endian)”

  • “Unicode (Big endian)”

“New line character sequence”

End of line character of the new file:

  • “CR/LF”: Normal for Windows systems

  • “LF”: Normal for UNIX systems

Please note: When a visualization user opens an existing file, the end-of-line character of the file is detected and used automatically.

These properties are available only when you have selected the “Support client animations and overlay of native elements” option in the Visualization Manager.

“Animation duration”

Defines the duration (in milliseconds) in which the element runs an animation

  • Variable (‎integer value‎)

    Example: ‎Menu.tContent‎ with ‎VAR tContent : INT := 500; END_VAR‎

  • Integer literal

    Example: ‎500‎

Animatable properties

  • “Absolute movement”, “Movement”, “X”, “Y”

  • “Absolute movement”, “Rotation”

  • “Absolute movement”, “Interior rotation”

  • “Absolute movement”, “Exterior rotation”

The animated movement is executed when at least one value of an animatable property has changed. The movement then executed is not jerky, but is smooth within the specified animation duration. The visualization element travels to the specified position while rotating dynamically. The transitions are smooth.

“Move to foreground”

Moves the visualization element to the foreground

Variable (‎BOOL‎)

Example: ‎bIsInForeground‎ with ‎VAR bIsInForeground : BOOL := FALSE; END_VAR‎

‎TRUE‎: At runtime, the visualization element is displayed in the foreground.

‎FALSE‎: At runtime, the visualization element is displayed in the layer where it was inserted in the visualization editor.

Element property 'Access rights'

Requirement: User management is set up for the visualization.

“Access rights”

Opens the “Access rights” dialog. There you can edit the access privileges for the element.

Status messages:

  • “Not set. Full rights.”: Access rights for all user groups : “operable”

  • “Rights are set: Limited rights”: Access is restricted for at least one group.