Back to all docs
API Reference / Telerik.WinForms.Controls.SyntaxEditor.UI / CaretPosition
New to Telerik UI for WinForms? Start a free 30-day trial

CaretPosition

Class

Represents a CaretPosition information.

Definition

Namespace:Telerik.WinForms.Controls.SyntaxEditor.UI

Assembly:Telerik.WinControls.SyntaxEditor.dll

Syntax:
C#
public class CaretPosition : IComparable<CaretPosition>, IEquatable<CaretPosition>, IDisposable

Inheritance: objectCaretPosition

Implements: IComparable<CaretPosition>IDisposableIEquatable<CaretPosition>

Constructors

CaretPosition(CaretPosition, PositionAnchoringType)

Initializes a new instance of the CaretPosition class.

C#
public CaretPosition(CaretPosition position, PositionAnchoringType anchoringType)
Parameters:positionCaretPosition

The position.

anchoringTypePositionAnchoringType

Type of the anchoring.

CaretPosition(CaretPosition)

Initializes a new instance of the CaretPosition class.

C#
public CaretPosition(CaretPosition position)
Parameters:positionCaretPosition

The position.

CaretPosition(TextDocument, int, int, PositionAnchoringType)

Initializes a new instance of the CaretPosition class.

C#
public CaretPosition(TextDocument document, int lineNumber, int columnNumber, PositionAnchoringType anchoringType)
Parameters:documentTextDocument

The document.

lineNumberint

The line number.

columnNumberint

The column number.

anchoringTypePositionAnchoringType

Type of the anchoring.

CaretPosition(TextDocument, int, int)

Initializes a new instance of the CaretPosition class.

C#
public CaretPosition(TextDocument document, int lineNumber, int columnNumber)
Parameters:documentTextDocument

The document.

lineNumberint

The line number.

columnNumberint

The column number.

CaretPosition(TextDocument, PositionAnchoringType)

Initializes a new instance of the CaretPosition class.

C#
public CaretPosition(TextDocument document, PositionAnchoringType anchoringType)
Parameters:documentTextDocument

The document.

anchoringTypePositionAnchoringType

Type of the anchoring.

CaretPosition(TextDocument)

Initializes a new instance of the CaretPosition class.

C#
public CaretPosition(TextDocument document)
Parameters:documentTextDocument

The document.

Properties

AnchoringType

Gets the type of the anchoring.

C#
public PositionAnchoringType AnchoringType { get; }
Property Value:

The type of the anchoring.

ColumnNumber

Gets the column number.

C#
public int ColumnNumber { get; }
Property Value:

The column number.

DisplayColumnNumber

Gets the display column number.

C#
public int DisplayColumnNumber { get; }
Property Value:

The display column number.

DisplayLineNumber

Gets the display line number.

C#
public int DisplayLineNumber { get; }
Property Value:

The display line number.

Document

Gets the document.

C#
public TextDocument Document { get; }
Property Value:

The document.

Index

Gets the index.

C#
public int Index { get; }
Property Value:

The index.

IsAnchored

Gets a value indicating whether this instance is anchored.

C#
public bool IsAnchored { get; }

LastTrackedColumn

Gets or sets the last tracked column. NOTE: Used for up/down.

C#
public int LastTrackedColumn { get; set; }
Property Value:

The last tracked column.

LineNumber

Gets the line number.

C#
public int LineNumber { get; }
Property Value:

The line number.

TabSize

Gets or sets the size of the tab.

C#
public int TabSize { get; set; }
Property Value:

The size of the tab.

Methods

CompareTo(CaretPosition)

Compares the current object with another object of the same type.

C#
public int CompareTo(CaretPosition other)
Parameters:otherCaretPosition

An object to compare with this object.

Returns:

int

A value that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the other parameter.Zero This object is equal to other. Greater than zero This object is greater than other.

Implements: IComparable<CaretPosition>.CompareTo(CaretPosition)

ConvertFromIndex(TextDocument, int)

Converts from index.

C#
public static CaretPosition ConvertFromIndex(TextDocument document, int index)
Parameters:documentTextDocument

The document.

indexint

The index.

Returns:

CaretPosition

CaretPosition.

ConvertToIndex(CaretPosition)

Converts to index.

C#
public static int ConvertToIndex(CaretPosition position)
Parameters:positionCaretPosition

The position.

Returns:

int

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

C#
public void Dispose()

Implements: IDisposable.Dispose()

Dispose(bool)

Releases unmanaged and - optionally - managed resources.

C#
protected virtual void Dispose(bool disposing)
Parameters:disposingbool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Equals(CaretPosition)

Indicates whether the current object is equal to another object of the same type.

C#
public bool Equals(CaretPosition other)
Parameters:otherCaretPosition

An object to compare with this object.

Returns:

bool

true if the current object is equal to the other parameter; otherwise, false.

Implements: IEquatable<CaretPosition>.Equals(CaretPosition)

Equals(object)

Determines whether the specified object is equal to this instance.

C#
public override bool Equals(object obj)
Parameters:objobject

The object to compare with the current object.

Returns:

bool

true if the specified object is equal to this instance; otherwise, false.

Overrides: object.Equals(object)

GetHashCode()

Returns a hash code for this instance.

C#
public override int GetHashCode()
Returns:

int

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Overrides: object.GetHashCode()

IsAtWordStart()

Determines whether [is at word start].

C#
public bool IsAtWordStart()
Returns:

bool

true if [is at word start]; otherwise, false.

MoveLineDown()

Moves the line down.

C#
public bool MoveLineDown()
Returns:

bool

true if XXXX, false otherwise.

MoveLineUp()

Moves the line up.

