SyntaxEditor Class

[ToolboxBitmap(typeof(SyntaxEditor))]
public class SyntaxEditor : UIControl, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, IWeakEventListener

public SyntaxEditor()

public bool AcceptsTab { get; set; }

Property Value

bool:

true if the tab key is accepted; otherwise, false. The default value is true.

Remarks

When this property is false, the Tab and Shift+Tab key shortcuts will move focus instead.

[Browsable(false)]
public IEditorView ActiveView { get; }

Property Value

IEditorView

Remarks

The currently-active view in the editor is the view that contains focus when focus is moved within the editor. There is always a single view in an editor marked as active.

public bool AllowDrag { get; set; }

Property Value

bool:

true if dragging text from the editor is allowed; otherwise, false. The default value is true.

public bool AreColumnGuidesVisible { get; set; }

Property Value

bool:

true if column guides are visible; otherwise, false. The default value is true.

public bool AreIndentationGuidesVisible { get; set; }

Property Value

bool:

true if indentation guides are visible; otherwise, false. The default value is false.

public bool AreLineModificationMarksVisible { get; set; }

Property Value

bool:

true if line modification marks are visible; otherwise, false. The default value is true.

public bool AreMultipleSelectionRangesEnabled { get; set; }

Property Value

bool:

true if multiple selection range features (and related carets) are enabled; otherwise, false. The default value is true.

Remarks

When this property is true, various features for supporting insertion of multiple carets and managing more than a single selection range will be enabled. Set this property to false to prevent more than a single selection range.

public bool AreSelectionGrippersEnabled { get; set; }

Property Value

bool:

true if selection grippers (when touching a view) are enabled; otherwise, false. The default value is true.

public bool AreWordWrapGlyphsVisible { get; set; }

Property Value

bool:

true if word wrap glyphs are visible when word wrap is enabled; otherwise, false. The default value is false.

Remarks

Set the WordWrapMode property to control to designate the current word wrap mode.

public override Color BackColor { get; set; }

Property Value

Color:

A Color that represents the background color of the control. The default is the value of the DefaultBackColor property.

public Color BorderColor { get; set; }

Property Value

Color

public BorderStyle BorderStyle { get; set; }

Property Value

BorderStyle:

The border style for editor views. The default value is BorderStyle.FixedSingle.

public bool CanBackspaceOverSpacesToTabStop { get; set; }

Property Value

bool:

true if a Backspace key pressed before the first non-whitespace character of a line will backspace to the previous tab stop; otherwise, false. The default value is true.

Remarks

This property is only used when AutoConvertTabsToSpaces is true. When this property is false, only one space character maximum will be consumed when backspacing before the first non-whitespace character of a line.

See Also

• AutoConvertTabsToSpaces

public bool CanCutCopyBlankLineWhenNoSelection { get; set; }

Property Value

bool:

true if cut/copy operations on a blank line with no selection overwrites the clipboard with the blank line; otherwise, false. The default value is true.

Remarks

When there is no selection in the editor and a cut or copy operation occurs, the text of the current line will be sent to the clipboard. If the text is subsequently pasted back into the editor while there is no selection, a new link will be created to insert the clipboard data and the caret will not move. Even if this property is false, cutting of blank lines will occur but the clipboard will not be changed.

public bool CanCutCopyDragWithHtml { get; set; }

Property Value

bool:

true if HTML format is included; otherwise, false. The default value is false.

Remarks

Activating this feature will cause a slight delay when cutting, copying, or dragging text since the building of HTML formatted text can take time. However most likely this delay will be negligible.

public bool CanCutCopyDragWithRtf { get; set; }

Property Value

bool:

true if RTF format is included; otherwise, false. The default value is true.

Remarks

Activating this feature will cause a slight delay when cutting, copying, or dragging text since the building of RTF formatted text can take time. However most likely this delay will be negligible.

public bool CanIncrementalSearchTrimUnmatchedFindText { get; set; }

Property Value

bool:

true if incremental search can ignore typed characters appended to the find text when no match was found for the previous find text; otherwise, false. The default value is true.

public bool CanMoveCaretForSecondaryPointerButton { get; set; }

Property Value

bool:

true if the caret should move when a secondary pointer button (e.g. a right mouse button) is pressed outside of the current selection; otherwise, false. The default value is true.

