Documentation

Class RadSyntaxEditorElement

Class RadSyntaxEditor. Implements the ITextDocumentEditor

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
UIElement
FrameworkElement
RadSyntaxEditorElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.SyntaxEditor.dll

Syntax

public class RadSyntaxEditorElement : FrameworkElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IStylableNode, ISupportDrop, ITextDocumentEditor, IDisposable

Constructors

RadSyntaxEditorElement()

Initializes a new instance of the RadSyntaxEditorElement class.

Declaration
public RadSyntaxEditorElement()

Fields

AcceptsReturnProperty

Registers the AcceptsReturn property.

Declaration
public static readonly RadProperty AcceptsReturnProperty
Field Value
RadProperty

AllowScalingProperty

Registers the AllowScaling dependency property.

Declaration
public static readonly RadProperty AllowScalingProperty
Field Value
RadProperty

BorderColorProperty

Declaration
public static readonly RadProperty BorderColorProperty
Field Value
RadProperty

CaretBrushProperty

Registers the CaretBrush dependency property.

Declaration
public static readonly RadProperty CaretBrushProperty
Field Value
RadProperty

DEFAULT_NAMESPACE

Declaration
public static readonly string DEFAULT_NAMESPACE
Field Value
System.String

EditorFontFamilyProperty

Registers the EditorFontFamily dependency property.

Declaration
public static readonly RadProperty EditorFontFamilyProperty
Field Value
RadProperty

EditorFontSizeProperty

Registers the EditorFontSize dependency property.

Declaration
public static readonly RadProperty EditorFontSizeProperty
Field Value
RadProperty

EditorFontStretchProperty

Registers the Telerik.WinControls.UI.RadSyntaxEditorElement.EditorFontStretch dependency property.

Declaration
public static readonly RadProperty EditorFontStretchProperty
Field Value
RadProperty

EditorFontStyleProperty

Registers the Telerik.WinControls.UI.RadSyntaxEditorElement.EditorFontStyle dependency property.

Declaration
public static readonly RadProperty EditorFontStyleProperty
Field Value
RadProperty

EditorFontWeightProperty

Registers the Telerik.WinControls.UI.RadSyntaxEditorElement.EditorFontWeight dependency property.

Declaration
public static readonly RadProperty EditorFontWeightProperty
Field Value
RadProperty

HorizontalScrollBarVisibilityProperty

Registers the HorizontalScrollBarVisibility dependency property.

Declaration
public static readonly RadProperty HorizontalScrollBarVisibilityProperty
Field Value
RadProperty

IndentProviderProperty

Registers the IndentProvider property.

Declaration
public static readonly RadProperty IndentProviderProperty
Field Value
RadProperty

InsertModeProperty

Registers the InsertMode property.

Declaration
public static readonly RadProperty InsertModeProperty
Field Value
RadProperty

IsCaretVisibleProperty

Registers the IsCaretVisible dependency property.

Declaration
public static readonly RadProperty IsCaretVisibleProperty
Field Value
RadProperty

IsReadOnlyProperty

Registers the IsReadOnly property.

Declaration
public static readonly RadProperty IsReadOnlyProperty
Field Value
RadProperty

IsSelectionEnabledProperty

Registers the IsSelectionEnabled dependency property.

Declaration
public static readonly RadProperty IsSelectionEnabledProperty
Field Value
RadProperty

IsWordWrapEnabledProperty

Registers the IsWordWrapEnabledProperty dependency property.

Declaration
public static readonly RadProperty IsWordWrapEnabledProperty
Field Value
RadProperty

PaletteProperty

Registers the Palette dependency property.

Declaration
public static readonly RadProperty PaletteProperty
Field Value
RadProperty

ScaleFactorProperty

Registers the ScaleFactor dependency property.

Declaration
public static readonly RadProperty ScaleFactorProperty
Field Value
RadProperty

SelectionFillColorProperty

Declaration
public static readonly RadProperty SelectionFillColorProperty
Field Value
RadProperty

SelectionFillProperty

Registers the SelectionFill dependency property.

Declaration
public static readonly RadProperty SelectionFillProperty
Field Value
RadProperty

SelectionStrokeColorProperty

Declaration
public static readonly RadProperty SelectionStrokeColorProperty
Field Value
RadProperty

