Class

RadSyntaxEditorElement

Initializes a new instance of the RadSyntaxEditorElement class with default settings for syntax highlighting and text editing.

Declaration

public RadSyntaxEditorElement()

Registers the AcceptsReturn property.

Declaration

public static readonly RadProperty AcceptsReturnProperty

Field Value

Registers the AllowScaling dependency property.

Declaration

public static readonly RadProperty AllowScalingProperty

Field Value

Declaration

public static readonly RadProperty BorderColorProperty

Field Value

Registers the CaretBrush dependency property.

Declaration

public static readonly RadProperty CaretBrushProperty

Field Value

Declaration

public static readonly string DEFAULT_NAMESPACE

Field Value

Registers the EditorFontFamily dependency property.

Declaration

public static readonly RadProperty EditorFontFamilyProperty

Field Value

Registers the EditorFontSize dependency property.

Declaration

public static readonly RadProperty EditorFontSizeProperty

Field Value

Registers the dependency property.

Declaration

public static readonly RadProperty EditorFontStretchProperty

Field Value

Registers the dependency property.

Declaration

public static readonly RadProperty EditorFontStyleProperty

Field Value

Registers the dependency property.

Declaration

public static readonly RadProperty EditorFontWeightProperty

Field Value

Registers the HorizontalScrollBarVisibility dependency property.

Declaration

public static readonly RadProperty HorizontalScrollBarVisibilityProperty

Field Value

Registers the IndentProvider property.

Declaration

public static readonly RadProperty IndentProviderProperty

Field Value

Registers the InsertMode property.

Declaration

public static readonly RadProperty InsertModeProperty

Field Value

Registers the IsCaretVisible dependency property.

Declaration

public static readonly RadProperty IsCaretVisibleProperty

Field Value

Registers the IsReadOnly property.

Declaration

public static readonly RadProperty IsReadOnlyProperty

Field Value

Registers the IsSelectionEnabled dependency property.

Declaration

public static readonly RadProperty IsSelectionEnabledProperty

Field Value

Registers the IsWordWrapEnabledProperty dependency property.

Declaration

public static readonly RadProperty IsWordWrapEnabledProperty

Field Value

Registers the Palette dependency property.

Declaration

public static readonly RadProperty PaletteProperty

Field Value

Registers the ScaleFactor dependency property.

Declaration

public static readonly RadProperty ScaleFactorProperty

Field Value

Declaration

public static readonly RadProperty SelectionFillColorProperty

Field Value

Registers the SelectionFill dependency property.

Declaration

public static readonly RadProperty SelectionFillProperty

Field Value

Declaration

public static readonly RadProperty SelectionStrokeColorProperty

Field Value

Registers the SelectionStroke dependency property.

Declaration

public static readonly RadProperty SelectionStrokeProperty

Field Value

Registers the ShouldTaggersProcessEntireLinesProperty dependency property.

Declaration

public static readonly RadProperty ShouldTaggersProcessEntireLinesProperty

Field Value

Registers the ShowLineNumbers dependency property.

Declaration

public static readonly RadProperty ShowLineNumbersProperty

Field Value

Registers the VerticalScrollBarVisibility dependency property.

Declaration

public static readonly RadProperty VerticalScrollBarVisibilityProperty

Field Value

Gets or sets a value indicating whether [accepts return].

Declaration

public bool AcceptsReturn { get; set; }

Property Value

Gets or sets a value indicating whether the content of the syntax editor can be scaled (zoomed in or out).

Declaration

public bool AllowScaling { get; set; }

Property Value

Gets or sets the color of the border around the syntax editor.

Declaration

[VsbBrowsable(true)]
public Color BorderColor { get; set; }

Property Value

Gets or sets the brush used to render the text cursor (caret) in the syntax editor.

Declaration

public Brush CaretBrush { get; set; }

Property Value

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

Declaration

public Color CaretColor { get; set; }

Property Value

Gets or sets the visual style of the text cursor (caret) in the syntax editor, such as block, underline, or normal vertical line.

Declaration

public CaretDisplayMode CaretDisplayMode { get; set; }