public bool CanMoveCaretToNextLineAtLineEnd { get; set; }

Property Value

bool:

true if the caret should move to the next view line when pressing the right-arrow key at the end of a view line; otherwise, false. The default value is true.

public bool CanMoveCaretToPreviousLineAtLineStart { get; set; }

Property Value

bool:

true if the caret should move to the previous view line when pressing the left-arrow key at the start of a view line; otherwise, false. The default value is true.

public bool CanPointerWheelScrollUnfocusedViews { get; set; }

Property Value

bool:

true if pointer (mouse) wheels can scroll unfocused editor views; otherwise, false. The default value is true.

public bool CanScrollPastDocumentEnd { get; set; }

Property Value

bool:

true if it is possible to scroll past the end of the document; otherwise, false. The default value is true.

Remarks

When this property is set to true, the vertical scrollbar allows scrolling of the last line of the document up to the first view line in the view.

This property should not be set to false when intra-line adornments are used or multiple font faces/sizes are used in highlighting styles, since the vertical scrollbar maximum cannot be properly calculated in those scenarios.

This property has no effect when word wrap mode is active.

public bool CanScrollPastDocumentEndResolved { get; }

Property Value

bool:

true if it is possible to scroll past the end of the document; otherwise, false.

Remarks

CanScrollPastDocumentEnd is forced when in word wrap mode.

public bool CanSplitHorizontally { get; set; }

Property Value

bool:

true if the editor can be split horizontally to show more than one view; otherwise, false. The default value is true.

public int CaretBlinkInterval { get; set; }

Property Value

int:

The default value is 500ms.

public CaretKind CaretInsertKind { get; set; }

Property Value

CaretKind:

The default value is VerticalLine.

public int CaretInsertWidth { get; set; }

Property Value

int:

The width must be within 1 and 8. The default value is 1.

public CaretKind CaretOverwriteKind { get; set; }

Property Value

CaretKind:

The default value is Block.

public int CaretOverwriteWidth { get; set; }

Property Value

int:

The width must be within 1 and 8. The default value is 1.

[Browsable(false)]
public IColumnGuideCollection? ColumnGuides { get; set; }

Property Value

IColumnGuideCollection

public CommandLinkCollection CommandLinks { get; }

Property Value

CommandLinkCollection

protected override Padding DefaultPadding { get; }

Property Value

Padding:

A Padding that represents the internal spacing of the contents of a control.

protected override Size DefaultSize { get; }

Property Value

Size:

The default Size of the control.

[TypeConverter(typeof(ExpandableObjectConverter))]
public IEditorDocument Document { get; set; }

Property Value

IEditorDocument

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

Property Value

Font:

The Font to apply to the text displayed by the control. The default is the value of the DefaultFont property.

public override Color ForeColor { get; set; }

Property Value

Color:

The foreground Color of the control. The default is the value of the DefaultForeColor property.

public bool HasHorizontalSplit { get; set; }

Property Value

bool:

true if the editor is currently split horizontally to show more than one view; otherwise, false. The default value is false.

See Also

• HorizontalSplitPercentage

public bool HasSearchOverlayPaneKeyBindings { get; set; }

Property Value

bool:

true if the editor has key bindings (hotkeys) that trigger the built-in search overlay pane; otherwise, false. The default value is true.

Remarks

This properly should be set to false when an external search UI is used, since a false setting will prevent access to the built-in search overlay pane. Key bindings like those involving F3, Ctrl+F, and Ctrl+H are affected by this property. When this property is toggled, the ResetInputBindings() method will be called.

[Browsable(false)]
public IHighlightingStyleRegistry? HighlightingStyleRegistry { get; set; }

Property Value

IHighlightingStyleRegistry

Remarks

If this property is null, the AmbientHighlightingStyleRegistry will be used.

public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }

Property Value

ScrollBarVisibility:

The default value is Visible.

Remarks

Visible and Auto always show the ScrollBar. Hidden always hides the ScrollBar.

public double HorizontalSplitPercentage { get; set; }

Property Value

double:

A value between 0 and 1 indicating the percentage. The default value is 0.

Remarks

A value of 0 indicates that there is no split.

See Also

• HasHorizontalSplit

public int IndicatorMarginWidth { get; set; }

