AddEditorText
Description: | Inserts a text string into a text editor. |
Returns: | Nothing |
Usage: | Script or steady state. |
Function Groups: | Editor |
Related to: | CurrentLine | Editor | ForceEvent | GoToOffset | MakeEditor | SetEditMode |
Format: | AddEditorText(Editor, Text) |
Parameters: |
Editor |
Required. Any expression that evaluates to an editor value that was created by the MakeEditor function. If this is not an editor type value, then the function will do nothing. |
Text |
Required. Any expression that evaluates to the text to insert into the text editor. |
Comments: | The text will be broken into lines based on carriage returns or line feeds or both. |
Example:
AddEditorText(AlarmLog, "Reason for alarm:");
This example inserts the text "Reason for alarm" into the text editor identified in the variable AlarmLog.