Property Value

Gets the current position of the text cursor (caret) within the document.

Declaration

public CaretPosition CaretPosition { get; }

Property Value

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

Declaration

public double CaretWidth { get; set; }

Property Value

Gets the collection of available editor commands that can be executed on this syntax editor.

Declaration

public SyntaxEditorCommands Commands { get; }

Property Value

Gets or sets the current insert mode.

Declaration

public string CurrentInsertMode { get; set; }

Property Value

Gets or sets the text document that is being displayed and edited in the syntax editor.

Declaration

public TextDocument Document { get; set; }

Property Value

Implements ITextDocumentEditor.Document

Gets or sets the font family used to render text in the syntax editor.

Declaration

public FontFamily EditorFontFamily { get; set; }

Property Value

Gets or sets the font size used to render text in the syntax editor.

Declaration

public double EditorFontSize { get; set; }

Property Value

Gets the presenter component responsible for rendering and displaying the text content in the syntax editor.

Declaration

public SyntaxEditorPresenter EditorPresenter { get; }

Property Value

Gets the component responsible for handling code folding functionality, allowing collapsing and expanding of code regions.

Declaration

public FoldingManager FoldingManager { get; }

Property Value

Gets the horizontal scroll bar element that enables scrolling through content that extends beyond the visible width of the editor.

Declaration

public RadScrollBarElement HorizontalScrollBar { get; }

Property Value

Gets or sets the indent provider.

Declaration

public ISmartIndentProvider IndentProvider { get; set; }

Property Value

Gets or sets an instance of SyntaxEditorInputBehavior that will handle user input.

Declaration

public SyntaxEditorInputBehavior InputHandler { get; set; }

Property Value

Gets the intelli prompts.

Declaration

public SyntaxEditorIntelliPrompts IntelliPrompts { get; }

Property Value

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

Declaration

public bool IsCaretVisible { get; set; }

Property Value

Gets a value indicating whether this instance is in undo group.

Declaration

public bool IsInUndoGroup { get; }

Property Value

Gets or sets a value indicating whether this instance is overwrite mode enabled.

Declaration

public bool IsOverwriteModeEnabled { get; set; }

Property Value

Gets or sets a value indicating whether this instance is read only.

Declaration

public bool IsReadOnly { get; set; }

Property Value

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

Declaration

public bool IsSelectionEnabled { get; set; }

Property Value

Gets or sets a value indicating whether text should automatically wrap to the next line when it exceeds the width of the editor.

Declaration

public bool IsWordWrapEnabled { get; set; }

Property Value

Gets the margins collection that defines the space around the text content in the syntax editor.

Declaration

public SyntaxEditorMargins Margins { get; }

Property Value

Gets or sets the palette of syntax elements' colors used for this RadSyntaxEditorElement instance.

Declaration

public SyntaxEditorPalette Palette { get; set; }

Property Value

Gets the collection of properties that control the behavior and appearance of the syntax editor.

Declaration

public SyntaxEditorProperties Properties { get; }

Property Value

Gets or sets the zoom level of the syntax editor content as a multiplier value (1.0 is normal size, 2.0 is double size, etc.).

Declaration

public double ScaleFactor { get; set; }

Property Value

Gets the popup control that provides find and replace functionality in the editor.

Declaration

public FindReplacePopup SearchPanel { get; }

Property Value

Gets the selection.

Declaration

public Selection Selection { get; }

Property Value

Gets or sets the selection fill.

Declaration

public Brush SelectionFill { get; set; }

Property Value

Gets or sets the selection stroke.

Declaration

public Brush SelectionStroke { get; set; }

Property Value

Gets or sets a value indicating whether line numbers are displayed in the margin of the syntax editor.

Declaration

public bool ShowLineNumbers { get; set; }

Property Value

Gets the registry of taggers that provide syntax highlighting and other text analysis functionality for the editor.

Declaration

public TaggersRegistry TaggersRegistry { get; }

Property Value

Gets the stack of text format definitions that control the visual appearance of text in the syntax editor.

Declaration