Property Value

int:

The default value is 18.

public IIntelliPromptManager IntelliPrompt { get; }

Property Value

IIntelliPromptManager

public bool IsAutoCorrectEnabled { get; set; }

Property Value

bool:

true if auto-correct, such as case correction, is enabled; otherwise, false. The default value is true.

Remarks

Note that the auto correct feature requires that the current language have an IAutoCorrector service registered, along with other possible requirements.

public bool IsCollapsibleRegionHighlightingEnabled { get; set; }

Property Value

bool:

true if collapsible regions highlight when the mouse is over the outlining margin; otherwise, false. The default value is true.

public bool IsCurrentLineHighlightingEnabled { get; set; }

Property Value

bool:

true if current line highlighting is enabled for the active view; otherwise, false. The default value is false.

See Also

• IsCurrentLineNumberHighlightingEnabled

public bool IsCurrentLineNumberHighlightingEnabled { get; set; }

Property Value

bool:

true if current line number highlighting is enabled for the active view; otherwise, false. The default value is true.

See Also

• IsCurrentLineHighlightingEnabled

public bool IsDefaultContextMenuEnabled { get; set; }

Property Value

bool:

true if the default context menu is enabled; otherwise, false. The default value is true.

public bool IsDelimiterAutoCompleteEnabled { get; set; }

Property Value

bool:

true if delimiter auto-complete is enabled for the active view; otherwise, false. The default value is true.

public bool IsDelimiterHighlightingEnabled { get; set; }

Property Value

bool:

true if delimiter highlighting is enabled for the active view; otherwise, false. The default value is true.

[Browsable(false)]
public bool IsDocumentReadOnly { get; }

Property Value

bool:

true if attached document is read-only; otherwise, false. The default value is false.

Remarks

Use the IsReadOnly property to alter this value.

public bool IsDragDropTextReselectEnabled { get; set; }

Property Value

bool:

true if text that is dragged and dropped into the control should be reselected; otherwise, false. The default value is true.

public bool IsImeEnabled { get; set; }

Property Value

bool:

true if IME support is enabled; otherwise, false. The default value is true.

Remarks

IME is a Window feature that allows users to enter characters and symbols not found on their input device. It allows Western keyboards to enter Chinese, Japanese, etc. characters.

public bool IsIndicatorMarginVisible { get; set; }

Property Value

bool:

true if the indicator margin is visible; otherwise, false. The default value is false.

Remarks

This property is only effective if the default indicator margin is created by the ViewMarginFactories currently in use.

public bool IsLineNumberMarginVisible { get; set; }

Property Value

bool:

true if the line number margin is visible; otherwise, false. The default value is false.

Remarks

This property is only effective if the default line number margin is created by the ViewMarginFactories currently in use.

public bool IsMultiLine { get; set; }

Property Value

bool:

true if the editor allows multiple lines of text; otherwise, false. The default value is true.

Remarks

When this property is false, only a single line of text is permitted in the document and the editor renders like a native single-line textbox.

public bool IsOutliningMarginVisible { get; set; }

Property Value

bool:

true if the outlining margin is visible; otherwise, false. The default value is true.

Remarks

This property is only effective if the default outlining margin is created by the ViewMarginFactories currently in use.

public bool IsOverwriteModeActive { get; set; }

Property Value

bool:

true if the editor is in overwrite mode; otherwise, false. The default value is false.

public bool IsRulerMarginVisible { get; set; }

Property Value

bool:

true if the ruler margin is visible; otherwise, false. The default value is false.

Remarks

This property is only effective if the default ruler margin is created by the ViewMarginFactories currently in use.

public bool IsSearchResultHighlightingEnabled { get; set; }

Property Value

bool:

true if search result highlighting is enabled for the active view; otherwise, false. The default value is true.

public bool IsSelectionMarginVisible { get; set; }

Property Value

bool:

true if the selection margin is visible; otherwise, false. The default value is true.

Remarks

This property is only effective if the default selection margin is created by the ViewMarginFactories currently in use.

public bool IsTextDataBindingEnabled { get; set; }

Property Value

bool:

true if data binding on the Text property is currently enabled; otherwise, false. The default value is false.

Remarks

