Class

RadSyntaxEditor

Initializes a new instance of the RadSyntaxEditor class.

Declaration

[SuppressMessage("Microsoft.Usage", "CA2214:DoNotCallOverridableMethodsInConstructors")]
public RadSyntaxEditor()

Registers the AcceptsReturn property.

Declaration

public static readonly DependencyProperty AcceptsReturnProperty

Field Value

Registers the AllowScaling dependency property.

Declaration

public static readonly DependencyProperty AllowScalingProperty

Field Value

Registers the AutoScrollToCaretOnTextChange dependency property.

Declaration

public static readonly DependencyProperty AutoScrollToCaretOnTextChangeProperty

Field Value

Registers the CaretBrush dependency property.

Declaration

public static readonly DependencyProperty CaretBrushProperty

Field Value

Registers the EditorFontFamily dependency property.

Declaration

public static readonly DependencyProperty EditorFontFamilyProperty

Field Value

Registers the EditorFontSize dependency property.

Declaration

public static readonly DependencyProperty EditorFontSizeProperty

Field Value

Registers the HorizontalScrollBarVisibility dependency property.

Declaration

public static readonly DependencyProperty HorizontalScrollBarVisibilityProperty

Field Value

Registers the IndentProvider property.

Declaration

public static readonly DependencyProperty IndentProviderProperty

Field Value

Registers the InsertMode property.

Declaration

public static readonly DependencyProperty InsertModeProperty

Field Value

Registers the IsCaretVisible dependency property.

Declaration

public static readonly DependencyProperty IsCaretVisibleProperty

Field Value

Registers the IsReadOnly property.

Declaration

public static readonly DependencyProperty IsReadOnlyProperty

Field Value

Registers the IsSelectionEnabled dependency property.

Declaration

public static readonly DependencyProperty IsSelectionEnabledProperty

Field Value

Registers the IsWordWrapEnabled dependency property.

Declaration

public static readonly DependencyProperty IsWordWrapEnabledProperty

Field Value

Registers the Palette dependency property.

Declaration

public static readonly DependencyProperty PaletteProperty

Field Value

Registers the ScaleFactor dependency property.

Declaration

public static readonly DependencyProperty ScaleFactorProperty

Field Value

Registers the SearchPanelWidth dependency property.

Declaration

public static readonly DependencyProperty SearchPanelWidthProperty

Field Value

Registers the SelectionFill dependency property.

Declaration

public static readonly DependencyProperty SelectionFillProperty

Field Value

Registers the SelectionStroke dependency property.

Declaration

public static readonly DependencyProperty SelectionStrokeProperty

Field Value

Registers the ShouldTaggersProcessEntireLines dependency property.

Declaration

public static readonly DependencyProperty ShouldTaggersProcessEntireLinesProperty

Field Value

Registers the VerticalScrollBarVisibility dependency property.

Declaration

public static readonly DependencyProperty 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 [allow scaling].

Declaration

public bool AllowScaling { get; set; }

Property Value

Gets or sets a value indicating whether the document is automatically scrolled to the CaretPosition when the text inside the document is changed.

Declaration

public bool AutoScrollToCaretOnTextChange { get; set; }

Property Value

Gets or sets the brush of the active caret in the editor.

Declaration

public Brush CaretBrush { get; set; }

Property Value

Gets or sets the caret display mode.

Declaration

public CaretDisplayMode CaretDisplayMode { get; set; }

Property Value

Gets the caret position.

Declaration

public CaretPosition CaretPosition { get; }

Property Value

Gets the commands.

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.

Declaration

public TextDocument Document { get; set; }

Property Value

Implements ITextDocumentEditor.Document

Gets or sets a value indicating the font family of the text editor.

Declaration

public FontFamily EditorFontFamily { get; set; }

Property Value

Gets or sets a value indicating the font size of the text editor.

Declaration

public double EditorFontSize { get; set; }

Property Value

Gets the editor presenter.

Declaration

public SyntaxEditorPresenter EditorPresenter { get; }

Property Value

Gets the folding manager.

Declaration

public FoldingManager FoldingManager { get; }

Property Value

Gets the horizontal scroll bar.

Declaration

public ScrollBar HorizontalScrollBar { get; }

Property Value

Gets or sets the horizontal scroll bar visibility.

Declaration

public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }

Property Value

Gets or sets the indent provider.

Declaration

public ISmartIndentProvider IndentProvider { get; set; }

Property Value

Gets the intelli prompts.

Declaration

public SyntaxEditorIntelliPrompts IntelliPrompts { get; }

Property Value

Gets or sets a value indicating whether this instance is caret visible.

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 this instance is selection enabled.

Declaration

public bool IsSelectionEnabled { get; set; }

Property Value

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

Declaration

public bool IsWordWrapEnabled { get; set; }

Property Value

Gets the key bindings.

Declaration

public KeyBindingUtilities KeyBindings { get; }

Property Value

Gets the margins.

Declaration

public SyntaxEditorMargins Margins { get; }

Property Value

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

Declaration

public SyntaxEditorPalette Palette { get; set; }

Property Value

Gets the properties.

Declaration