SelectionStrokeProperty

Registers the SelectionStroke dependency property.

Declaration
public static readonly RadProperty SelectionStrokeProperty
Field Value
RadProperty

ShouldTaggersProcessEntireLinesProperty

Registers the ShouldTaggersProcessEntireLinesProperty dependency property.

Declaration
public static readonly RadProperty ShouldTaggersProcessEntireLinesProperty
Field Value
RadProperty

ShowLineNumbersProperty

Registers the ShowLineNumbers dependency property.

Declaration
public static readonly RadProperty ShowLineNumbersProperty
Field Value
RadProperty

VerticalScrollBarVisibilityProperty

Registers the VerticalScrollBarVisibility dependency property.

Declaration
public static readonly RadProperty VerticalScrollBarVisibilityProperty
Field Value
RadProperty

Properties

AcceptsReturn

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

Declaration
public bool AcceptsReturn { get; set; }
Property Value
System.Boolean

true if [accepts return]; otherwise, false.

AllowScaling

Gets or sets a value indicating whether [allow scaling].

Declaration
public bool AllowScaling { get; set; }
Property Value
System.Boolean

true if [allow scaling]; otherwise, false.

BorderColor

Declaration
[VsbBrowsable(true)]
public Color BorderColor { get; set; }
Property Value
System.Drawing.Color

CaretBrush

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

Declaration
public Brush CaretBrush { get; set; }
Property Value
System.Drawing.Brush

CaretColor

Gets or sets the caret color.

Declaration
public Color CaretColor { get; set; }
Property Value
System.Drawing.Color

The caret color.

CaretDisplayMode

Gets or sets the caret display mode.

Declaration
public CaretDisplayMode CaretDisplayMode { get; set; }
Property Value
CaretDisplayMode

The caret display mode.

CaretPosition

Gets the caret position.

Declaration
public CaretPosition CaretPosition { get; }
Property Value
CaretPosition

The caret position.

CaretWidth

Gets or sets the caret width when the DisplayMode is set to Normal.

Declaration
public double CaretWidth { get; set; }
Property Value
System.Double

The caret width.

Commands

Gets the commands.

Declaration
public SyntaxEditorCommands Commands { get; }
Property Value
SyntaxEditorCommands

The commands.

CurrentInsertMode

Gets or sets the current insert mode.

Declaration
public string CurrentInsertMode { get; set; }
Property Value
System.String

The current insert mode.

Document

Gets or sets the text document.

Declaration
public TextDocument Document { get; set; }
Property Value
TextDocument

The document.
Implements

EditorFontFamily

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

Declaration
public FontFamily EditorFontFamily { get; set; }
Property Value
FontFamily

EditorFontSize

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

Declaration
public double EditorFontSize { get; set; }
Property Value
System.Double

EditorPresenter

Gets the editor presenter.

Declaration
public SyntaxEditorPresenter EditorPresenter { get; }
Property Value
SyntaxEditorPresenter

The editor presenter.

FoldingManager

Gets the folding manager.

Declaration
public FoldingManager FoldingManager { get; }
Property Value
FoldingManager

The folding manager.

HorizontalScrollBar

Gets the horizontal scroll bar.

Declaration
public RadScrollBarElement HorizontalScrollBar { get; }
Property Value
RadScrollBarElement

The horizontal scroll bar.

HorizontalScrollBarVisibility

Gets or sets the horizontal scroll bar visibility.

Declaration
public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }
Property Value
ScrollBarVisibility

The horizontal scroll bar visibility.

IndentProvider

Gets or sets the indent provider.

Declaration
public ISmartIndentProvider IndentProvider { get; set; }
Property Value
ISmartIndentProvider

The indent provider.

InputHandler

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

Declaration
public SyntaxEditorInputBehavior InputHandler { get; set; }
Property Value
SyntaxEditorInputBehavior

IntelliPrompts

Gets the intelli prompts.

Declaration
public SyntaxEditorIntelliPrompts IntelliPrompts { get; }
Property Value
SyntaxEditorIntelliPrompts

The intelli prompts.

IsCaretVisible

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

Declaration
public bool IsCaretVisible { get; set; }
Property Value
System.Boolean

true if this instance is caret visible; otherwise, false.

IsInUndoGroup

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