Data binding is off by default on the Text property for two reasons. First, supporting the Text property means that two full copies of the document text are stored in memory instead of one, which can increase memory a lot for large documents. Second, the full text must be set to the property after each text change, meaning performance could suffer depending on the size of the document.

It is recommended to only set IsTextDataBindingEnabled to true when data binding is required, and note that the IsTextDataBindingEnabled property must be set before creating a binding on the Text property.

public bool IsVirtualSpaceAtLineEndEnabled { get; set; }

Property Value

bool:

true if virtual space at the end of lines is enabled; otherwise, false. The default value is false.

Remarks

When true, the caret can move past the end of lines. Use of virtual space at the end of lines will disable word wrap.

public bool IsWhitespaceVisible { get; set; }

Property Value

bool:

true if whitespace (spaces and tabs) is visible; otherwise, false. The default value is false.

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

Property Value

bool:

true if word wrap mode is currently enabled; otherwise, false. The default value is false.

Remarks

This property returns true if any WordWrapMode property value other than None is specified. Set the WordWrapMode property to control to designate the current word wrap mode.

public bool IsWordWrapGlyphMarginVisible { get; }

Property Value

bool:

true if the word wrap glyph margin is visible; otherwise, false. The default value is false.

public int LineNumberMarginMinWidth { get; set; }

Property Value

int:

The minimum width of the line number margin. The default value is 36.

public IMacroRecording MacroRecording { get; }

Property Value

IMacroRecording

[Browsable(false)]
public Cursor? OverrideCursor { get; set; }

Property Value

Cursor:

Any Cursor or null to use the default cursors.

[TypeConverter(typeof(ExpandableObjectConverter))]
public IPrintSettings? PrintSettings { get; set; }

Property Value

IPrintSettings:

The IPrintSettings that provides access to all printing functionality.

public ISyntaxEditorRenderer? Renderer { get; set; }

Property Value

ISyntaxEditorRenderer

Remarks

If this value is null, then the global renderer will be used instead.

[Browsable(false)]
public ISyntaxEditorRenderer RendererResolved { get; }

Property Value

ISyntaxEditorRenderer

Remarks

This property will return a global renderer if there is no control instance renderer override. The registered renderer type with the UIRendererManager for this property is ISyntaxEditorRenderer.

public TimeSpan ScrollBarAccelerationInterval { get; set; }

Property Value

TimeSpan:

The default value is 3 seconds.

Remarks

ScrollBar acceleration kicks in when holding down one of the ScrollBar controls' small change buttons. At each interval specified by ScrollBarAccelerationInterval, the number of units scrolled with each small change increases by 1 until ScrollBarAccelerationMaximum is reached. This enables you to more quickly scroll large distances through documents.

For example, with the default settings, holding the vertical ScrollBar's down button will start scrolling down 1 line at a time. 3 seconds later, it will increase to 2 lines at a time. 3 seconds later, it will increase to 3 lines at a time. 3 seconds later, it will increase to 4 lines at a time and will no longer increase the lines scrolled per small change. Once the down button is released, everything resets back and acceleration is available for the next scroll operation.

See Also

• ScrollBarAccelerationMaximum

public int ScrollBarAccelerationMaximum { get; set; }

Property Value

int:

Set to 1, the minimum, to disable acceleration. The default value is 4.

Remarks

ScrollBar acceleration kicks in when holding down one of the ScrollBar controls' small change buttons. At each interval specified by ScrollBarAccelerationInterval, the number of units scrolled with each small change increases by 1 until ScrollBarAccelerationMaximum is reached. This enables you to more quickly scroll large distances through documents.

For example, with the default settings, holding the vertical ScrollBar's down button will start scrolling down 1 line at a time. 3 seconds later, it will increase to 2 lines at a time. 3 seconds later, it will increase to 3 lines at a time. 3 seconds later, it will increase to 4 lines at a time and will no longer increase the lines scrolled per small change. Once the down button is released, everything resets back and acceleration is available for the next scroll operation.

See Also

• ScrollBarAccelerationInterval

public bool ScrollToCaretOnSelectAll { get; set; }

Property Value

bool:

true if a view should scroll to the caret when selecting all its text; otherwise, false. The default value is true.

[TypeConverter(typeof(ExpandableObjectConverter))]
public IEditorSearchOptions SearchOptions { get; set; }

