Class

RadSyntaxEditor

Declaration

public RadSyntaxEditor()

Gets or sets a value indicating whether text scaling is allowed in the editor.

Declaration

[Browsable(true)]
public bool AllowScaling { get; set; }

Property Value

Gets or sets the color of the text cursor (caret) in the editor.

Declaration

[Browsable(true)]
public Color CaretColor { get; set; }

Property Value

Gets or sets the display mode of the text cursor (caret), determining its appearance in the editor.

Declaration

[Browsable(true)]
public CaretDisplayMode CaretDisplayMode { get; set; }

Property Value

Gets or sets the width of the text cursor (caret) when the CaretDisplayMode is set to Normal.

Declaration

[Browsable(true)]
public double CaretWidth { get; set; }

Property Value

Gets the collection of commands that can be executed in the syntax editor.

Declaration

[Browsable(false)]
public SyntaxEditorCommands Commands { get; }

Property Value

Gets the default size of the control when it is initially placed on a design surface.

Declaration

protected override Size DefaultSize { get; }

Property Value

Overrides Control.DefaultSize

Gets the dispatcher object that manages the execution of operations on the UI thread.

Declaration

[Browsable(false)]
public Dispatcher Dispatcher { get; }

Property Value

Gets or sets the text document that contains the content displayed and edited in the control.

Declaration

[Browsable(false)]
public TextDocument Document { get; set; }

Property Value

Gets or sets the font size of the text displayed in the editor.

Declaration

[Browsable(true)]
public double EditorFontSize { get; set; }

Property Value

Gets or sets the component which is responsible for handling the keyboard and mouse input of the RadSyntaxEditor.

Declaration

public SyntaxEditorInputBehavior InputHandler { get; set; }

Property Value

Gets or sets a value indicating whether the text cursor (caret) is visible in the editor.

Declaration

[Browsable(true)]
public bool IsCaretVisible { get; set; }

Property Value

Gets or sets a value indicating whether text selection is enabled in the editor.

Declaration

[Browsable(true)]
public bool IsSelectionEnabled { get; set; }

Property Value

Gets or sets a value indicating whether word wrapping is enabled in the editor.

Declaration

[Browsable(true)]
public bool IsWordWrapEnabled { get; set; }

Property Value

Gets or sets the color palette that defines the appearance of syntax elements in the editor.

Declaration

[Browsable(false)]
public SyntaxEditorPalette Palette { get; set; }

Property Value

Gets or sets the scale factor that determines the size of text and UI elements in the editor.

Declaration

[Browsable(true)]
public double ScaleFactor { get; set; }

Property Value

Gets or sets a value indicating whether the entire line should be processed by the syntax taggers instead of just the modified region.

Declaration

[Browsable(true)]
public bool ShouldTaggersProcessEntireLines { get; set; }

Property Value

Gets or sets a value indicating whether the line numbers are shown.

Declaration

[Browsable(true)]
public bool ShowLineNumbers { get; set; }

Property Value

Gets the RadSyntaxEditorElement which is the main element in the control.

Declaration

[Browsable(false)]
public RadSyntaxEditorElement SyntaxEditorElement { get; }

Property Value

Gets the registry of taggers that provide syntax highlighting and other text analysis features.

Declaration

[Browsable(false)]
public TaggersRegistry TaggersRegistry { get; }

Property Value

Gets the stack of text format definitions that determine how different elements of text are displayed.

Declaration

[Browsable(false)]
public TextFormatDefinitionStack TextFormatDefinitions { get; }

Property Value

Gets or sets a value indicating whether the Shift key must be used to extend text selection.

Declaration

[Browsable(true)]
public bool UseShiftKeyInSelection { get; set; }

Property Value

Copies the current text selection to the clipboard.

Declaration

public void Copy()

Creates the accessibility object for this control to support screen readers and other assistive technologies.

Declaration

protected override AccessibleObject CreateAccessibilityInstance()

Returns

Overrides Control.CreateAccessibilityInstance()

Creates the input behavior component for the RadSyntaxEditor.

Declaration

protected override ComponentInputBehavior CreateBehavior()

Returns

Overrides RadControl.CreateBehavior()

Creates the child elements of the RadSyntaxEditor control.

Declaration

protected override void CreateChildItems(RadElement parent)

Parameters

Overrides RadControl.CreateChildItems(RadElement)

Converts a text caret position to a point in the editor's coordinate system.

Declaration

public Point GetPointFromPosition(CaretPosition position)

Parameters

Returns

Converts a point in the control's coordinate system to a text caret position.

Declaration

public CaretPosition GetPositionFromControlPoint(Point point)

Parameters

Returns

Determines whether a key should be processed as an input key or passed to the parent control.

Declaration

protected override bool IsInputKey(Keys keyData)

Parameters

Returns

Overrides RadControl.IsInputKey(Keys)

Scrolls the editor to position the current line at the top of the viewport.

Declaration

public void MoveCurrentLineToTop()

Handles the event that occurs when the control gets focus, showing the text cursor and focusing the editor element.

Declaration

protected override void OnGotFocus(EventArgs e)

Parameters

Overrides RadControl.OnGotFocus(EventArgs)

Handles the key down event by delegating it to the input handler.

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Overrides RadControl.OnKeyDown(KeyEventArgs)