Declaration
public bool IsInUndoGroup { get; }
Property Value
System.Boolean

true if this instance is in undo group; otherwise, false.

IsOverwriteModeEnabled

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

Declaration
public bool IsOverwriteModeEnabled { get; set; }
Property Value
System.Boolean

true if this instance is overwrite mode enabled; otherwise, false.

IsReadOnly

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

Declaration
public bool IsReadOnly { get; set; }
Property Value
System.Boolean

true if this instance is read only; otherwise, false.

IsSelectionEnabled

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

Declaration
public bool IsSelectionEnabled { get; set; }
Property Value
System.Boolean

true if this instance is selection enabled; otherwise, false.

IsWordWrapEnabled

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

Declaration
public bool IsWordWrapEnabled { get; set; }
Property Value
System.Boolean

Margins

Gets the margins.

Declaration
public SyntaxEditorMargins Margins { get; }
Property Value
SyntaxEditorMargins

The margins.

Palette

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

Declaration
public SyntaxEditorPalette Palette { get; set; }
Property Value
SyntaxEditorPalette

Properties

Gets the properties.

Declaration
public SyntaxEditorProperties Properties { get; }
Property Value
SyntaxEditorProperties

The properties.

ScaleFactor

Gets or sets the scale factor.

Declaration
public double ScaleFactor { get; set; }
Property Value
System.Double

The scale factor.

SearchPanel

Declaration
public FindReplacePopup SearchPanel { get; }
Property Value
FindReplacePopup

Selection

Gets the selection.

Declaration
public Selection Selection { get; }
Property Value
Selection

The selection.

SelectionFill

Gets or sets the selection fill.

Declaration
public Brush SelectionFill { get; set; }
Property Value
System.Drawing.Brush

The selection fill.

SelectionFillColor

Declaration
[VsbBrowsable(true)]
public Color SelectionFillColor { get; set; }
Property Value
System.Drawing.Color

SelectionStroke

Gets or sets the selection stroke.

Declaration
public Brush SelectionStroke { get; set; }
Property Value
System.Drawing.Brush

The selection stroke.

SelectionStrokeColor

Declaration
[VsbBrowsable(true)]
public Color SelectionStrokeColor { get; set; }
Property Value
System.Drawing.Color

ShowLineNumbers

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

Declaration
public bool ShowLineNumbers { get; set; }
Property Value
System.Boolean

true if the line numbers are shown; otherwise, false.

TaggersRegistry

Gets the taggers registry.

Declaration
public TaggersRegistry TaggersRegistry { get; }
Property Value
TaggersRegistry

The taggers registry.

TextFormatDefinitions

Gets the text format definitions.

Declaration
public TextFormatDefinitionStack TextFormatDefinitions { get; }
Property Value
TextFormatDefinitionStack

The text format definitions.

UILayersBuilder

Gets or sets the UI layers builder.

Declaration
public UILayersBuilder UILayersBuilder { get; set; }
Property Value
UILayersBuilder

The UI layers builder.

UseMonospacedFontOptimization

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

Declaration
public bool UseMonospacedFontOptimization { get; set; }
Property Value
System.Boolean

true if [use monospaced font optimization]; otherwise, false.

UseShiftKeyInSelection

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

Declaration
public bool UseShiftKeyInSelection { get; set; }
Property Value
System.Boolean

true if [use shift key in selection]; otherwise, false.

VerticalScrollBar

Gets the vertical scroll bar.

Declaration
public RadScrollBarElement VerticalScrollBar { get; }
Property Value
RadScrollBarElement

The vertical scroll bar.

VerticalScrollBarVisibility

Gets or sets the vertical scroll bar visibility.

Declaration
public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }
Property Value
ScrollBarVisibility

The vertical scroll bar visibility.

Viewport

Gets the viewport.

Declaration
public Rect Viewport { get; }
Property Value
Rect

The viewport.

ZoomComboBox

Declaration
public RadDropDownListElement ZoomComboBox { get; }
Property Value
RadDropDownListElement

Methods

ApplyCachedProperties(Boolean)

Applies all saved RadProperties.

Declaration
protected virtual void ApplyCachedProperties(bool clearCache = true)
Parameters
System.Boolean clearCache

Determines whether the properties cache will be cleared.