Property Value

IEditorSearchOptions:

true if a view should scroll to the caret when selecting all its text; otherwise, false. The default value is true.

public bool SelectionCollapsesOnCopy { get; set; }

Property Value

bool:

true if the selection collapses when a copy operation occurs; otherwise, false. The default value is false.

public bool SelectionCollapsesToAnchor { get; set; }

Property Value

bool:

true if the selection collapses to the anchor of the selection; otherwise, false. The default value is false.

public int SelectionMarginWidth { get; set; }

Property Value

int:

The default value is 8.

public SelectionModes SelectionModesAllowed { get; set; }

Property Value

SelectionModes:

The default value is Block and ContinuousStream.

public override string Text { get; set; }

Property Value

string

Remarks

Every time the getter of this property is called, the text of the document is completely reconstructed. Every call to the setter completely replaces the document text. Therefore many calls to this property can be a performance bottleneck.

To properly get text substrings from the document, get the current ITextSnapshot from CurrentSnapshot (using the Document property) and use the GetSubstring(int, int, LineTerminator?) method. Likewise, to determine document length, use the Length property.

Programmatic document updates should be performed using methods on ITextDocument accessible from the Document property.

See Also

• Document

public bool UseInvertedCaret { get; set; }

Property Value

bool:

true if the caret should be inverted over its background; otherwise, false. The default value is false.

Remarks

Inverted carets are high-contrast and were commonly used in classic code editors.

public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }

Property Value

ScrollBarVisibility:

The default value is Visible.

Remarks

Visible and Auto always show the ScrollBar. Hidden always hides the ScrollBar.

public IEditorViewMarginFactoryCollection ViewMarginFactories { get; }

Property Value

IEditorViewMarginFactoryCollection:

The default collection contains an instance of DefaultEditorViewMarginFactory.

public WordWrapMode WordWrapMode { get; set; }

Property Value

WordWrapMode:

The default value is None.

public int WrappedLineIndentAmount { get; set; }

Property Value

int:

The default value is 2.

Remarks

A value of 2 will indent wrapped lines to the original indent level of the primary line, plus 2 additional character widths. A value of 0 will indent wrapped lines to the original indent level of the primary line. A value of -1 will not indent wrapped lines at all, and will simply align them to the left edge of the view. The indent amount may be limited or altogether disabled if there is not enough available width in the view to support proper indentation.

protected override Size ArrangeOverride(Size finalSize)

Parameter	Type	Description
finalSize	Size	The final area within the parent that this element should use to arrange itself and its children.

Returns

Size:

The actual size used.

Remarks

Element authors should override this method, call Arrange(Rectangle) on each visible child element and position each child element. It is required that a parent element calls Arrange(Rectangle) on each child or they won't be rendered.

public static void CloseOverlayPanes(string? key)

Parameter	Type	Description
key	string	The key of overlay panes to close, or null to close all panes.

See Also

• OverlayPaneKeys

protected override IList<ILogicalTreeNode>? CreateChildren()

Returns

IList<ILogicalTreeNode>:

The list that should be assigned to the Children property.

Remarks

By default, no child collection is created.

protected virtual IMenu CreateDefaultContextMenu(IEditorView? targetView)

Parameter	Type	Description
targetView	IEditorView	The optional target IEditorView. Pass null to use the active view.

Returns

IMenu:

The default menu to use.

protected virtual Font? CreateDefaultFont()

Returns

Font

protected virtual IMacroRecording CreateMacroRecording()

Returns

IMacroRecording

protected override void Dispose(bool disposing)

Parameter	Type	Description
disposing	bool	true to release both managed and unmanaged resources; false to release only unmanaged resources.

public override void DpiScaleChanged(SizeF scaleFactor)

Parameter	Type	Description
scaleFactor	SizeF	The new scale factor where Width is applied to the x-axis, and Height is applied to the y-axis.

See Also

• DpiScaleFactor

public IEditorView? GetView(EditorViewPlacement viewPlacement)

Parameter	Type	Description
viewPlacement	EditorViewPlacement	The EditorViewPlacement to check.

Returns

IEditorView:

The IEditorView for the specified location.

public IHitTestResult HitTest(Point point)

Parameter	Type	Description
point	Point	The Point to hit test, relative to the editor's coordinates.

