Class TextPosition

Represents text position.

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 index of the position.

Declaration

public int Index { get; }

Property Value

System.Int32 The index.

Page

Gets the page that contains the position.

Declaration

public RadFixedPage Page { get; }

Property Value

RadFixedPage The page.

Methods

Equals(Object)

Determines whether the specified System.Object is equal to the current System.Object.

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()

Serves as a hash function for a particular type.

Declaration

public override int GetHashCode()

Returns

System.Int32 A hash code for the current System.Object.

Overrides

System.Object.GetHashCode()

GetWordBoundingRect()

Returns the bounding rectangle of the current word.

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 instance to the specified position within the 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 that represents the current object.

Declaration

public override string ToString()

Returns

System.String A string that represents the current object.

Overrides

System.Object.ToString()

Events

PositionChanged

Occurs when TextPosition is changed.

Declaration

public event EventHandler PositionChanged

Event Type

System.EventHandler

PositionChanging

Occurs when TextPosition is changing.

Declaration

public event EventHandler PositionChanging

Event Type

System.EventHandler

Operators

Equality(TextPosition, TextPosition)

Compares two text positions.

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)

Compares two text positions.

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)

Compares two text positions.

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)

Compares two text positions.

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)

Compares two text positions.

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)

Compares two text positions.

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.