ArrangeInnerMargins(RectangleF)

Declaration
protected virtual RectangleF ArrangeInnerMargins(RectangleF clientRect)
Parameters
System.Drawing.RectangleF clientRect

Returns
System.Drawing.RectangleF

ArrangeOuterMargins(RectangleF)

Declaration
protected virtual RectangleF ArrangeOuterMargins(RectangleF clientRect)
Parameters
System.Drawing.RectangleF clientRect

Returns
System.Drawing.RectangleF

ArrangeOverride(SizeF)

Called when control is arranged.

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

Returns
System.Drawing.SizeF

Overrides

Backspace()

Backspaces this instance.

Declaration
public void Backspace()

BeginUndoGroup()

Begins the undo group.

Declaration
public void BeginUndoGroup()

CancelUndoGroup()

Cancels the undo group.

Declaration
public void CancelUndoGroup()

CloseFindDialog()

Closes the find dialog.

Declaration
public void CloseFindDialog()

CompleteCode()

Completes the code.

Declaration
public void CompleteCode()

Copy()

Copies this instance.

Declaration
public void Copy()

CrateSyntaxEditorPresenter()

Declaration
protected virtual SyntaxEditorPresenter CrateSyntaxEditorPresenter()
Returns
SyntaxEditorPresenter

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

CreateSyntaxEditorHistoryState()

Creates the state of the code editor history.

Declaration
public SyntaxEditorHistoryState CreateSyntaxEditorHistoryState()
Returns
SyntaxEditorHistoryState

SyntaxEditorHistoryState.

CreateZoomElement()

Create the Zoom drop-down element.

Declaration
protected virtual RadDropDownListElement CreateZoomElement()
Returns
RadDropDownListElement

Cut()

Cuts this instance.

Declaration
public void Cut()

DecreaseLineIndent()

Decreases the line indent.

Declaration
public void DecreaseLineIndent()

Delete()

Deletes this instance.

Declaration
public void Delete()

DeleteFullLine()

Deletes the full line.

Declaration
public void DeleteFullLine()

DeleteWordToLeft()

Deletes the word to left.

Declaration
public void DeleteWordToLeft()

DeleteWordToRight()

Deletes the word to right.

Declaration
public void DeleteWordToRight()

Dispose()

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

Declaration
public void Dispose()
Implements
System.IDisposable.Dispose()

Dispose(Boolean)

Releases unmanaged and - optionally - managed resources.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
System.Boolean disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.

EndUndoGroup()

Ends the undo group.

Declaration
public void EndUndoGroup()

Find(String, Int32)

Finds the specified search text.

Declaration
public Span? Find(string searchText, int startIndex)
Parameters
System.String searchText

The search text.
System.Int32 startIndex

The start index.
Returns
System.Nullable<Span>

System.Nullable<Span>.

Find(String, Int32, Boolean)

Finds the specified search text.

Declaration
public Span? Find(string searchText, int startIndex, bool useRegularExpression)
Parameters
System.String searchText

The search text.
System.Int32 startIndex

The start index.
System.Boolean useRegularExpression

If set to true [use regular expression].
Returns
System.Nullable<Span>

System.Nullable<Span>.

Find(String, Int32, Boolean, Boolean)

Finds the specified search text.

Declaration
public Span? Find(string searchText, int startIndex, bool matchCase, bool useRegularExpression)
Parameters
System.String searchText

System.Int32 startIndex

System.Boolean matchCase

System.Boolean useRegularExpression

Returns
System.Nullable<Span>

FindAll(String)

Finds all spans.

Declaration
public IEnumerable<Span> FindAll(string searchText)
Parameters
System.String searchText

The search text.
Returns
System.Collections.Generic.IEnumerable<Span>

IEnumerable<Span>.

FindAll(String, Boolean)

Finds all spans.

Declaration
public IEnumerable<Span> FindAll(string searchText, bool useRegularExpression)
Parameters
System.String searchText

System.Boolean useRegularExpression

Returns
System.Collections.Generic.IEnumerable<Span>

FindAll(String, Boolean, Boolean)

Finds all spans.

Declaration
public IEnumerable<Span> FindAll(string searchText, bool matchCase, bool useRegularExpression)
Parameters
System.String searchText

System.Boolean matchCase