Handles the key press event by delegating it to the input handler.

Declaration

protected override void OnKeyPress(KeyPressEventArgs e)

Parameters

Overrides RadControl.OnKeyPress(KeyPressEventArgs)

Handles the key up event by delegating it to the input handler.

Declaration

protected override void OnKeyUp(KeyEventArgs e)

Parameters

Overrides RadControl.OnKeyUp(KeyEventArgs)

Called when the control is loaded to initialize the editor element.

Declaration

protected override void OnLoad(Size desiredSize)

Parameters

Overrides RadControl.OnLoad(Size)

Handles the event that occurs when the control loses focus, hiding the text cursor.

Declaration

protected override void OnLostFocus(EventArgs e)

Parameters

Overrides RadControl.OnLostFocus(EventArgs)

Called when the control's theme changes to update visual elements accordingly.

Declaration

protected override void OnThemeChanged()

Overrides RadControl.OnThemeChanged()

Scrolls the editor content down by one page (viewport height).

Declaration

public void PageDown()

Scrolls the editor content up by one page (viewport height).

Declaration

public void PageUp()

Processes a dialog character, allowing Alt key combinations to be handled by dialogs.

Declaration

protected override bool ProcessDialogChar(char charCode)

Parameters

Returns

Overrides Control.ProcessDialogChar(char)

Processes a mnemonic character, which the editor does not support.

Declaration

protected override bool ProcessMnemonic(char charCode)

Parameters

Returns

Overrides RadControl.ProcessMnemonic(char)

Scales the control and its child elements according to the specified scaling factor.

Declaration

protected override void ScaleControl(SizeF factor, BoundsSpecified specified)

Parameters

Overrides RadControl.ScaleControl(SizeF, BoundsSpecified)

Selects all text in the editor.

Declaration

public void SelectAll()

Refreshes the visual representation of the current text selection in the editor.

Declaration

public void UpdateSelection()

Increases the zoom level (scale factor) of the editor by one step.

Declaration

public void ZoomIn()

Decreases the zoom level (scale factor) of the editor by one step.

Declaration

public void ZoomOut()

Sets the editor to a specific zoom level (scale factor). The minimum supported zoom level is 0.2 and the maximum supported is 4.

Declaration

public void ZoomTo(double zoomLevel)

Parameters

Exceptions

Occurs when a command execution results in an error.

Declaration

public event EventHandler<CommandErrorEventArgs> CommandError

Event Value

Occurs after a command has been successfully executed.

Declaration

public event EventHandler<CommandExecutedEventArgs> CommandExecuted

Event Value

Occurs before a command is executed, allowing you to cancel or modify the command execution.

Declaration

public event EventHandler<CommandExecutingEventArgs> CommandExecuting

Event Value

Occurs after the document has been changed, such as when a new document is loaded or created.

Declaration

public event EventHandler DocumentChanged

Event Value

Occurs before the document is changed, allowing you to perform actions before a new document is loaded.

Declaration

public event EventHandler DocumentChanging

Event Value

Occurs after the text content of the document has been modified, providing information about the changes made.

Declaration

public event EventHandler<TextContentChangedEventArgs> DocumentContentChanged

Event Value

Occurs before the text content of the document is modified, allowing you to cancel or modify the changes.

Declaration

public event EventHandler<TextContentChangingEventArgs> DocumentContentChanging

Event Value

Occurs when the read-only state of the editor changes.

Declaration

public event EventHandler IsReadOnlyChanged

Event Value

Occurs when the layout properties of the editor change, affecting how text is displayed.

Declaration

public event EventHandler LayoutPropertiesChanged

Event Value

Occurs before text input is processed by the syntax editor, allowing you to intercept and modify the input.

Declaration

public event EventHandler<PreviewSyntaxEditorInputEventArgs> PreviewSyntaxEditorInput

Event Value

Occurs before a key down event is processed by the syntax editor, allowing you to intercept and handle keyboard input.

Declaration

public event EventHandler<PreviewSyntaxEditorKeyEventArgs> PreviewSyntaxEditorKeyDown

Event Value

Occurs before a key up event is processed by the syntax editor, allowing you to intercept and handle keyboard input.

Declaration

public event EventHandler<PreviewSyntaxEditorKeyEventArgs> PreviewSyntaxEditorKeyUp

Event Value

Occurs before a mouse left button down event is processed by the syntax editor, allowing you to intercept and handle mouse input.

Declaration

public event EventHandler<PreviewSyntaxEditorMouseButtonEventArgs> PreviewSyntaxEditorMouseLeftButtonDown

Event Value

Occurs before a mouse right button down event is processed by the syntax editor, allowing you to intercept and handle context menu actions.

Declaration

public event EventHandler<PreviewSyntaxEditorMouseButtonEventArgs> PreviewSyntaxEditorMouseRightButtonDown

Event Value

Occurs when the scaling factor of the editor changes, affecting the size of text and UI elements.

Declaration

public event EventHandler ScaleFactorChanged

Event Value

Occurs when the text selection in the editor changes, either by user interaction or programmatically.

Declaration

public event EventHandler SelectionChanged

Event Value

Occurs when the visible area (viewport) of the editor changes, such as during scrolling or resizing.

Declaration

public event EventHandler ViewportChanged

Event Value