TXTextControl.InputPosition Class

An instance of the InputPosition class represents the current text input position of a TXTextControl document.

Introduced: 10.1.

Syntax

[C#]
public class InputPosition
[Visual Basic]
Public Class InputPosition

Constructors

Constructor Description
InputPosition Overloaded. Creates a new instance of the InputPosition class.

Properties

Property Description
CaretSize Gets the size of the caret, in pixels, at the current text input position.
Column Gets the column number of the current text input position.
InactiveMarker Shows or hides a marker which indicates the current text input position when the TextControl is inactive and the blinking caret is not visible.
Line Gets the line number of the current text input position.
Location Gets the geometric location of the current text input position.
Page Gets the page number of the current text input position.
PageInSection Gets the page number in the section containing the current text input position.
Section Gets the section number of the current text input position.
TextPosition Gets the text position of the current text input position.

Methods

Method Description
ScrollTo Scrolls the contents of a Text Control so that the current input position becomes visible.

Example

The following example shows how to add a TextField to the document and how to set the input position right after the field.

[C#]
textControl1.Selection.Text = "Name: ";
TXTextControl.TextField field = new TXTextControl.TextField("%name%");
field.DoubledInputPosition = true;
field.ShowActivated = true;

textControl1.TextFields.Add(field);
textControl1.InputPosition = new TXTextControl.InputPosition(
                             field.Start + field.Length - 1,
                             TXTextControl.TextFieldPosition.OutsideTextField);
[Visual Basic]
TextControl1.Selection.Text = "Name: "
Dim field As TXTextControl.TextField = New TXTextControl.TextField("%name%")
field.DoubledInputPosition = True
field.ShowActivated = True

TextControl1.TextFields.Add(field)
TextControl1.InputPosition = New TXTextControl.InputPosition( _
                             field.Start + field.Length - 1, _
                             TXTextControl.TextFieldPosition.OutsideTextField)

See Also