System.Boolean useRegularExpression

Returns
System.Collections.Generic.IEnumerable<Span>

FindPrevious(String, Int32, Boolean)

Finds the specified search text before the current index.

Declaration
public Span? FindPrevious(string searchText, int startIndex, bool matchCase)
Parameters
System.String searchText

System.Int32 startIndex

System.Boolean matchCase

Returns
System.Nullable<Span>

GetContentRect(RectangleF)

Declaration
protected virtual RectangleF GetContentRect(RectangleF availableRect)
Parameters
System.Drawing.RectangleF availableRect

Returns
System.Drawing.RectangleF

GetLineBoundingRectangleByLineNumber(Int32, Boolean)

Gets the line bounding rectangle by line number.

Declaration
public Rect GetLineBoundingRectangleByLineNumber(int lineNumber, bool cutToBaseline = false)
Parameters
System.Int32 lineNumber

System.Boolean cutToBaseline

Returns
Rect

GetLinePartBoundingRectangle(Span, Boolean)

Gets the line part bounding rectangle.

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

System.Boolean cutToBaseline

Returns
Rect

GetPointFromPosition(CaretPosition)

Gets the point from position.

Declaration
public Point GetPointFromPosition(CaretPosition position)
Parameters
CaretPosition position

The position.
Returns
Point

Point.

GetPositionFromControlPoint(Point)

Gets the position from point which is relative to the control.

Declaration
public CaretPosition GetPositionFromControlPoint(Point point)
Parameters
System.Drawing.Point point

The point relative to the control.
Returns
CaretPosition

CaretPosition.

GetPositionFromPoint(Point)

Gets the position from point. To get the correct caret position expects the point to be relative to the editor presenter and adjusted with the scale factor and scroll offsets. Use the GetPositionFromControlPoint method instead, which internally makes the necessary adjustments considering the scale factor and offsets, assuming the point is in control coordinates.

Declaration
public CaretPosition GetPositionFromPoint(Point point)
Parameters
System.Drawing.Point point

The point.
Returns
CaretPosition

CaretPosition.

GetText(CaretPosition, CaretPosition)

Gets the text between the specified start and end positions.

Declaration
public string GetText(CaretPosition start, CaretPosition end)
Parameters
CaretPosition start

CaretPosition end

Returns
System.String

GetWordToLeft()

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

Declaration
public string GetWordToLeft()
Returns
System.String

GetWordToRight()

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

Declaration
public string GetWordToRight()
Returns
System.String

HighlightAllMatches(String)

Tries to highlight all span matches via all registered TextSearchHighlightTaggers.

Declaration
public void HighlightAllMatches(string searchText)
Parameters
System.String searchText

IncreaseLineIndent()

Increases the line indent.

Declaration
public void IncreaseLineIndent()

Indent()

Indents this instance.

Declaration
public void Indent()

InitializeFields()

Declaration
protected override void InitializeFields()
Overrides

Insert(String)

Inserts the specified text.

Declaration
public void Insert(string text)
Parameters
System.String text

The text.

InsertNewLine()

Inserts the new line.

Declaration
public void InsertNewLine()

InsertTab()

Inserts the tab.

Declaration
public void InsertTab()

InvalidateEditorLayout()

Invalidates the editor layout.

Declaration
public void InvalidateEditorLayout()

InvalidateEditorLayout(Boolean)

Invalidates the editor layout.

Declaration
public void InvalidateEditorLayout(bool force)
Parameters
System.Boolean force

MeasureInnerMargins(RectangleF)

Declaration
protected virtual RectangleF MeasureInnerMargins(RectangleF clientRect)
Parameters
System.Drawing.RectangleF clientRect

Returns
System.Drawing.RectangleF

MeasureOuterMargins(RectangleF)

Declaration
protected virtual RectangleF MeasureOuterMargins(RectangleF clientRect)
Parameters
System.Drawing.RectangleF clientRect

Returns
System.Drawing.RectangleF

MeasureOverride(SizeF)

Called when control is measured.

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

Returns
System.Drawing.SizeF

Overrides

MoveCurrentLineToTop()

Moves the current line to top.

Declaration
public void MoveCurrentLineToTop()

NavigateNextMatch(String)

Navigates to the next matched text in the editor.