public TextFormatDefinitionStack TextFormatDefinitions { get; }

Property Value

Gets or sets the builder component responsible for creating and managing the visual layers in the syntax editor.

Declaration

public UILayersBuilder UILayersBuilder { get; set; }

Property Value

Gets or sets a value indicating whether to apply rendering optimizations for monospaced fonts in the syntax editor.

Declaration

public bool UseMonospacedFontOptimization { get; set; }

Property Value

Gets or sets a value indicating whether the Shift key is required to extend text selection with arrow keys.

Declaration

public bool UseShiftKeyInSelection { get; set; }

Property Value

Gets the vertical scroll bar element that controls scrolling through the document vertically.

Declaration

public RadScrollBarElement VerticalScrollBar { get; }

Property Value

Gets the visible rectangular area of the document currently displayed in the editor.

Declaration

public Rect Viewport { get; }

Property Value

Gets the drop-down list element that allows selecting different zoom levels for the editor content.

Declaration

public RadDropDownListElement ZoomComboBox { get; }

Property Value

Applies any cached property values to the syntax editor element.

Declaration

protected virtual void ApplyCachedProperties(bool clearCache = true)

Parameters

Arranges the inner margins of the editor content area.

Declaration

protected virtual RectangleF ArrangeInnerMargins(RectangleF clientRect)

Parameters

Returns

Arranges the outer margins of the editor within the available client rectangle.

Declaration

protected virtual RectangleF ArrangeOuterMargins(RectangleF clientRect)

Parameters

Returns

Arranges the syntax editor element and its children within the final allocated area.

Declaration

protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

Returns

Overrides RadElement.ArrangeOverride(SizeF)

Backspaces this instance.

Declaration

public void Backspace()

Begins the undo group.

Declaration

public void BeginUndoGroup()

Cancels the undo group.

Declaration

public void CancelUndoGroup()

Closes the find dialog.

Declaration

public void CloseFindDialog()

Completes the code.

Declaration

public void CompleteCode()

Copies the current selection to the clipboard. If no text is selected, copies the entire current line.

Declaration

public void Copy()

Creates a new syntax editor presenter that will display and manage the text content.

Declaration

protected virtual SyntaxEditorPresenter CrateSyntaxEditorPresenter()

Returns

Creates the child elements that make up the structure of the editor.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Creates the state of the code editor history.

Declaration

public SyntaxEditorHistoryState CreateSyntaxEditorHistoryState()

Returns

Creates the zoom drop-down element used for scaling the editor content.

Declaration

protected virtual RadDropDownListElement CreateZoomElement()

Returns

Cuts this instance.

Declaration

public void Cut()

Decreases the line indent.

Declaration

public void DecreaseLineIndent()

Deletes this instance.

Declaration

public void Delete()

Deletes the full line.

Declaration

public void DeleteFullLine()

Deletes the word to left.

Declaration

public void DeleteWordToLeft()

Deletes the word to right.

Declaration

public void DeleteWordToRight()

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

Declaration

public void Dispose()

Implements IDisposable.Dispose()

Releases unmanaged and - optionally - managed resources.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Ends the undo group.

Declaration

public void EndUndoGroup()

Finds the specified search text.

Declaration

public Span? Find(string searchText, int startIndex)

Parameters

Returns

Finds the specified search text.

Declaration

public Span? Find(string searchText, int startIndex, bool useRegularExpression)

Parameters

Returns

Finds the specified search text.

Declaration

public Span? Find(string searchText, int startIndex, bool matchCase, bool useRegularExpression)

Parameters

Returns

Finds all spans.

Declaration

public IEnumerable<Span> FindAll(string searchText)

Parameters

Returns

Finds all spans.

Declaration

public IEnumerable<Span> FindAll(string searchText, bool useRegularExpression)

Parameters

Returns

Finds all spans.

Declaration

public IEnumerable<Span> FindAll(string searchText, bool matchCase, bool useRegularExpression)

Parameters

Returns

Finds the specified search text before the current index.

Declaration

public Span? FindPrevious(string searchText, int startIndex, bool matchCase)

Parameters

Returns

