Class
Caret

Represents a caret for code editor.

Definition

Namespace:Telerik.Windows.Controls.SyntaxEditor.UI

Assembly:Telerik.Windows.Controls.SyntaxEditor.dll

Syntax:

cs-api-definition
public class Caret : Control

Inheritance: objectCaret

Constructors

Caret()

Initializes a new instance of the Caret class.

Declaration

cs-api-definition
public Caret()

Fields

CaretBrushProperty

Identifies the CaretBrush dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty CaretBrushProperty

Field Value

DependencyProperty

Properties

CaretBrush

Gets or sets the brush used for the carets.

Declaration

cs-api-definition
public Brush CaretBrush { get; set; }

Property Value

Brush

DisplayMode

Caret display mode.

Declaration

cs-api-definition
public CaretDisplayMode DisplayMode { get; set; }

Property Value

CaretDisplayMode

ShouldInvertForeColor

Gets or sets a value indicating whether [should invert fore color].

Declaration

cs-api-definition
public bool ShouldInvertForeColor { get; set; }

Property Value

bool

true if [should invert fore color]; otherwise, false.

Methods

Focus()

Tries to focus the caret.

Declaration

cs-api-definition
public bool Focus()

Returns

bool

Hide()

Hides the caret.

Declaration

cs-api-definition
public void Hide()

OnApplyTemplate()

Declaration

cs-api-definition
public override void OnApplyTemplate()

OnGotFocus(RoutedEventArgs)

Invoked whenever an unhandled event reaches this element in its route.

Declaration

cs-api-definition
protected override void OnGotFocus(RoutedEventArgs e)

Parameters

e

RoutedEventArgs

The RoutedEventArgs that contains the event data.

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The RoutedEventArgs that contains the event data.

OnTextInserted(object, TextInsertedEventArgs)

Handles the event.

Declaration

cs-api-definition
protected virtual void OnTextInserted(object sender, TextInsertedEventArgs e)

Parameters

sender

object

The sender.

e

TextInsertedEventArgs

The TextInsertedEventArgs instance containing the event data.

SetFontSize(double)

Sets the font size of the caret.

Declaration

cs-api-definition
public void SetFontSize(double fontSize)

Parameters

fontSize

double

Show()

Shows the caret.

Declaration

cs-api-definition
public bool Show()

Returns

bool

UpdateUI()

Updates the UI.

Declaration

cs-api-definition
public void UpdateUI()

Events

TextInserted

Occurs when text is inserted.

Declaration

cs-api-definition
public event EventHandler<TextInsertedEventArgs> TextInserted

Event Value

EventHandler<TextInsertedEventArgs>

UpdateExecuted

Occurs when [update executed].

Declaration

cs-api-definition
public event EventHandler UpdateExecuted

Event Value

EventHandler