Declaration
public void NavigateNextMatch(string searchText)
Parameters
System.String searchText

NavigatePreviousMatch(String)

Navigates to the next matched text in the editor.

Declaration
public void NavigatePreviousMatch(string searchText)
Parameters
System.String searchText

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate.

Declaration
public override void OnApplyTemplate()
Overrides

OnCommandError(CommandErrorEventArgs)

Handles the CommandError event.

Declaration
protected virtual void OnCommandError(CommandErrorEventArgs args)
Parameters
CommandErrorEventArgs args

The CommandErrorEventArgs instance containing the event data.

OnCommandExecuted(CommandExecutedEventArgs)

Handles the CommandExecuted event.

Declaration
protected virtual void OnCommandExecuted(CommandExecutedEventArgs e)
Parameters
CommandExecutedEventArgs e

The CommandExecutedEventArgs instance containing the event data.

OnCommandExecuting(CommandExecutingEventArgs)

Handles the CommandExecuting event.

Declaration
protected virtual void OnCommandExecuting(CommandExecutingEventArgs args)
Parameters
CommandExecutingEventArgs args

The CommandExecutingEventArgs instance containing the event data.

OnDocumentChanged()

Called when [document changed].

Declaration
protected virtual void OnDocumentChanged()

OnDocumentChanging()

Called when [document changing].

Declaration
protected virtual void OnDocumentChanging()

OnDocumentContentChanged(TextContentChangedEventArgs)

Handles the DocumentContentChanged event.

Declaration
protected virtual void OnDocumentContentChanged(TextContentChangedEventArgs args)
Parameters
TextContentChangedEventArgs args

The TextContentChangedEventArgs instance containing the event data.

OnDocumentContentChanging(TextContentChangingEventArgs)

Handles the DocumentContentChanging event.

Declaration
protected virtual void OnDocumentContentChanging(TextContentChangingEventArgs args)
Parameters
TextContentChangingEventArgs args

The TextContentChangingEventArgs instance containing the event data.

OnGotFocus(EventArgs)

Invoked whenever an unhandled System.Windows.UIElement.GotFocus event reaches this element in its route.

