Text Based Editors (Scintilla) Attributes
 
 
 

Text Based Editors (Scintilla) Attributes

Introduced

v8.0 (2010)

Sub-set of view attributes for all the text based editors.

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

Note See ViewAttributes for a complete list of types of attributes that you can use when customizing your Relational Views.
Attribute Name Description Supports
curlinenum Gets the line number of the current cursor position. Can also be used to set the current cursor position to the beginning of the specified line. The first line is considered line 1 (not 0).

Possible Values:

Description:

<a number> Line number of the current cursor position
View.GetAttributeValue and View.SetAttributeValue.
text The entire contents of the editor as a single string. Note: on Windows the "\r\n" characters are used to mark new line, while on Linux only "\n" is used. Can also be used to set the text content, in which case the existing content is lost.

Possible Values:

Description:

<a string> Content of the script or text file
View.GetAttributeValue and View.SetAttributeValue.
selectedtext Get access to the currently selected (highlighted) text, if any.

Possible Values:

Description:

<a string> Content of the selected text, or an empty string
View.GetAttributeValue only.
inserttext If there is a text selection then setting this property will replace the existing selection with the new text. If there is no selection then the text is inserted at the current cursor position.

Possible Values:

Description:

<a string> A string to append to the end of the script or text file
View.SetAttributeValue only.
font The name of the font to use in the editor.

Possible Values:

Description:

<a string> Any supported font name.
View.GetAttributeValue and View.SetAttributeValue.
fontsize The size of the font to use in the editor.

Possible Values:

Description:

<font size> The string representation of the font size.
View.GetAttributeValue and View.SetAttributeValue.
tabsize The display size of the tabs to use in the editor.

Possible Values:

Description:

<tab size> The string representation of the tab size.
View.GetAttributeValue and View.SetAttributeValue.
usespacesfortab Controls whether the tab key inserts a tab character or spaces.

Possible Values:

Description:

'false' (Default) Pressing the tab key inserts a tab character. Note: Use the string "false", not the boolean false.
'true' Pressing the tab key inserts spaces. Note: Use the string "true", not the boolean true.
View.GetAttributeValue and View.SetAttributeValue.
showindentationguides Controls whether the indentation guides are displayed or not in the editor. Indentation guides appear as dotted vertical lines within indentation white space every tab size columns.

Possible Values:

Description:

'true' (Default) Indentation guides are displayed. Note: Use the string "true", not the boolean true.
'false' Indentation guides are not displayed. Note: Use the string "false", not the boolean false.
View.GetAttributeValue and View.SetAttributeValue.
showlinenumbers Controls whether line numbers are displayed or not in a special margin on the left hand side of the editor.

Possible Values:

Description:

'true' Line numbers are displayed. Note: Use the string "true", not the boolean true.
'false' No line numbers are displayed. Note: Use the string "false", not the boolean false.
View.GetAttributeValue and View.SetAttributeValue.
showwhitespace Controls whether whitespace characters (spaces and tabs) are displayed or not in the editor. Space characters appear as small centred dots and tab characters as light arrows pointing to the right.

Possible Values:

Description:

'true' Whitespace is displayed. Note: Use the string "true", not the boolean true.
'false' (Default) Normal display. Note: Use the string "false", not the boolean false.
View.GetAttributeValue and View.SetAttributeValue.
folding When folding is enabled, you are able to control the display of lines by making them invisible or visible. Generally, the fold points of a document are based on the hierarchical structure of its contents.

Possible Values:

Description:

'true' Folding is enabled. Folding points are displayed in a margin on the left hand side of view and displayed as small +/- icons. Note: Use the string "true", not the boolean true.
'false' Folding is disabled. Note: Use the string "false", not the boolean false.
View.GetAttributeValue and View.SetAttributeValue.
selectionmargin If enabled, display an extra margin on the left hand side of view useful for selecting lines and displaying bookmarks.

Possible Values:

Description:

<font size> The string representation of the size for the selection margin (from 0 to 22). A value of 0 means no selection margin is displayed. In this case the bookmarks will be displayed by changing the background color of the entire line. Value value greater than 0 means display a selection margin of that size. In this case the bookmarks will be displayed as a small box with rounded corners in the selection margin.
View.GetAttributeValue and View.SetAttributeValue.
syntaxhighlight Returns the current programming language in use for the current text/file. This language is used for the styling and fold points. When setting allows you to change the current language used.

Possible Values:

Description:

cpp cpp
JScript JScript
c# c#
VBScript VBScript
Python Python
PerlScript PerlScript
HTML HTML
XML XML
None None
View.GetAttributeValue and View.SetAttributeValue.
files Returns a semicolon-delimited list of files which are currently opened (from each tab).

Possible Values:

Description:

<list of files> A semicolon-delimited list of files (full path and name).
View.GetAttributeValue only.
activetab Sets or returns the currently active tab (the one being displayed) of the editor.

Possible Values:

Description:

<a string> Name of the filename currently open or to be opened in the active tab. When getting this value, just the name displayed on the tab is returned.
Note This can be either just the filename or the full path and name
View.GetAttributeValue and View.SetAttributeValue.
smarthighlighting Controls whether the editor is highlighting all instances of the currently selected word.

Possible Values:

Description:

'true' (Default) Smart highlighting is enabled. Note: Use the string "true", not the boolean true.
'false' Smart highlighting is disabled. Note: Use the string "false", not the boolean false.
View.GetAttributeValue and View.SetAttributeValue.