C#
public bool MoveLineUp()
Returns:

bool

true if XXXX, false otherwise.

MoveToCurrentWordEnd()

Moves to current word end.

C#
public bool MoveToCurrentWordEnd()
Returns:

bool

true if XXXX, false otherwise.

MoveToCurrentWordStart()

Moves to current word start.

C#
public bool MoveToCurrentWordStart()
Returns:

bool

true if XXXX, false otherwise.

MoveToEndOfDocument()

Moves to end of document.

C#
public void MoveToEndOfDocument()

MoveToHome()

Moves to home.

C#
public void MoveToHome()

MoveToIndex(int)

Moves to index.

C#
public bool MoveToIndex(int indexParameter)
Parameters:indexParameterint

The index.

Returns:

bool

true if XXXX, false otherwise.

MoveToLine(int)

Moves to line.

C#
public void MoveToLine(int lineNumber)
Parameters:lineNumberint

MoveToLineEnd()

Moves to line end.

C#
public void MoveToLineEnd()

MoveToLineStart()

Moves to line start.

C#
public void MoveToLineStart()

MoveToNextCharacter()

Moves to next character.

C#
public bool MoveToNextCharacter()
Returns:

bool

true if XXXX, false otherwise.

MoveToNextWord()

Moves to next word.

C#
public bool MoveToNextWord()
Returns:

bool

true if XXXX, false otherwise.

MoveToPosition(CaretPosition)

Moves to position.

C#
public bool MoveToPosition(CaretPosition position)
Parameters:positionCaretPositionReturns:

bool

MoveToPreviousCharacter()

Moves to previous character.

C#
public bool MoveToPreviousCharacter()
Returns:

bool

true if XXXX, false otherwise.

MoveToPreviousWord()

Moves to previous word.

C#
public bool MoveToPreviousWord()
Returns:

bool

true if XXXX, false otherwise.

MoveToStartOfDocument()

Moves to start of document.

C#
public void MoveToStartOfDocument()

OnPositionChanged()

Called when [position changed].

C#
protected virtual void OnPositionChanged()

OnPositionChanging()

Called when [position changing].

C#
protected virtual void OnPositionChanging()

ToString()

Returns a string that represents this instance.

C#
public override string ToString()
Returns:

string

A string that represents this instance.

Overrides: object.ToString()

Events

PositionChanged

PositionChanged event.

C#
public event EventHandler PositionChanged

PositionChanging

PositionChanging event.

C#
public event EventHandler PositionChanging

Operators

operator !=(CaretPosition, CaretPosition)

Implements the != operator.

C#
public static bool operator !=(CaretPosition left, CaretPosition right)
Parameters:leftCaretPosition

The left.

rightCaretPosition

The right.

Returns:

bool

The result of the operator.

operator <(CaretPosition, CaretPosition)

Implements the < operator.

C#
public static bool operator <(CaretPosition left, CaretPosition right)
Parameters:leftCaretPosition

The left.

rightCaretPosition

The right.

Returns:

bool

The result of the operator.

operator <=(CaretPosition, CaretPosition)

Implements the <= operator.

C#
public static bool operator <=(CaretPosition left, CaretPosition right)
Parameters:leftCaretPosition

The left.

rightCaretPosition

The right.

Returns:

bool

The result of the operator.

operator ==(CaretPosition, CaretPosition)

Implements the == operator.

C#
public static bool operator ==(CaretPosition left, CaretPosition right)
Parameters:leftCaretPosition

The left.

rightCaretPosition

The right.

Returns:

bool

The result of the operator.

operator >(CaretPosition, CaretPosition)

Implements the > operator.

C#
public static bool operator >(CaretPosition left, CaretPosition right)
Parameters:leftCaretPosition

The left.

rightCaretPosition

The right.

Returns:

bool

The result of the operator.

operator >=(CaretPosition, CaretPosition)

Implements the >= operator.

C#
public static bool operator >=(CaretPosition left, CaretPosition right)
Parameters:leftCaretPosition

The left.

rightCaretPosition

The right.

Returns:

bool

The result of the operator.

In this article
DefinitionConstructorsCaretPosition(CaretPosition, PositionAnchoringType)CaretPosition(CaretPosition)CaretPosition(TextDocument, int, int, PositionAnchoringType)CaretPosition(TextDocument, int, int)CaretPosition(TextDocument, PositionAnchoringType)CaretPosition(TextDocument)PropertiesAnchoringTypeColumnNumberDisplayColumnNumberDisplayLineNumberDocumentIndexIsAnchoredLastTrackedColumnLineNumberTabSizeMethodsCompareTo(CaretPosition)ConvertFromIndex(TextDocument, int)ConvertToIndex(CaretPosition)Dispose()Dispose(bool)Equals(CaretPosition)Equals(object)GetHashCode()IsAtWordStart()MoveLineDown()MoveLineUp()MoveToCurrentWordEnd()MoveToCurrentWordStart()MoveToEndOfDocument()MoveToHome()MoveToIndex(int)MoveToLine(int)MoveToLineEnd()MoveToLineStart()MoveToNextCharacter()MoveToNextWord()MoveToPosition(CaretPosition)MoveToPreviousCharacter()MoveToPreviousWord()MoveToStartOfDocument()OnPositionChanged()OnPositionChanging()ToString()EventsPositionChangedPositionChangingOperatorsoperator !=(CaretPosition, CaretPosition)operator <(CaretPosition, CaretPosition)operator <=(CaretPosition, CaretPosition)operator ==(CaretPosition, CaretPosition)operator >(CaretPosition, CaretPosition)operator >=(CaretPosition, CaretPosition)
Not finding the help you need?
Contact Support