Version

xamSyntaxEditor - Property Reference

xamSyntaxEditor Test Object Properties Reference

Introduction

This topic provides reference information about the xamSyntaxEditor™ control’s test object properties.

Properties reference chart

The following table defines the xamSyntaxEditor’s properties and elements along with their key characteristics.

Legend:

spy.png – Identification property (Visible in object spy)

checkpoint.png – Checkpoint property (Visible with checkpoints)

script.png – Accessible in script

Property name Description Accessibility

This property consists of an integer value, representing the first visible line number, indexed from 1. This value can be set through the code script.
spy.png
checkpoint.png
script.png

This property consists of an integer value, representing the overall number of characters contained within the loaded document. Returns zero if no document is loaded.
spy.png
checkpoint.png
script.png

This property consists of an integer value, representing the overall number of lines of the loaded document. Returns zero if no document is loaded.
spy.png
checkpoint.png
script.png

This property returns the selected text as a string. Returns an empty string in the event there is no selected text.
spy.png
checkpoint.png
script.png

This property returns a string, representing the two dimensional array identifier of the text location of the start of the selection.

The first value is an integer value representing the line index number, indexed from 0. The second value is an integer value representing the character index number, indexed from 0.

Example: ARRAY (12, 2) represents line 13, character 3.
spy.png
checkpoint.png

This property returns a string, representing the two dimensional array identifier of the text location of the end of the selection.

The first value is an integer value representing the line index number, indexed from 0. The second value an integer value representing the character index number, indexed from 0.

Example: ARRAY (12, 2) represents line 13, character 3.
spy.png
checkpoint.png

This property represents the length, measured in characters, of the currently selected text as an integer value. Returns zero if no selection is made
spy.png
checkpoint.png

This property returns a string, representing the two dimensional array identifying the current location of the caret within the displayed text.

The first value is an integer value representing the line index number, indexed form 0. The second value a zero-based integer represents the character index.

Example: ARRAY (12, 2) represents the line 13, character 3.
spy.png
checkpoint.png

This property returns the currently loaded document’s file name.
spy.png
checkpoint.png