Returns

IHitTestResult

public void InvalidateViews()

protected override bool IsInputChar(char charCode)

Parameter	Type	Description
charCode	char	The character to test.

Returns

bool:

true if the character should be sent directly to the control and not preprocessed; otherwise, false.

protected override bool IsInputKey(Keys keyData)

Parameter	Type	Description
keyData	Keys	One of the Keys values.

Returns

bool:

true if the specified key is a regular input key; otherwise, false.

public bool IsSelectionModeAllowed(SelectionModes mode)

Parameter	Type	Description
mode	SelectionModes	A SelectionModes indicating the value to check.

Returns

bool:

true if the specified SelectionModes value is allowed; otherwise, false.

protected override Size MeasureOverride(Graphics? g, Size availableSize)

Parameter	Type	Description
g	Graphics	The Graphics object to use for measurement.
availableSize	Size	The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available.

Returns

Size:

The size that this element determines it needs during layout, based on its calculations of child element sizes.

Remarks

Element authors should override this method, call Measure(Graphics?, Size) on each visible child element and determine the total size required.

protected virtual void OnActiveViewChanged(EditorViewChangedEventArgs e)

Parameter	Type	Description
e	EditorViewChangedEventArgs	The event data.

protected virtual void OnAreWordWrapGlyphsVisiblePropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	bool	The old value.
newValue	bool	The new value.

protected virtual void OnCanSplitHorizontallyPropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	bool	The old value.
newValue	bool	The new value.

protected virtual void OnColumnGuidesPropertyChanged(IColumnGuideCollection? oldValue, IColumnGuideCollection? newValue)

Parameter	Type	Description
oldValue	IColumnGuideCollection	The old value.
newValue	IColumnGuideCollection	The new value.

protected virtual void OnCutCopyDrag(CutCopyDragEventArgs e)

Parameter	Type	Description
e	CutCopyDragEventArgs	The event data.

protected virtual void OnDocumentChanged(EditorDocumentChangedEventArgs e)

Parameter	Type	Description
e	EditorDocumentChangedEventArgs	The event data.

protected virtual void OnDocumentIsModifiedChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	The event data.

protected virtual void OnDocumentIsReadOnlyChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	The event data.

protected virtual void OnDocumentLanguageChanged(EditorDocumentLanguageChangedEventArgs e)

Parameter	Type	Description
e	EditorDocumentLanguageChangedEventArgs	The event data.

protected virtual void OnDocumentParseDataChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	The event data.

protected virtual void OnDocumentPropertyChanged(IEditorDocument? oldValue, IEditorDocument? newValue)

Parameter	Type	Description
oldValue	IEditorDocument	The old value.
newValue	IEditorDocument	The new value.

protected virtual void OnDocumentTextChanged(EditorSnapshotChangedEventArgs e)

Parameter	Type	Description
e	EditorSnapshotChangedEventArgs	The event data.

protected virtual void OnDocumentTextChanging(EditorSnapshotChangingEventArgs e)

Parameter	Type	Description
e	EditorSnapshotChangingEventArgs	The event data.

