Class TextPosition

Cursor-like handle to a precise character index within a fixed document page, enabling navigation (by character, word, line, or page) and retrieval of positional metadata.

Inheritance
System.Object
TextPosition
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Fixed.Text
Assembly: Telerik.Windows.Documents.Fixed.dll

Syntax

public class TextPosition

Constructors

TextPosition(RadFixedDocument)

Initializes a new instance of the TextPosition class.

Declaration
public TextPosition(RadFixedDocument document)
Parameters
RadFixedDocument document

The document.

TextPosition(RadFixedPage)

Initializes a new instance of the TextPosition class.

Declaration
public TextPosition(RadFixedPage page)
Parameters
RadFixedPage page

The page.

TextPosition(RadFixedPage, Int32)

Initializes a new instance of the TextPosition class.

Declaration
public TextPosition(RadFixedPage page, int index)
Parameters
RadFixedPage page

The page.
System.Int32 index

The index.

TextPosition(TextPosition)

Initializes a new instance of the TextPosition class.

Declaration
public TextPosition(TextPosition position)
Parameters
TextPosition position

The position.

Properties

Index

Gets the zero-based character index within the current text page.

Declaration
public int Index { get; }
Property Value
System.Int32

The index.

Page

Gets the fixed page that currently contains this text position.

Declaration
public RadFixedPage Page { get; }
Property Value
RadFixedPage

The page.

Methods

Equals(Object)

Determines whether the specified System.Object is a TextPosition at the same index on the same page (throws if from a different document).

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The System.Object to compare with the current System.Object.
Returns
System.Boolean

True if the specified System.Object is equal to the current System.Object; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Generates a hash code combining page and index so the position can be used in hash-based collections.

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code for the current System.Object.
Overrides
System.Object.GetHashCode()

GetWordBoundingRect()

Gets the bounding rectangle of the word containing the current position.

Declaration
public Rect GetWordBoundingRect()
Returns
System.Windows.Rect

The bounding rectangle of the current word.

MoveLineDown()

Moves to the corresponding position in the line below the current line.

Declaration
public bool MoveLineDown()
Returns
System.Boolean

True if the move to the line below was successful; otherwise, false.

MoveLineUp()

Moves to the corresponding position in the line above the current line.

Declaration
public bool MoveLineUp()
Returns
System.Boolean

True if the move to the line above was successful; otherwise, false.

MoveToCurrentWordEnd()

Moves to the end of the current word.

Declaration
public bool MoveToCurrentWordEnd()
Returns
System.Boolean

True if the move to the current word end was successful; otherwise, false.

MoveToCurrentWordStart()

Moves to the start of the current word.

Declaration
public bool MoveToCurrentWordStart()
Returns
System.Boolean

True if the move to the current word start was successful; otherwise, false.

MoveToEndOfDocument()

Moves to the end (last position) of the document.

Declaration
public bool MoveToEndOfDocument()
Returns
System.Boolean

True if the move to the end of the document was successful; otherwise, false.

MoveToLineEnd()

Moves to the end of the current line.

Declaration
public bool MoveToLineEnd()
Returns
System.Boolean

True if the move to the line end was successful; otherwise, false.

MoveToLineStart()

Moves to the start of the current line.

Declaration
public bool MoveToLineStart()
Returns
System.Boolean

True if the move to the line start was successful; otherwise, false.

MoveToNextPosition()

Moves to the next position in the document.

Declaration
public bool MoveToNextPosition()
Returns
System.Boolean

True if the move to the next position was successful; otherwise, false.

MoveToNextWord()

Moves to the beginning of the next word in the document.

Declaration
public bool MoveToNextWord()
Returns
System.Boolean

True if the move to the next word was successful; otherwise, false.

MoveToPosition(TextPosition)

Moves this position to match another valid position within the same document.

Declaration
public bool MoveToPosition(TextPosition position)
Parameters
TextPosition position

The target position to move to. Must be from the same document.
Returns
System.Boolean

True if the move operation was successful; otherwise, false.

MoveToPreviousPosition()

Moves to the previous position in the document.

Declaration
public bool MoveToPreviousPosition()
Returns
System.Boolean

True if the move to the previous position was successful; otherwise, false.

MoveToPreviousWord()

Moves to the beginning of the previous word in the document.

Declaration
public bool MoveToPreviousWord()
Returns
System.Boolean

True if the move to the previous word was successful; otherwise, false.

MoveToStartOfDocument()

Moves to the beginning (first position) of the document.

Declaration
public bool MoveToStartOfDocument()
Returns
System.Boolean

True if the move to the start of the document was successful; otherwise, false.

OnPositionChanged()

Called when TextPosition is changed.

Declaration
protected virtual void OnPositionChanged()

OnPositionChanging()

Called when TextPosition is changing.

Declaration
protected virtual void OnPositionChanging()

ToString()

Returns a string showing the current word split at the caret position (text before and after the index separated by '@').

Declaration
public override string ToString()
Returns
System.String

A string that represents the current object.
Overrides
System.Object.ToString()

Events

PositionChanged

Raised immediately after the position changes to a new page/index location.

Declaration
public event EventHandler PositionChanged
Event Type
System.EventHandler

PositionChanging

Raised just before the position changes, allowing observers to capture state prior to movement.

Declaration
public event EventHandler PositionChanging
Event Type
System.EventHandler

Operators

Equality(TextPosition, TextPosition)

Returns true if two positions reference the same page and index within the same document.

Declaration
public static bool operator ==(TextPosition left, TextPosition right)
Parameters
TextPosition left

Left text position.
TextPosition right

Right text position.
Returns
System.Boolean

Returns if the two positions are equal.

GreaterThan(TextPosition, TextPosition)

Returns true if the left position follows the right one in document reading order (same document required).

Declaration
public static bool operator>(TextPosition left, TextPosition right)
Parameters
TextPosition left

Left text position.
TextPosition right

Right text position.
Returns
System.Boolean

Returns if the left position is greater than the right position.

GreaterThanOrEqual(TextPosition, TextPosition)

Returns true if the left position follows or equals the right one (positions must originate from the same document).

Declaration
public static bool operator >=(TextPosition left, TextPosition right)
Parameters
TextPosition left

Left text position.
TextPosition right

Right text position.
Returns
System.Boolean

Returns if the left position is greater than or equals to the right position.

Inequality(TextPosition, TextPosition)

Returns true if the two positions differ in page or index (must belong to the same document).

Declaration
public static bool operator !=(TextPosition left, TextPosition right)
Parameters
TextPosition left

Left text position.
TextPosition right

Right text position.
Returns
System.Boolean

Returns if the two positions are not equal.

LessThan(TextPosition, TextPosition)

Returns true if the left position precedes the right one in document reading order (same document required).

Declaration
public static bool operator <(TextPosition left, TextPosition right)
Parameters
TextPosition left

Left text position.
TextPosition right

Right text position.
Returns
System.Boolean

Returns if the left position is less than the right position.

LessThanOrEqual(TextPosition, TextPosition)

Returns true if the left position precedes or equals the right one (positions must originate from the same document).

Declaration
public static bool operator <=(TextPosition left, TextPosition right)
Parameters
TextPosition left

Left text position.
TextPosition right

Right text position.
Returns
System.Boolean

Returns if the left position is less than or equals to the right position.

Extension Methods