public SyntaxEditorProperties Properties { get; }

Property Value

Gets or sets the scale factor.

Declaration

public double ScaleFactor { get; set; }

Property Value

Gets or sets a value indicating the width of the search panel.

Declaration

public double SearchPanelWidth { get; set; }

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 whether taggers are given the entire lines of text (true) or only the currently visible in the viewport part of the text (false) for processing. Default value is false.

Declaration

public bool ShouldTaggersProcessEntireLines { get; set; }

Property Value

Gets the taggers registry.

Declaration

public TaggersRegistry TaggersRegistry { get; }

Property Value

Gets the text format definitions.

Declaration

public TextFormatDefinitionStack TextFormatDefinitions { get; }

Property Value

Gets or sets a value indicating the touch drag area around a touch selection marker.

Declaration

public double TouchMarkerDragDistance { get; set; }

Property Value

Gets or sets the UI layers builder.

Declaration

public UILayersBuilder UILayersBuilder { get; set; }

Property Value

Gets or sets a value indicating whether [use monospaced font optimization].

Declaration

[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Monospaced")]
public bool UseMonospacedFontOptimization { get; set; }

Property Value

Gets or sets a value indicating whether [use shift key in selection].

Declaration

public bool UseShiftKeyInSelection { get; set; }

Property Value

Gets the vertical scroll bar.

Declaration

public ScrollBar VerticalScrollBar { get; }

Property Value

Gets or sets the vertical scroll bar visibility.

Declaration

public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }

Property Value

Gets the viewport.

Declaration

public Rect Viewport { get; }

Property Value

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 this instance.

Declaration

public void Copy()

Creates the state of the code editor history.

Declaration

public SyntaxEditorHistoryState CreateSyntaxEditorHistoryState()

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 the specified search text.

Declaration

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

Parameters

Returns

Finds all spans with the given searchText.

Declaration

public IEnumerable<Span> FindAll(string searchText)

Parameters

Returns

Finds all spans with the given searchText or regex pattern.

Declaration

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

Parameters

Returns

Finds all spans with the given searchText or regex pattern.

Declaration

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

Parameters

Returns

Finds all spans with the given searchText or regex pattern.

Declaration

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

Parameters

Returns

Finds the specified search text before the current index.

Declaration

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

Parameters

Returns

Finds the specified search text before the current index.

Declaration

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

Parameters

Returns

Gets the line bounding rectangle by line number.

Declaration

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

Parameters

Returns

Gets the line part bounding rectangle.

Declaration

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

Parameters

Returns

Gets the point from position.

Declaration

public Point GetPointFromPosition(CaretPosition position)

Parameters

Returns

Gets the position from point.

Declaration

public CaretPosition GetPositionFromPoint(Point point)

Parameters

Returns

Navigates to the line by number.

Declaration

public void GotoLine(int lineNumber, bool focusSyntaxEditor = false)

Parameters

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()

Called when touch manager methods are being initialized for the SyntaxEditorPresenter.

Declaration

protected virtual void InitializeTouch(SyntaxEditorPresenter presenter)

Parameters

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 editor layout.

Declaration

public void InvalidateEditorLayout()

Invalidates the editor layout.

Declaration

public void InvalidateEditorLayout(bool force)

Parameters

Called when control is measured.

Declaration

protected override Size MeasureOverride(Size constraint)

Parameters

Returns

Moves the current line to bottom.

Declaration

[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void MoveCurrentLineToBottom()

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 .

Declaration

public override void OnApplyTemplate()

Handles the event.

Declaration

protected virtual void OnCommandError(CommandErrorEventArgs args)

Parameters

Handles the event.

Declaration

protected virtual void OnCommandExecuted(CommandExecutedEventArgs e)

Parameters

Handles the event.

Declaration

protected virtual void OnCommandExecuting(CommandExecutingEventArgs args)

Parameters

Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Called when [document changed].

Declaration

protected virtual void OnDocumentChanged()

Called when [document changing].

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

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

Declaration

protected override void OnGotFocus(RoutedEventArgs e)

Parameters

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

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

Handles the event.

Declaration

protected virtual void OnIsReadOnlyChanged(EventArgs e)

Parameters

Called when [layout properties changed].

Declaration

protected virtual void OnLayoutPropertiesChanged()

Called when mouse wheel zoom is requested.

Declaration

protected virtual bool OnMouseWheelZoom(double delta)

Parameters

Returns

Handles the event.

Declaration

protected virtual void OnPreviewSyntaxEditorInput(PreviewSyntaxEditorInputEventArgs args)

Parameters

Handles the event.

Declaration

protected virtual void OnPreviewSyntaxEditorKeyDown(PreviewSyntaxEditorKeyEventArgs args)

Parameters

Handles the event.

Declaration

protected virtual void OnPreviewSyntaxEditorKeyUp(PreviewSyntaxEditorKeyEventArgs args)

Parameters

Handles the event.

Declaration

protected virtual void OnPreviewSyntaxEditorMouseLeftButtonDown(PreviewSyntaxEditorMouseButtonEventArgs args)

Parameters

Handles the event.

Declaration

protected virtual void OnPreviewSyntaxEditorMouseRightButtonDown(PreviewSyntaxEditorMouseButtonEventArgs args)

Parameters

Occurs when property changes.

Declaration

protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)