Declaration
protected override void OnGotFocus(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.
Overrides

OnIsReadOnlyChanged(EventArgs)

Handles the IsReadOnlyChanged event.

Declaration
protected virtual void OnIsReadOnlyChanged(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.

OnLayoutPropertiesChanged()

Called when [layout properties changed].

Declaration
protected virtual void OnLayoutPropertiesChanged()

OnLoaded()

Declaration
protected override void OnLoaded()
Overrides

OnMouseWheelZoom(Double)

Called when mouse wheel zoom is requested.

Declaration
protected virtual bool OnMouseWheelZoom(double delta)
Parameters
System.Double delta

The mouse wheel delta.
Returns
System.Boolean

OnPreviewSyntaxEditorInput(PreviewSyntaxEditorInputEventArgs)

Handles the PreviewSyntaxEditorInput event.

Declaration
protected virtual void OnPreviewSyntaxEditorInput(PreviewSyntaxEditorInputEventArgs args)
Parameters
PreviewSyntaxEditorInputEventArgs args

The PreviewSyntaxEditorInputEventArgs instance containing the event data.

OnPreviewSyntaxEditorKeyDown(PreviewSyntaxEditorKeyEventArgs)

Handles the PreviewSyntaxEditorKeyDown event.

Declaration
protected virtual void OnPreviewSyntaxEditorKeyDown(PreviewSyntaxEditorKeyEventArgs args)
Parameters
PreviewSyntaxEditorKeyEventArgs args

The PreviewSyntaxEditorKeyEventArgs instance containing the event data.

OnPreviewSyntaxEditorKeyUp(PreviewSyntaxEditorKeyEventArgs)

Handles the PreviewSyntaxEditorKeyUp event.

Declaration
protected virtual void OnPreviewSyntaxEditorKeyUp(PreviewSyntaxEditorKeyEventArgs args)
Parameters
PreviewSyntaxEditorKeyEventArgs args

The PreviewSyntaxEditorKeyEventArgs instance containing the event data.

OnPreviewSyntaxEditorMouseLeftButtonDown(PreviewSyntaxEditorMouseButtonEventArgs)

Handles the PreviewSyntaxEditorMouseLeftButtonDown event.

Declaration
protected virtual void OnPreviewSyntaxEditorMouseLeftButtonDown(PreviewSyntaxEditorMouseButtonEventArgs args)
Parameters
PreviewSyntaxEditorMouseButtonEventArgs args

The PreviewSyntaxEditorMouseButtonEventArgs instance containing the event data.

OnPreviewSyntaxEditorMouseRightButtonDown(PreviewSyntaxEditorMouseButtonEventArgs)

Handles the PreviewSyntaxEditorMouseRightButtonDown event.

Declaration
protected virtual void OnPreviewSyntaxEditorMouseRightButtonDown(PreviewSyntaxEditorMouseButtonEventArgs args)
Parameters
PreviewSyntaxEditorMouseButtonEventArgs args

The PreviewSyntaxEditorMouseButtonEventArgs instance containing the event data.

OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

OnScaleFactorChanged()

Called when [scale factor changed].

Declaration
protected virtual void OnScaleFactorChanged()

OnScaleFactorPropertyCoerced(Double)

Declaration
protected virtual double OnScaleFactorPropertyCoerced(double baseValue)
Parameters
System.Double baseValue

Returns
System.Double

OnSelectionChanged()

Called when the selection changes.

Declaration
protected virtual void OnSelectionChanged()

OnViewportChanged()

Called when [viewport changed].

Declaration
protected virtual void OnViewportChanged()

OpenFindDialog(String)

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

Declaration
public void OpenFindDialog(string searchText)
Parameters
System.String searchText

The search text.

PageDown()

Pages down.

Declaration
public void PageDown()

PageUp()

Pages up.

Declaration
public void PageUp()

Paste()

Pastes this instance.

Declaration
public void Paste()

PopulateZoomElement()

Popuplates the default scale factors in the Zoom drop-down element.

Declaration
protected virtual void PopulateZoomElement()

Redo()

Redoes this instance.

Declaration
public bool Redo()
Returns
System.Boolean

System.Boolean.

ReplaceAllMatches(String, String, Boolean, Boolean)

Replaces all matches.

Declaration
public int ReplaceAllMatches(string searchText, string replaceText, bool matchCase, bool useRegularExpression)
Parameters
System.String searchText

The search text.
System.String replaceText

The replace text.
System.Boolean matchCase

The match case.
System.Boolean useRegularExpression

The use regular expression.
Returns
System.Int32

System.Int32.

ReplaceNextMatch(String, Int32, String, Boolean, Boolean)

Replaces the next match.

Declaration
public bool ReplaceNextMatch(string searchText, int startIndex, string replaceText, bool matchCase, bool useRegularExpression)
Parameters
System.String searchText

The search text.
System.Int32 startIndex

The start index.
System.String replaceText

The replace text.
System.Boolean matchCase

The match case.
System.Boolean useRegularExpression

The use regular expression.
Returns
System.Boolean

System.Boolean.

RestoreSyntaxEditorHistoryState(SyntaxEditorHistoryState)

Restores the state of the code editor history.

Declaration
public void RestoreSyntaxEditorHistoryState(SyntaxEditorHistoryState historyState)
Parameters
SyntaxEditorHistoryState historyState

State of the history.

SelectAll()

Selects all.

Declaration
public void SelectAll()

ShouldArrangeChild(RadElement)

Declaration
protected override bool ShouldArrangeChild(RadElement child)
Parameters
RadElement child

Returns
System.Boolean

Overrides

ShouldMeasureChild(RadElement)

Declaration
protected override bool ShouldMeasureChild(RadElement child)
Parameters
RadElement child

Returns
System.Boolean

Overrides

ToggleInsertMode()

Toggles the insert mode.

Declaration
public void ToggleInsertMode()

Undo()

Undoes this instance.

Declaration
public bool Undo()
Returns
System.Boolean

Unindent()

Unindents this instance.

Declaration
public void Unindent()

UpdateSelection()

Updates the selection.

Declaration
public void UpdateSelection()

ZoomIn(Double)

Zooms in.

Declaration
public void ZoomIn(double zoomFactor = 1.1)
Parameters
System.Double zoomFactor

The zoom increase factor. Should be a number greater than 1. Default value is 1.1.

ZoomOut(Double)

Zooms out.

Declaration
public void ZoomOut(double zoomFactor = 0.91)
Parameters
System.Double zoomFactor

The zoom decrease factor. Should be a number less than 1. Default value is 0.91.

ZoomTo(Double)

Zooms to particular zoom level. The minimum supported zoom level is 0.2 and the maximum supported is 4.

Declaration
public void ZoomTo(double zoomLevel)
Parameters
System.Double zoomLevel

The scale factor which will be used for zooming.
Exceptions
System.ArgumentOutOfRangeException

ZoomLevel must be non negative.

Events

CommandError

Occurs when [command error].

Declaration
public event EventHandler<CommandErrorEventArgs> CommandError
Event Type
System.EventHandler<CommandErrorEventArgs>

CommandExecuted

Occurs when [command executed].

Declaration
public event EventHandler<CommandExecutedEventArgs> CommandExecuted
Event Type
System.EventHandler<CommandExecutedEventArgs>

CommandExecuting

Occurs when [command executing].

Declaration
public event EventHandler<CommandExecutingEventArgs> CommandExecuting
Event Type
System.EventHandler<CommandExecutingEventArgs>

DocumentChanged

Occurs when document has been changed.

Declaration
public event EventHandler DocumentChanged
Event Type
System.EventHandler

Implements

DocumentChanging

Occurs when document is being changed.

Declaration
public event EventHandler DocumentChanging
Event Type
System.EventHandler

Implements

DocumentContentChanged

Occurs when document content has been changed.

Declaration
public event EventHandler<TextContentChangedEventArgs> DocumentContentChanged
Event Type
System.EventHandler<TextContentChangedEventArgs>

Implements

DocumentContentChanging

Occurs when document content is being changed.

Declaration
public event EventHandler<TextContentChangingEventArgs> DocumentContentChanging
Event Type
System.EventHandler<TextContentChangingEventArgs>

IsReadOnlyChanged

Occurs when [is read only changed].

Declaration
public event EventHandler IsReadOnlyChanged
Event Type
System.EventHandler

LayoutPropertiesChanged

Occurs when [layout properties changed].

Declaration
public event EventHandler LayoutPropertiesChanged
Event Type
System.EventHandler

PreviewSyntaxEditorInput

Occurs when [preview code editor input].

Declaration
public event EventHandler<PreviewSyntaxEditorInputEventArgs> PreviewSyntaxEditorInput
Event Type
System.EventHandler<PreviewSyntaxEditorInputEventArgs>

PreviewSyntaxEditorKeyDown

Occurs when [preview code editor key down].

Declaration
public event EventHandler<PreviewSyntaxEditorKeyEventArgs> PreviewSyntaxEditorKeyDown
Event Type
System.EventHandler<PreviewSyntaxEditorKeyEventArgs>

PreviewSyntaxEditorKeyUp

Occurs when [preview code editor key up].

Declaration
public event EventHandler<PreviewSyntaxEditorKeyEventArgs> PreviewSyntaxEditorKeyUp
Event Type
System.EventHandler<PreviewSyntaxEditorKeyEventArgs>

PreviewSyntaxEditorMouseLeftButtonDown

Occurs when [preview code editor mouse left button down].

Declaration
public event EventHandler<PreviewSyntaxEditorMouseButtonEventArgs> PreviewSyntaxEditorMouseLeftButtonDown
Event Type
System.EventHandler<PreviewSyntaxEditorMouseButtonEventArgs>

PreviewSyntaxEditorMouseRightButtonDown

Occurs when [preview code editor mouse right button down].

Declaration
public event EventHandler<PreviewSyntaxEditorMouseButtonEventArgs> PreviewSyntaxEditorMouseRightButtonDown
Event Type
System.EventHandler<PreviewSyntaxEditorMouseButtonEventArgs>

ScaleFactorChanged

Occurs when [scale factor changed].

Declaration
public event EventHandler ScaleFactorChanged
Event Type
System.EventHandler

SelectionChanged

Occurs when the selection of the control changes.

Declaration
public event EventHandler SelectionChanged
Event Type
System.EventHandler

ViewportChanged

Occurs when [viewport changed].

Declaration
public event EventHandler ViewportChanged
Event Type
System.EventHandler

Extension Methods

See Also