Description: Inserts a text string into a text editor.
Returns: Nothing
Usage: Script or Steady State
Format: AddEditorText(Editor, Text)
Parameters: Editor { editor type value } { required } { no default: }
Editor is any expression that returns an editor value that was created by the MakeEditor function. If this isn't an editor type value, or if it is invalid, nothing happens.
Text { text } { required } { no default: }
This is the text to insert into the text editor.
Comments: The text will be broken into lines based on carriage returns and/or line feeds.
Example:
AddEditorText(AlarmLog, "Reason for alarm:");
This example inserts the text "Reason for alarm" into the text editor identified in the variable AlarmLog.
See Also:
CurrentLine | Editor | ForceEvent | GoToOffset | MakeEditor | SetEditMode