Parameters

Called when [scale factor changed].

Declaration

protected virtual void OnScaleFactorChanged()

Called when search panel is closed.

Declaration

protected virtual void OnSearchPanelClosed()

Called when search panel is opened.

Declaration

protected virtual void OnSearchPanelOpened()

Called when the selection changes.

Declaration

protected virtual void OnSelectionChanged()

Handles the event.

Declaration

protected virtual void OnTextSearched(TextSearchedEventArgs args)

Parameters

Called when [viewport changed].

Declaration

protected virtual void OnViewportChanged()

Opens the find dialog with the specified searchText in the search textbox.

Declaration

public void OpenFindDialog(string searchText)

Parameters

Pages down.

Declaration

public void PageDown()

Pages up.

Declaration

public void PageUp()

Pastes this instance.

Declaration

public void Paste()

Redoes this instance.

Declaration

public bool Redo()

Returns

Replaces all matches.

Declaration

public int ReplaceAllMatches(string searchText, string replaceText, bool matchCase, bool useRegularExpression)

Parameters

Returns

Replaces all matches.

Declaration

public int ReplaceAllMatches(string searchText, string replaceText, bool matchCase, bool useRegularExpression, bool matchWord)

Parameters

Returns

Replaces the next match.

Declaration

public bool ReplaceNextMatch(string searchText, int startIndex, string replaceText, bool matchCase, bool useRegularExpression)

Parameters

Returns

Restores the state of the code editor history.

Declaration

public void RestoreSyntaxEditorHistoryState(SyntaxEditorHistoryState historyState)

Parameters

Selects all.

Declaration

public void SelectAll()

Toggles the insert mode.

Declaration

public void ToggleInsertMode()

Undoes this instance.

Declaration

public bool Undo()

Returns

Unindents this instance.

Declaration

public void Unindent()

Updates the selection.

Declaration

public void UpdateSelection()

Zooms in.

Declaration

public void ZoomIn(double zoomFactor = 1.1)

Parameters

Zooms out.

Declaration

public void ZoomOut(double zoomFactor = 0.91)

Parameters

Zooms to particular zoom level.

Declaration

public void ZoomTo(double zoomLevel)

Parameters

Exceptions

Occurs when command error is produced.

Declaration

public event EventHandler<CommandErrorEventArgs> CommandError

Event Value

Occurs when command is executed.

Declaration

public event EventHandler<CommandExecutedEventArgs> CommandExecuted

Event Value

Occurs when command is executing.

Declaration

public event EventHandler<CommandExecutingEventArgs> CommandExecuting

Event Value

Occurs when document has been changed.

Declaration

public event EventHandler DocumentChanged

Event Value

Implements ITextDocumentEditor.DocumentChanged

Occurs when document is being changed.

Declaration

public event EventHandler DocumentChanging

Event Value

Implements ITextDocumentEditor.DocumentChanging

DocumentContentChanged event.

Declaration

public event EventHandler<TextContentChangedEventArgs> DocumentContentChanged

Event Value

Implements ITextDocumentEditor.DocumentContentChanged

DocumentContentChanging event.

Declaration

public event EventHandler<TextContentChangingEventArgs> DocumentContentChanging

Event Value

Occurs when the readonly state has changed.

Declaration

public event EventHandler IsReadOnlyChanged

Event Value

Occurs when layout properties are changed.

Declaration

public event EventHandler LayoutPropertiesChanged

Event Value

Occurs when text input in the syntax editor is starting.

Declaration

public event EventHandler<PreviewSyntaxEditorInputEventArgs> PreviewSyntaxEditorInput

Event Value

Occurs when key down is pressed.

Declaration

public event EventHandler<PreviewSyntaxEditorKeyEventArgs> PreviewSyntaxEditorKeyDown

Event Value

Occurs when a key is released.

Declaration

public event EventHandler<PreviewSyntaxEditorKeyEventArgs> PreviewSyntaxEditorKeyUp

Event Value

Occurs when mouse left button down is pressed.

Declaration

public event EventHandler<PreviewSyntaxEditorMouseButtonEventArgs> PreviewSyntaxEditorMouseLeftButtonDown

Event Value

Occurs when mouse right button down is pressed.

Declaration

public event EventHandler<PreviewSyntaxEditorMouseButtonEventArgs> PreviewSyntaxEditorMouseRightButtonDown

Event Value

Occurs when scale factor changes.

Declaration

public event EventHandler ScaleFactorChanged

Event Value

Occurs when the search panel is closed.

Declaration

public event EventHandler SearchPanelClosed

Event Value

Occurs when the search panel is opened.

Declaration

public event EventHandler SearchPanelOpened

Event Value

Occurs when the selection of the control changes.

Declaration

public event EventHandler SelectionChanged

Event Value

Occurs when a text is searched in the control.

Declaration

public event EventHandler<TextSearchedEventArgs> TextSearched

Event Value

Occurs when the viewport changes.

Declaration

public event EventHandler ViewportChanged

Event Value