Scripting: Script Editor and Text Editor Attributes

Script Editor and Text Editor Attributes

Introduced

v5.0

View attributes for the Script Editor and Text Editor. Both views are identical, except that only a single instance of the Text Editor can exist at a time, and the Script Editor includes the Script History window.

Not all attributes support both setting and getting. Check the third column in the table.

Note	See ScintillaAttributes for an additional set of the attributes that are supported by all the text based editors.

Note	See ViewAttributes for a complete list of types of attributes that you can use when customizing your Relational Views.

Attribute Name

Description

Supports

entrypoint

A search string. The script editor automatically scrolls to the first line containing this string, if found. The string can be in any position in the document (it is not necessary to specify the start of the line).

Possible Values:	Description:
<any string>	Any string in the specified file.

View.SetAttributeValue only.

filename

The path and name of a text or script file to open when the script editor is displayed.

See the ViewCollection object for an example using this attribute.

Possible Values:	Description:
<any valid path and filename>	Any path and filename pointing to a file on your system (including UNC paths). For example, "C:\temp\dump_values.vbs" or "\\sysadmin\public\create_rigs_for_jennifer.pls"

View.GetAttributeValue and View.SetAttributeValue.

newfilename

Creates a new file in the script editor and optionally set the content with code.

Possible Values:	Description:
<any valid scripting code>	Optional source code to set the editor with. If no code is passed the editor is just reset with a blank file.

View.SetAttributeValue only.

savefilename

Saves the content of the editor in a specified filename.

Possible Values:	Description:
<any valid path and filename>	Any path and filename pointing to a file on your system (including UNC paths). For example, "C:\temp\dump_values.vbs" or "\\sysadmin\public\create_rigs_for_jennifer.pls"

View.SetAttributeValue only.

errorlinenum

This property draws a red border around the specified line and makes sure that it is visible. The first line of the file is considered line 1 (not 0).

Possible Values:	Description:
<a number>	Line number in the file. Use 0 to clear the error line.

View.SetAttributeValue only.

historyline

Returns the current line of the script history, or if there is a selection it returns that instead. This attribute is only available on the Script Editor view, not the Text Editor view. It is also available on the Script History view when the Script History exists in the layout as a view of its own.

Possible Values:	Description:
<a string>	A string to append to the end of the script or text file

View.GetAttributeValue only.