protected override void OnFontChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected override void OnGotFocus(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnHasHorizontalSplitPropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	bool	The old value.
newValue	bool	The new value.

protected virtual void OnHasSearchOverlayPaneKeyBindingsPropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	bool	The old value.
newValue	bool	The new value.

protected virtual void OnHighlightingStyleRegistryPropertyChanged(IHighlightingStyleRegistry? oldValue, IHighlightingStyleRegistry? newValue)

Parameter	Type	Description
oldValue	IHighlightingStyleRegistry	The old value.
newValue	IHighlightingStyleRegistry	The new value.

protected virtual void OnHorizontalSplitPercentagePropertyChanged(double oldValue, double newValue)

Parameter	Type	Description
oldValue	double	The old value.
newValue	double	The new value.

protected virtual void OnIsMultiLinePropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	bool	The old value.
newValue	bool	The new value.

protected virtual void OnIsOverwriteModeActiveChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	The event data.

protected virtual void OnIsSearchResultHighlightingEnabledPropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	bool	The old value.
newValue	bool	The new value.

protected virtual void OnIsVirtualSpaceAtLineEndEnabledPropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	bool	The old value.
newValue	bool	The new value.

protected virtual void OnIsWordWrapEnabledPropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	bool	The old value.
newValue	bool	The new value.

protected override void OnKeyDown(KeyEventArgs e)

Parameter	Type	Description
e	KeyEventArgs	A KeyEventArgs that contains the event data.

protected override void OnKeyPress(KeyPressEventArgs e)

Parameter	Type	Description
e	KeyPressEventArgs	A KeyPressEventArgs that contains the event data.

protected override void OnKeyUp(KeyEventArgs e)

Parameter	Type	Description
e	KeyEventArgs	A KeyEventArgs that contains the event data.

protected override void OnLostFocus(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnMacroRecordingStateChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	The event data.

protected virtual void OnMenuRequested(SyntaxEditorMenuEventArgs e)

Parameter	Type	Description
e	SyntaxEditorMenuEventArgs	The event data.

protected virtual void OnOverlayPaneClosed(OverlayPaneEventArgs e)

Parameter	Type	Description
e	OverlayPaneEventArgs	The event data.

protected virtual void OnOverlayPaneOpened(OverlayPaneEventArgs e)

Parameter	Type	Description
e	OverlayPaneEventArgs	The event data.

protected virtual void OnPasteDragDrop(PasteDragDropEventArgs e)

Parameter	Type	Description
e	PasteDragDropEventArgs	The event data.

Remarks

This event allows for any sort of IDataStore (such as a file) to be handled when pasted or drag/dropped on the editor and representative text inserted.

protected override void OnPrint(PaintEventArgs e)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.

Exceptions

Type	Condition
ArgumentNullException	The e parameter is null.

protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)

Parameter	Type	Description
e	PropertyChangedEventArgs	The event data.

protected void OnPropertyChanged(string? propertyName = null)

Parameter	Type	Description
propertyName	string	(Optional) The name of the property that changed.

protected override void OnResize(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected override void OnTextChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnUserInterfaceUpdate(EventArgs e)

Parameter	Type	Description
e	EventArgs	The event data.

protected virtual void OnViewActionExecuting(EditActionEventArgs e)

Parameter	Type	Description
e	EditActionEventArgs	The event data.

protected virtual void OnViewClosed(TextViewEventArgs e)

Parameter	Type	Description
e	TextViewEventArgs	The event data.

protected virtual void OnViewIsIncrementalSearchActiveChanged(TextViewEventArgs e)

Parameter	Type	Description
e	TextViewEventArgs	The event data.

protected virtual void OnViewOpened(TextViewEventArgs e)

Parameter	Type	Description
e	TextViewEventArgs	The event data.

protected virtual void OnViewSearch(EditorViewSearchEventArgs e)

Parameter	Type	Description
e	EditorViewSearchEventArgs	The event data.

protected virtual void OnViewSelectionChanged(EditorViewSelectionEventArgs e)

Parameter	Type	Description
e	EditorViewSelectionEventArgs	The event data.

protected virtual void OnViewSplitAdded(EventArgs e)

Parameter	Type	Description
e	EventArgs	The event data.

protected virtual void OnViewSplitMoved(EventArgs e)

Parameter	Type	Description
e	EventArgs	The event data.

protected virtual void OnViewSplitRemoved(EventArgs e)

Parameter	Type	Description
e	EventArgs	The event data.

protected override void OnVisibleChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs object that contains the event data.

protected virtual void OnWordWrapModeChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	The event data.

protected virtual void OnWordWrapModePropertyChanged(WordWrapMode oldValue, WordWrapMode newValue)

Parameter	Type	Description
oldValue	WordWrapMode	The old value.
newValue	WordWrapMode	The new value.

protected override bool ProcessCmdKey(ref Message msg, Keys keyData)

Parameter	Type	Description
msg	Message	A Message, passed by reference, that represents the window message to process.
keyData	Keys	One of the Keys values that represents the key to process.

Returns

bool:

true if the character was processed by the control; otherwise, false.

public void ResetBorderColor()

public override void ResetFont()

public virtual void ResetInputBindings()

public void ResetScrollBarAccelerationInterval()

public void ResetViews()

public void ResumeCaretBlinking()

protected bool SetProperty<T>(ref T field, T newValue, string? propertyName = null)

Type Parameters:

T -

The type of the property that changed.

Parameter	Type	Description
field	T	The backing field that holds the property's value, which may be updated.
newValue	T	The new property value.
propertyName	string	(Optional) The name of the property that changed.

Returns

bool:

true if the property was changed; otherwise, false.

public bool ShouldSerializeBorderColor()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public bool ShouldSerializeFont()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public bool ShouldSerializeScrollBarAccelerationInterval()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public bool ShowPrintDialog()

Returns

bool:

true if the dialog was displayed successfully and printing occurred; otherwise, false.

public bool ShowPrintPreviewDialog()

Returns

bool:

true if the dialog was displayed successfully; otherwise, false.

public void SuspendCaretBlinking(bool show)

Parameter	Type	Description
show	bool	Whether to display the caret(s).

protected override void WndProc(ref Message m)

Parameter	Type	Description
m	Message	The Windows Message to process.

public event EventHandler<EditorViewChangedEventArgs>? ActiveViewChanged

Event Type

EventHandler<EditorViewChangedEventArgs>

public event EventHandler<CutCopyDragEventArgs>? CutCopyDrag

Event Type

EventHandler<CutCopyDragEventArgs>

public event EventHandler<EditorDocumentChangedEventArgs>? DocumentChanged

Event Type

EventHandler<EditorDocumentChangedEventArgs>

public event EventHandler? DocumentIsModifiedChanged

Event Type

EventHandler

public event EventHandler? DocumentIsReadOnlyChanged

Event Type

EventHandler

public event EventHandler<EditorDocumentLanguageChangedEventArgs>? DocumentLanguageChanged

Event Type

EventHandler<EditorDocumentLanguageChangedEventArgs>

public event EventHandler? DocumentParseDataChanged

Event Type

EventHandler

public event EventHandler<EditorSnapshotChangedEventArgs>? DocumentTextChanged

Event Type

EventHandler<EditorSnapshotChangedEventArgs>

public event EventHandler<EditorSnapshotChangingEventArgs>? DocumentTextChanging

Event Type

EventHandler<EditorSnapshotChangingEventArgs>

public event EventHandler? IsOverwriteModeActiveChanged

Event Type

EventHandler

public event EventHandler? MacroRecordingStateChanged

Event Type

EventHandler

public event EventHandler<SyntaxEditorMenuEventArgs>? MenuRequested

Event Type

EventHandler<SyntaxEditorMenuEventArgs>

public event EventHandler<OverlayPaneEventArgs>? OverlayPaneClosed

Event Type

EventHandler<OverlayPaneEventArgs>

public event EventHandler<OverlayPaneEventArgs>? OverlayPaneOpened

Event Type

EventHandler<OverlayPaneEventArgs>

public event EventHandler<PasteDragDropEventArgs>? PasteDragDrop

Event Type

EventHandler<PasteDragDropEventArgs>

Remarks

This event allows for any sort of IDataStore (such as a file) to be handled when pasted or drag/dropped on the editor and representative text inserted.

public event PropertyChangedEventHandler? PropertyChanged

Event Type

PropertyChangedEventHandler

public event EventHandler? UserInterfaceUpdate

Event Type

EventHandler

public event EventHandler<EditActionEventArgs>? ViewActionExecuting

Event Type

EventHandler<EditActionEventArgs>

public event EventHandler<TextViewEventArgs>? ViewClosed

Event Type

EventHandler<TextViewEventArgs>

public event EventHandler<TextViewEventArgs>? ViewIsIncrementalSearchActiveChanged

Event Type

EventHandler<TextViewEventArgs>

public event EventHandler<TextViewEventArgs>? ViewOpened

Event Type

EventHandler<TextViewEventArgs>

public event EventHandler<EditorViewSearchEventArgs>? ViewSearch

Event Type

EventHandler<EditorViewSearchEventArgs>

public event EventHandler<EditorViewSelectionEventArgs>? ViewSelectionChanged

Event Type

EventHandler<EditorViewSelectionEventArgs>

public event EventHandler? ViewSplitAdded

Event Type

EventHandler

public event EventHandler? ViewSplitMoved

Event Type

EventHandler

public event EventHandler? ViewSplitRemoved

Event Type

EventHandler

public event EventHandler? WordWrapModeChanged

Event Type

EventHandler