Helper class with caret-related methods.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public sealed class Caret
Public NotInheritable Class Caret
public ref class Caret sealed
Members| All Members | Methods | Properties | Events | ||
| Icon | Member | Description |
|---|---|---|
 | BringCaretToView()()()() |
Scrolls the text view so that the caret is visible.
|
| CalculateCaretRectangle()()()() |
Returns the caret rectangle. The coordinate system is in device-independent pixels from the top of the document.
|
 | CaretBrush |
Gets/Sets the color of the caret.
|
| Column |
Gets/Sets the caret column.
|
| DesiredXPos |
Gets/Sets the desired x-position of the caret, in device-independent pixels.
This property is NaN if the caret has no desired position.
|
| Equals(Object) | (Inherited from Object.) |
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType()()()() | Gets the Type of the current instance. (Inherited from Object.) |
| Hide()()()() |
Makes the caret invisible.
|
| IsInVirtualSpace |
Gets whether the caret is in virtual space.
|
| Line |
Gets/Sets the caret line.
|
| Location |
Gets/Sets the location of the caret.
The getter of this property is faster than Position because it doesn't have
to validate the visual column.
|
| Offset |
Gets/Sets the caret offset.
Setting the caret offset has the side effect of setting the DesiredXPos to NaN.
|
| Position |
Gets/Sets the position of the caret.
Retrieving this property will validate the visual column (which can be expensive).
Use the Location property instead if you don't need the visual column.
|
 | PositionChanged |
Event raised when the caret position has changed.
If the caret position is changed inside a document update (between BeginUpdate/EndUpdate calls),
the PositionChanged event is raised only once at the end of the document update.
|
| Show()()()() |
Makes the caret visible and updates its on-screen position.
|
| ToString()()()() | (Inherited from Object.) |
| VisualColumn |
Gets/Sets the caret visual column.
|
Inheritance Hierarchy| Object | |
 | Caret |
Assembly: ICSharpCode.AvalonEdit (Module: ICSharpCode.AvalonEdit.dll) Version: 5.0.0.4238