Calculates the content rectangle based on the available space, accounting for scroll bars and other elements.

Declaration

protected virtual RectangleF GetContentRect(RectangleF availableRect)

Parameters

Returns

Gets the bounding rectangle for a specific line in the document.

Declaration

public Rect GetLineBoundingRectangleByLineNumber(int lineNumber, bool cutToBaseline = false)

Parameters

Returns

Gets the bounding rectangle for a specific portion of text within the document.

Declaration

public Rect GetLinePartBoundingRectangle(Span span, bool cutToBaseline = false)

Parameters

Returns

Converts a document caret position to screen coordinates in the editor.

Declaration

public Point GetPointFromPosition(CaretPosition position)

Parameters

Returns

Converts a screen coordinate point to a document caret position.

Declaration

public CaretPosition GetPositionFromControlPoint(Point point)

Parameters

Returns

Gets the text between the specified start and end positions.

Declaration

public string GetText(CaretPosition start, CaretPosition end)

Parameters

Returns

Gets the text within the current word which is to the left of the caret.

Declaration

public string GetWordToLeft()

Returns

Gets the text within the current word which is to the right of the caret.

Declaration

public string GetWordToRight()

Returns

Tries to highlight all span matches via all registered TextSearchHighlightTaggers.

Declaration

public void HighlightAllMatches(string searchText)

Parameters

Increases the line indent.

Declaration

public void IncreaseLineIndent()

Indents this instance.

Declaration

public void Indent()

Initializes the default field values for the editor element.

Declaration

protected override void InitializeFields()

Overrides FrameworkElement.InitializeFields()

Inserts the specified text.

Declaration

public void Insert(string text)

Parameters

Inserts the new line.

Declaration

public void InsertNewLine()

Inserts the tab.

Declaration

public void InsertTab()

Invalidates the layout of the editor, forcing a recalculation of text positions and visual elements.

Declaration

public void InvalidateEditorLayout()

Invalidates the layout of the editor, forcing a recalculation of text positions and visual elements.

Declaration

public void InvalidateEditorLayout(bool force)

Parameters

Measures the inner margins of the editor content area.

Declaration

protected virtual RectangleF MeasureInnerMargins(RectangleF clientRect)

Parameters

Returns

Measures the outer margins of the editor within the available client rectangle.

Declaration

protected virtual RectangleF MeasureOuterMargins(RectangleF clientRect)

Parameters

Returns

Measures the desired size of the syntax editor element based on the available space.

Declaration

protected override SizeF MeasureOverride(SizeF availableSize)

Parameters

Returns

Overrides FrameworkElement.MeasureOverride(SizeF)

Moves the current line to top.

Declaration

public void MoveCurrentLineToTop()

Navigates to the next matched text in the editor.

Declaration

public void NavigateNextMatch(string searchText)

Parameters

Navigates to the next matched text in the editor.

Declaration

public void NavigatePreviousMatch(string searchText)

Parameters

When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate().

Declaration

public override void OnApplyTemplate()

Overrides FrameworkElement.OnApplyTemplate()

Raises the CommandError event when a command execution results in an error.

Declaration

protected virtual void OnCommandError(CommandErrorEventArgs args)

Parameters

Raises the CommandExecuted event after a command has been successfully executed in the syntax editor.

Declaration

protected virtual void OnCommandExecuted(CommandExecutedEventArgs e)

Parameters

Raises the CommandExecuting event before a command is executed, allowing subscribers to cancel or modify the command execution.

Declaration

protected virtual void OnCommandExecuting(CommandExecutingEventArgs args)

Parameters

Called when the document in the syntax editor has changed, raising the DocumentChanged event.

Declaration

protected virtual void OnDocumentChanged()

Called before the document in the syntax editor changes, raising the DocumentChanging event.

Declaration

protected virtual void OnDocumentChanging()

Handles the event.

Declaration

protected virtual void OnDocumentContentChanged(TextContentChangedEventArgs args)

Parameters

Handles the event.

Declaration

protected virtual void OnDocumentContentChanging(TextContentChangingEventArgs args)

Parameters