SyntaxEditor Class
Represents a syntax-highlighting code editor control.
[ToolboxBitmap(typeof(SyntaxEditor))]
public class SyntaxEditor : UIControl, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, IWeakEventListener
- Inheritance:
- object MarshalByRefObject Component Control ScrollableControl UIControl object
Constructors
SyntaxEditor()
Initializes a new instance of the SyntaxEditor
class.
public SyntaxEditor()
Properties
AcceptsTab
Gets or sets whether the Tab
key is accepted, allowing for the insertion of tab stops and/or indenting blocks of text.
public bool AcceptsTab { get; set; }
Property Value
- bool:
true
if the tab key is accepted; otherwise,false
. The default value istrue
.
Remarks
When this property is false
, the Tab
and Shift+Tab
key shortcuts will move focus instead.
ActiveView
Gets the currently-active IEditorView in the editor.
[Browsable(false)]
public IEditorView ActiveView { get; }
Property Value
- IEditorView:
The currently-active IEditorView in the editor.
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.
AllowDrag
Gets or sets whether dragging text from the editor is allowed.
public bool AllowDrag { get; set; }
Property Value
- bool:
true
if dragging text from the editor is allowed; otherwise,false
. The default value istrue
.
AreColumnGuidesVisible
Gets or sets whether column guides are visible.
public bool AreColumnGuidesVisible { get; set; }
Property Value
- bool:
true
if column guides are visible; otherwise,false
. The default value istrue
.
AreIndentationGuidesVisible
Gets or sets whether indentation guides are visible.
public bool AreIndentationGuidesVisible { get; set; }
Property Value
- bool:
true
if indentation guides are visible; otherwise,false
. The default value isfalse
.
AreLineModificationMarksVisible
Gets or sets whether line modification marks are visible.
public bool AreLineModificationMarksVisible { get; set; }
Property Value
- bool:
true
if line modification marks are visible; otherwise,false
. The default value istrue
.
AreMultipleSelectionRangesEnabled
Gets or sets whether multiple selection range features (and related carets) are enabled.
public bool AreMultipleSelectionRangesEnabled { get; set; }
Property Value
- bool:
true
if multiple selection range features (and related carets) are enabled; otherwise,false
. The default value istrue
.
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.
AreSelectionGrippersEnabled
Gets or sets whether selection grippers (when touching a view) are enabled.
public bool AreSelectionGrippersEnabled { get; set; }
Property Value
- bool:
true
if selection grippers (when touching a view) are enabled; otherwise,false
. The default value istrue
.
AreWordWrapGlyphsVisible
Gets or sets whether word wrap glyphs are visible when word wrap is enabled.
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 isfalse
.
Remarks
Set the WordWrapMode property to control to designate the current word wrap mode.
BackColor
Gets or sets the background color for the control.
public override Color BackColor { get; set; }
Property Value
BorderColor
Gets or sets the border color.
BorderStyle
Gets or sets the border style for editor views.
public BorderStyle BorderStyle { get; set; }
Property Value
- BorderStyle:
The border style for editor views. The default value is
BorderStyle.FixedSingle
.
CanBackspaceOverSpacesToTabStop
Gets or sets whether a Backspace key pressed before the first non-whitespace character of a line will backspace to the previous tab stop.
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 istrue
.
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
CanCutCopyBlankLineWhenNoSelection
Gets or sets whether cut/copy operations on a blank line with no selection overwrites the clipboard with the blank line.
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 istrue
.
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.
CanCutCopyDragWithHtml
Gets or sets whether the cutting and copying of text to the clipboard or dragging text
also copies the text in HTML
format, which retains syntax highlighting.
public bool CanCutCopyDragWithHtml { get; set; }
Property Value
- bool:
true
ifHTML
format is included; otherwise,false
. The default value isfalse
.
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.
CanCutCopyDragWithRtf
Gets or sets whether the cutting and copying of text to the clipboard or dragging text
also copies the text in RTF
format, which retains syntax highlighting.
public bool CanCutCopyDragWithRtf { get; set; }
Property Value
- bool:
true
ifRTF
format is included; otherwise,false
. The default value istrue
.
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.
CanIncrementalSearchTrimUnmatchedFindText
Gets or sets whether incremental search can ignore typed characters appended to the find text when no match was found for the previous find text.
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 istrue
.
CanMoveCaretForSecondaryPointerButton
Gets or sets whether to move the caret when a secondary pointer button (e.g. a right mouse button) is pressed outside of the current selection.
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 istrue
.
CanMoveCaretToNextLineAtLineEnd
Gets or sets whether to move the caret to the next view line when pressing the right-arrow key at the end of a view line.
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 istrue
.
CanMoveCaretToPreviousLineAtLineStart
Gets or sets whether to move the caret to the previous view line when pressing the left-arrow key at the start of a view line.
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 istrue
.
CanPointerWheelScrollUnfocusedViews
Gets or sets whether pointer (mouse) wheels can scroll unfocused editor views.
public bool CanPointerWheelScrollUnfocusedViews { get; set; }
Property Value
- bool:
true
if pointer (mouse) wheels can scroll unfocused editor views; otherwise,false
. The default value istrue
.
CanScrollPastDocumentEnd
Gets or sets whether it is possible to scroll past the end of the document.
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 istrue
.
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.
CanScrollPastDocumentEndResolved
Gets a resolved value for whether it is possible to scroll past the end of the document.
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.
CanSplitHorizontally
Gets or sets whether the editor can be split horizontally to show more than one view.
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 istrue
.
CaretBlinkInterval
Gets or sets the interval at which the caret blinks.
public int CaretBlinkInterval { get; set; }
Property Value
- int:
The interval at which the caret blinks, in milliseconds. The default value is
500ms
.
CaretInsertKind
Gets or sets the kind of the caret when in insert mode.
public CaretKind CaretInsertKind { get; set; }
Property Value
CaretInsertWidth
Gets or sets the width of the caret when in insert mode, if a non-block caret style is used.
public int CaretInsertWidth { get; set; }
Property Value
- int:
The width of the caret when in insert mode. The width must be within
1
and8
. The default value is1
.
CaretOverwriteKind
Gets or sets the kind of the caret when in overwrite mode.
public CaretKind CaretOverwriteKind { get; set; }
Property Value
CaretOverwriteWidth
Gets or sets the width of the caret when in overwrite mode, if a non-block caret style is used.
public int CaretOverwriteWidth { get; set; }
Property Value
- int:
The width of the caret when in overwrite mode. The width must be within
1
and8
. The default value is1
.
ColumnGuides
Gets or sets a collection of IColumnGuide instances to be displayed in the ITextView.
[Browsable(false)]
public IColumnGuideCollection ColumnGuides { get; set; }
Property Value
- IColumnGuideCollection:
An instance of IColumnGuideCollection.
CommandLinks
Gets a CommandLinkCollection containing the command links associated with the object.
public CommandLinkCollection CommandLinks { get; }
Property Value
- CommandLinkCollection:
A CommandLinkCollection containing the command links associated with the object.
DefaultPadding
Gets the default padding.
DefaultSize
Gets the default size of the control.
Document
Gets or sets the IEditorDocument being edited by the control.
[TypeConverter(typeof(ExpandableObjectConverter))]
public IEditorDocument Document { get; set; }
Property Value
- IEditorDocument:
The IEditorDocument being edited by the control.
Font
Gets or sets the font of the text displayed by the control.
[Browsable(true)]
public override Font Font { get; set; }
Property Value
ForeColor
Gets or sets the foreground color for the control.
public override Color ForeColor { get; set; }
Property Value
HasHorizontalSplit
Gets or sets whether the editor is currently split horizontally to show more than one view.
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 isfalse
.
See Also
HasSearchOverlayPaneKeyBindings
Gets or sets whether the editor has key bindings (hotkeys) that trigger the built-in search overlay pane.
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 istrue
.
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.
HighlightingStyleRegistry
Gets or sets the default IHighlightingStyleRegistry to use.
[Browsable(false)]
public IHighlightingStyleRegistry HighlightingStyleRegistry { get; set; }
Property Value
- IHighlightingStyleRegistry:
The default IHighlightingStyleRegistry to use.
Remarks
If this property is null
, the AmbientHighlightingStyleRegistry will be used.
HorizontalScrollBarVisibility
Gets or sets the ScrollBarVisibility that specifies the visibility of the horizontal ScrollBar.
public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }
Property Value
- ScrollBarVisibility:
The ScrollBarVisibility that specifies the visibility of the horizontal ScrollBar. The default value is
Visible
.
Remarks
Visible
and Auto
always show the ScrollBar.
Hidden
and Disabled
always hide the ScrollBar.
HorizontalSplitPercentage
Gets or sets the percentage across the height of the editor at which the horizontal split is located.
public double HorizontalSplitPercentage { get; set; }
Property Value
- double:
A value between
0
and1
indicating the percentage. The default value is0
.
Remarks
A value of 0
indicates that there is no split.
See Also
IndicatorMarginWidth
Gets or sets the width of the indicator margin.
public int IndicatorMarginWidth { get; set; }
Property Value
- int:
The width of the indicator margin. The default value is
18
.
IntelliPrompt
Gets the IIntelliPromptManager that manages IntelliPrompt user interface functionality for this editor.
public IIntelliPromptManager IntelliPrompt { get; }
Property Value
- IIntelliPromptManager:
The IIntelliPromptManager that manages IntelliPrompt user interface functionality for this editor.
IsAutoCorrectEnabled
Gets or sets whether auto-correct, such as case correction, is enabled.
public bool IsAutoCorrectEnabled { get; set; }
Property Value
- bool:
true
if auto-correct, such as case correction, is enabled; otherwise,false
. The default value istrue
.
Remarks
Note that the auto correct feature requires that the current language have an IAutoCorrector service registered, along with other possible requirements.
IsCollapsibleRegionHighlightingEnabled
Gets or sets whether collapsible regions highlight when the mouse is over the outlining margin.
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 istrue
.
IsCurrentLineHighlightingEnabled
Gets or sets whether current line highlighting is enabled for the active view.
public bool IsCurrentLineHighlightingEnabled { get; set; }
Property Value
- bool:
true
if current line highlighting is enabled for the active view; otherwise,false
. The default value isfalse
.
See Also
IsCurrentLineNumberHighlightingEnabled
Gets or sets whether current line number in the line number margin is highlighted in a different style from the other line numbers.
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 istrue
.
See Also
IsDefaultContextMenuEnabled
Gets or sets whether the default context menu is enabled.
public bool IsDefaultContextMenuEnabled { get; set; }
Property Value
- bool:
true
if the default context menu is enabled; otherwise,false
. The default value istrue
.
IsDelimiterAutoCompleteEnabled
Gets or sets whether delimiter auto-complete is enabled for the active view.
public bool IsDelimiterAutoCompleteEnabled { get; set; }
Property Value
- bool:
true
if delimiter auto-complete is enabled for the active view; otherwise,false
. The default value istrue
.
IsDelimiterHighlightingEnabled
Gets or sets whether delimiter highlighting is enabled for the active view.
public bool IsDelimiterHighlightingEnabled { get; set; }
Property Value
- bool:
true
if delimiter highlighting is enabled for the active view; otherwise,false
. The default value istrue
.
IsDocumentReadOnly
Gets whether the attached document is read-only.
[Browsable(false)]
public bool IsDocumentReadOnly { get; }
Property Value
- bool:
true
if attached document is read-only; otherwise,false
. The default value isfalse
.
Remarks
Use the ITextDocument.IsReadOnly property to alter this value.
IsDragDropTextReselectEnabled
Gets or sets whether to reselect text that is dragged and dropped into the control.
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 istrue
.
IsImeEnabled
Gets or sets whether support for IME (Input Method Editor) is enabled.
public bool IsImeEnabled { get; set; }
Property Value
- bool:
true
if IME support is enabled; otherwise,false
. The default value istrue
.
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.
IsIndicatorMarginVisible
Gets or sets whether the indicator margin is visible.
public bool IsIndicatorMarginVisible { get; set; }
Property Value
- bool:
true
if the indicator margin is visible; otherwise,false
. The default value isfalse
.
Remarks
This property is only effective if the default indicator margin is created by the ViewMarginFactories currently in use.
IsLineNumberMarginVisible
Gets or sets whether the line number margin is visible.
public bool IsLineNumberMarginVisible { get; set; }
Property Value
- bool:
true
if the line number margin is visible; otherwise,false
. The default value isfalse
.
Remarks
This property is only effective if the default line number margin is created by the ViewMarginFactories currently in use.
IsMultiLine
Gets or sets whether the editor allows multiple lines of text.
public bool IsMultiLine { get; set; }
Property Value
- bool:
true
if the editor allows multiple lines of text; otherwise,false
. The default value istrue
.
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.
IsOutliningMarginVisible
Gets or sets whether the outlining margin is visible.
public bool IsOutliningMarginVisible { get; set; }
Property Value
- bool:
true
if the outlining margin is visible; otherwise,false
. The default value istrue
.
Remarks
This property is only effective if the default outlining margin is created by the ViewMarginFactories currently in use.
IsOverwriteModeActive
Gets or sets whether the editor is in overwrite mode, where typing overwrites the character at the caret's offset.
public bool IsOverwriteModeActive { get; set; }
Property Value
- bool:
true
if the editor is in overwrite mode; otherwise,false
. The default value isfalse
.
IsRulerMarginVisible
Gets or sets whether the ruler margin is visible.
public bool IsRulerMarginVisible { get; set; }
Property Value
- bool:
true
if the ruler margin is visible; otherwise,false
. The default value isfalse
.
Remarks
This property is only effective if the default ruler margin is created by the ViewMarginFactories currently in use.
IsSearchResultHighlightingEnabled
Gets or sets whether search result highlighting is enabled for the active view.
public bool IsSearchResultHighlightingEnabled { get; set; }
Property Value
- bool:
true
if search result highlighting is enabled for the active view; otherwise,false
. The default value istrue
.
IsSelectionMarginVisible
Gets or sets whether the selection margin is visible.
public bool IsSelectionMarginVisible { get; set; }
Property Value
- bool:
true
if the selection margin is visible; otherwise,false
. The default value istrue
.
Remarks
This property is only effective if the default selection margin is created by the ViewMarginFactories currently in use.
IsTextDataBindingEnabled
Gets or sets whether data binding on the Text property is currently enabled.
public bool IsTextDataBindingEnabled { get; set; }
Property Value
- bool:
true
if data binding on the Text property is currently enabled; otherwise,false
. The default value isfalse
.
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.
IsVirtualSpaceAtLineEndEnabled
Gets or sets whether virtual space at the end of lines is enabled.
public bool IsVirtualSpaceAtLineEndEnabled { get; set; }
Property Value
- bool:
true
if virtual space at the end of lines is enabled; otherwise,false
. The default value isfalse
.
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.
IsWhitespaceVisible
Gets or sets whether whitespace (spaces and tabs) is visible.
public bool IsWhitespaceVisible { get; set; }
Property Value
- bool:
true
if whitespace (spaces and tabs) is visible; otherwise,false
. The default value isfalse
.
IsWordWrapEnabled
Gets or sets whether word wrap mode is currently enabled.
[Browsable(false)]
public bool IsWordWrapEnabled { get; set; }
Property Value
- bool:
true
if word wrap mode is currently enabled; otherwise,false
. The default value isfalse
.
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.
IsWordWrapGlyphMarginVisible
Gets whether the word wrap glyph margin is visible.
public bool IsWordWrapGlyphMarginVisible { get; }
Property Value
- bool:
true
if the word wrap glyph margin is visible; otherwise,false
. The default value isfalse
.
LineNumberMarginMinWidth
Gets or sets the minimum width of the line number margin.
public int LineNumberMarginMinWidth { get; set; }
Property Value
- int:
The minimum width of the line number margin. The default value is
36
.
MacroRecording
Gets the IMacroRecording that manages macro recording and playback functionality.
public IMacroRecording MacroRecording { get; }
Property Value
- IMacroRecording:
The IMacroRecording that manages macro recording and playback functionality.
OverrideCursor
[Browsable(false)]
public Cursor OverrideCursor { get; set; }
Property Value
PrintSettings
Gets or sets the IPrintSettings that provides access to all printing functionality.
[TypeConverter(typeof(ExpandableObjectConverter))]
public IPrintSettings PrintSettings { get; set; }
Property Value
- IPrintSettings:
The IPrintSettings that provides access to all printing functionality.
Renderer
Gets or sets the control-specific ISyntaxEditorRenderer used to render the control.
public ISyntaxEditorRenderer Renderer { get; set; }
Property Value
- ISyntaxEditorRenderer:
The control-specific ISyntaxEditorRenderer used to render the control.
Remarks
If this value is null
, then the global renderer will be used instead.
RendererResolved
Gets the ISyntaxEditorRenderer used to render the control.
[Browsable(false)]
public ISyntaxEditorRenderer RendererResolved { get; }
Property Value
- ISyntaxEditorRenderer:
The ISyntaxEditorRenderer used to render the control.
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.
ScrollBarAccelerationInterval
Gets or sets the TimeSpan
that indicates the amount of time it takes to increase the number of ScrollBar
units
scrolled per small change during ScrollBar
acceleration.
public TimeSpan ScrollBarAccelerationInterval { get; set; }
Property Value
- TimeSpan:
A
TimeSpan
indicating the interval. The default value is3 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
Gets or sets a value between 1
and 10
that indicates the maximum number of ScrollBar
units
that are scrolled during peak ScrollBar
acceleration.
public int ScrollBarAccelerationMaximum { get; set; }
Property Value
- int:
A value between
1
and10
indicating the maximum number of units. Set to1
, the minimum, to disable acceleration. The default value is4
.
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
ScrollToCaretOnSelectAll
Gets or sets whether to scroll to the caret when selecting all text in a view.
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 istrue
.
SearchOptions
Gets or sets whether to scroll to the caret when selecting all text in a view.
[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 istrue
.
SelectionCollapsesOnCopy
Gets or sets whether the selection collapses when a copy operation occurs.
public bool SelectionCollapsesOnCopy { get; set; }
Property Value
- bool:
true
if the selection collapses when a copy operation occurs; otherwise,false
. The default value isfalse
.
SelectionCollapsesToAnchor
Gets or sets whether the selection collapses to the anchor of the selection.
public bool SelectionCollapsesToAnchor { get; set; }
Property Value
- bool:
true
if the selection collapses to the anchor of the selection; otherwise,false
. The default value isfalse
.
SelectionMarginWidth
Gets or sets the width of the selection margin.
public int SelectionMarginWidth { get; set; }
Property Value
- int:
The width of the selection margin. The default value is
8
.
SelectionModesAllowed
Gets or sets a SelectionModes value indicating the selection modes that are allowed within the editor.
public SelectionModes SelectionModesAllowed { get; set; }
Property Value
- SelectionModes:
A SelectionModes value indicating the selection modes that are allowed within the editor. The default value is
Block
andContinuousStream
.
Text
Gets or sets the complete document text within the editor.
public override string Text { get; set; }
Property Value
- string:
The complete document text within the editor.
Remarks
Every time the getter of this property is called, the text of the document is reconstructed. Every call to the setter, sets the complete 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 ITextDocument.CurrentSnapshot and use the GetSubstring(int, int) method. Likewise, to determine document length, use the ITextSnapshot.Length property.
Programmatic document updates should be performed using methods on ITextDocument.
UseInvertedCaret
Gets or sets whether to invert the caret over its background.
public bool UseInvertedCaret { get; set; }
Property Value
- bool:
true
if the caret should be inverted over its background; otherwise,false
. The default value isfalse
.
Remarks
Inverted carets are high-contrast and were commonly used in classic code editors.
VerticalScrollBarVisibility
Gets or sets the ScrollBarVisibility that specifies the visibility of the vertical ScrollBar.
public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }
Property Value
- ScrollBarVisibility:
The ScrollBarVisibility that specifies the visibility of the vertical ScrollBar. The default value is
Visible
.
Remarks
Visible
and Auto
always show the ScrollBar.
Hidden
and Disabled
always hide the ScrollBar.
ViewMarginFactories
Gets the collection that contains the IEditorViewMarginFactory objects used to generate the margins for an IEditorView.
public IEditorViewMarginFactoryCollection ViewMarginFactories { get; }
Property Value
- IEditorViewMarginFactoryCollection:
A IEditorViewMarginFactoryCollection that contains the factories. The default collection contains a DefaultEditorViewMarginFactory.
WordWrapMode
Gets or sets a WordWrapMode value indicating the type of word wrapping that is performed.
public WordWrapMode WordWrapMode { get; set; }
Property Value
- WordWrapMode:
A WordWrapMode value indicating the type of word wrapping that is performed. The default value is
WordWrapMode.None
.
WrappedLineIndentAmount
Gets or sets the number of characters to indent any wrapped lines beyond the original indent level of the primary line.
public int WrappedLineIndentAmount { get; set; }
Property Value
- int:
The number of characters to indent any wrapped lines beyond the original indent level of the primary line. 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.
Methods
ArrangeOverride(Size)
Positions child elements and determines an arrange size.
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.
CloseOverlayPanes(string)
Closes open overlay panes with the optional key in all editor instances.
public static void CloseOverlayPanes(string key)
Parameter | Type | Description |
---|---|---|
key | string | The key of overlay panes to close, or |
See Also
CreateChildren()
Invoked when the collection of child elements is to be created.
protected override IList CreateChildren()
Returns
Remarks
By default no child collection is created.
CreateDefaultContextMenu(IEditorView)
Creates the default menu.
protected virtual ContextMenuStrip CreateDefaultContextMenu(IEditorView targetView)
Parameter | Type | Description |
---|---|---|
targetView | IEditorView | The optional target IEditorView. Passing |
Returns
- ContextMenuStrip:
The default menu to use.
CreateDefaultFont()
Creates the default Font.
CreateMacroRecording()
Creates the IMacroRecording object to use for this editor.
protected virtual IMacroRecording CreateMacroRecording()
Returns
- IMacroRecording:
The IMacroRecording object to use for this editor.
Dispose(bool)
Disposes any resources used by the object.
protected override void Dispose(bool disposing)
Parameter | Type | Description |
---|---|---|
disposing | bool | Whether the object is being disposed. |
DpiScaleChanged(SizeF)
Called when the DPI-based scale factor of the element changes.
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
GetView(EditorViewPlacement)
Returns the IEditorView for the specified location.
public IEditorView GetView(EditorViewPlacement viewPlacement)
Parameter | Type | Description |
---|---|---|
viewPlacement | EditorViewPlacement | The EditorViewPlacement to check. |
Returns
- IEditorView:
The IEditorView for the specified location.
HitTest(Point)
Performs a hit test of the specified Point within the editor and returns detailed results in an IHitTestResult.
public IHitTestResult HitTest(Point point)
Parameter | Type | Description |
---|---|---|
point | Point | The Point to hit test, relative to the editor's coordinates. |
Returns
- IHitTestResult:
An IHitTestResult that contains the hit test results.
InvalidateViews()
Invalidates the views and redraws them.
public void InvalidateViews()
IsInputChar(char)
Determines if a character is an input character that the control recognizes.
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
.
IsInputKey(Keys)
Determines whether the specified key is a regular input key or a special key that requires preprocessing.
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
.
IsSelectionModeAllowed(SelectionModes)
Gets whether the specified SelectionModes value is allowed.
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
.
MeasureOverride(Graphics, Size)
Measures the size required for the element and its child elements.
protected override Size MeasureOverride(Graphics g, Size availableSize)
Parameter | Type | Description |
---|---|---|
g | Graphics | The |
availableSize | Size | The available size. |
Returns
- Size:
The desired size.
NotifyPropertyChanged(string)
Notifies that a property has changed.
protected void NotifyPropertyChanged(string propertyName)
Parameter | Type | Description |
---|---|---|
propertyName | string | The name of the property that was changed. |
OnActiveViewChanged(EditorViewChangedEventArgs)
Occurs after the ActiveView property is changed.
protected virtual void OnActiveViewChanged(EditorViewChangedEventArgs e)
Parameter | Type | Description |
---|---|---|
e | EditorViewChangedEventArgs | The |
OnAreWordWrapGlyphsVisiblePropertyChanged(bool, bool)
Occurs when the AreWordWrapGlyphsVisible property is changed.
protected virtual void OnAreWordWrapGlyphsVisiblePropertyChanged(bool oldValue, bool newValue)
Parameter | Type | Description |
---|---|---|
oldValue | bool | The old value. |
newValue | bool | The new value. |
OnCanSplitHorizontallyPropertyChanged(bool, bool)
Occurs when the CanSplitHorizontally property is changed.
protected virtual void OnCanSplitHorizontallyPropertyChanged(bool oldValue, bool newValue)
Parameter | Type | Description |
---|---|---|
oldValue | bool | The old value. |
newValue | bool | The new value. |
OnColumnGuidesPropertyChanged(IColumnGuideCollection, IColumnGuideCollection)
Occurs when the ColumnGuides property is changed.
protected virtual void OnColumnGuidesPropertyChanged(IColumnGuideCollection oldValue, IColumnGuideCollection newValue)
Parameter | Type | Description |
---|---|---|
oldValue | IColumnGuideCollection | The old value. |
newValue | IColumnGuideCollection | The new value. |
OnCutCopyDrag(CutCopyDragEventArgs)
Occurs before text is cut or copied to the clipboard, and also before a drag occurs.
protected virtual void OnCutCopyDrag(CutCopyDragEventArgs e)
Parameter | Type | Description |
---|---|---|
e | CutCopyDragEventArgs | The |
OnDocumentChanged(EditorDocumentChangedEventArgs)
Occurs after the Document property is changed.
protected virtual void OnDocumentChanged(EditorDocumentChangedEventArgs e)
Parameter | Type | Description |
---|---|---|
e | EditorDocumentChangedEventArgs | The |
OnDocumentIsModifiedChanged(EventArgs)
Occurs after the current document's IsModified property value has changed.
protected virtual void OnDocumentIsModifiedChanged(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | The |
OnDocumentIsReadOnlyChanged(EventArgs)
Occurs after the current document's IsReadOnly property value has changed.
protected virtual void OnDocumentIsReadOnlyChanged(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | The |
OnDocumentLanguageChanged(EditorDocumentLanguageChangedEventArgs)
Occurs when the current document's Language property value has changed.
protected virtual void OnDocumentLanguageChanged(EditorDocumentLanguageChangedEventArgs e)
Parameter | Type | Description |
---|---|---|
e | EditorDocumentLanguageChangedEventArgs | The |
OnDocumentParseDataChanged(EventArgs)
Occurs after the current document's ParseData property value has changed.
protected virtual void OnDocumentParseDataChanged(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | The |
OnDocumentPropertyChanged(IEditorDocument, IEditorDocument)
Occurs when the Document property is changed.
protected virtual void OnDocumentPropertyChanged(IEditorDocument oldValue, IEditorDocument newValue)
Parameter | Type | Description |
---|---|---|
oldValue | IEditorDocument | The old value. |
newValue | IEditorDocument | The new value. |
OnDocumentTextChanged(EditorSnapshotChangedEventArgs)
Occurs after a text change occurs to the Document.
protected virtual void OnDocumentTextChanged(EditorSnapshotChangedEventArgs e)
Parameter | Type | Description |
---|---|---|
e | EditorSnapshotChangedEventArgs | The |
OnDocumentTextChanging(EditorSnapshotChangingEventArgs)
Occurs before a text change occurs to the Document.
protected virtual void OnDocumentTextChanging(EditorSnapshotChangingEventArgs e)
Parameter | Type | Description |
---|---|---|
e | EditorSnapshotChangingEventArgs | The |
OnFontChanged(EventArgs)
Occurs when the font changes.
protected override void OnFontChanged(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | The |
OnGotFocus(EventArgs)
Raises the GotFocus
event.
protected override void OnGotFocus(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | An |
OnHasHorizontalSplitPropertyChanged(bool, bool)
Occurs when the HasHorizontalSplit property is changed.
protected virtual void OnHasHorizontalSplitPropertyChanged(bool oldValue, bool newValue)
Parameter | Type | Description |
---|---|---|
oldValue | bool | The old value. |
newValue | bool | The new value. |
OnHasSearchOverlayPaneKeyBindingsPropertyChanged(bool, bool)
Occurs when the HasSearchOverlayPaneKeyBindings property is changed.
protected virtual void OnHasSearchOverlayPaneKeyBindingsPropertyChanged(bool oldValue, bool newValue)
Parameter | Type | Description |
---|---|---|
oldValue | bool | The old value. |
newValue | bool | The new value. |
OnHighlightingStyleRegistryPropertyChanged(IHighlightingStyleRegistry, IHighlightingStyleRegistry)
Occurs when the HighlightingStyleRegistry property is changed.
protected virtual void OnHighlightingStyleRegistryPropertyChanged(IHighlightingStyleRegistry oldValue, IHighlightingStyleRegistry newValue)
Parameter | Type | Description |
---|---|---|
oldValue | IHighlightingStyleRegistry | The old value. |
newValue | IHighlightingStyleRegistry | The new value. |
OnHorizontalSplitPercentagePropertyChanged(double, double)
Occurs when the HasHorizontalSplit property is changed.
protected virtual void OnHorizontalSplitPercentagePropertyChanged(double oldValue, double newValue)
Parameter | Type | Description |
---|---|---|
oldValue | double | The old value. |
newValue | double | The new value. |
OnIsMultiLinePropertyChanged(bool, bool)
Occurs when the IsMultiLine property is changed.
protected virtual void OnIsMultiLinePropertyChanged(bool oldValue, bool newValue)
Parameter | Type | Description |
---|---|---|
oldValue | bool | The old value. |
newValue | bool | The new value. |
OnIsOverwriteModeActiveChanged(EventArgs)
Occurs when the IsOverwriteModeActive property value changes.
protected virtual void OnIsOverwriteModeActiveChanged(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | The |
OnIsSearchResultHighlightingEnabledPropertyChanged(bool, bool)
Occurs when the IsSearchResultHighlightingEnabled property is changed.
protected virtual void OnIsSearchResultHighlightingEnabledPropertyChanged(bool oldValue, bool newValue)
Parameter | Type | Description |
---|---|---|
oldValue | bool | The old value. |
newValue | bool | The new value. |
OnIsVirtualSpaceAtLineEndEnabledPropertyChanged(bool, bool)
Occurs when the IsVirtualSpaceAtLineEndEnabled property is changed.
protected virtual void OnIsVirtualSpaceAtLineEndEnabledPropertyChanged(bool oldValue, bool newValue)
Parameter | Type | Description |
---|---|---|
oldValue | bool | The old value. |
newValue | bool | The new value. |
OnIsWordWrapEnabledPropertyChanged(bool, bool)
Occurs when the IsWordWrapEnabled property is changed.
protected virtual void OnIsWordWrapEnabledPropertyChanged(bool oldValue, bool newValue)
Parameter | Type | Description |
---|---|---|
oldValue | bool | The old value. |
newValue | bool | The new value. |
OnKeyDown(KeyEventArgs)
Raises the KeyDown
event.
protected override void OnKeyDown(KeyEventArgs e)
Parameter | Type | Description |
---|---|---|
e | KeyEventArgs | An |
OnKeyPress(KeyPressEventArgs)
Raises the KeyPress
event.
protected override void OnKeyPress(KeyPressEventArgs e)
Parameter | Type | Description |
---|---|---|
e | KeyPressEventArgs | An |
OnKeyUp(KeyEventArgs)
Raises the KeyUp
event.
protected override void OnKeyUp(KeyEventArgs e)
Parameter | Type | Description |
---|---|---|
e | KeyEventArgs | An |
OnLostFocus(EventArgs)
Raises the LostFocus
event.
protected override void OnLostFocus(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | An |
OnMacroRecordingStateChanged(EventArgs)
Occurs when the macro recording state changes.
protected virtual void OnMacroRecordingStateChanged(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | The |
OnMenuRequested(SyntaxEditorMenuEventArgs)
Occurs when a menu is requested, which will be opened in the editor.
protected virtual void OnMenuRequested(SyntaxEditorMenuEventArgs e)
Parameter | Type | Description |
---|---|---|
e | SyntaxEditorMenuEventArgs | The |
OnOverlayPaneClosed(OverlayPaneEventArgs)
Occurs after an overlay pane is closed.
protected virtual void OnOverlayPaneClosed(OverlayPaneEventArgs e)
Parameter | Type | Description |
---|---|---|
e | OverlayPaneEventArgs | The |
OnOverlayPaneOpened(OverlayPaneEventArgs)
Occurs after an overlay pane is opened.
protected virtual void OnOverlayPaneOpened(OverlayPaneEventArgs e)
Parameter | Type | Description |
---|---|---|
e | OverlayPaneEventArgs | The |
OnPasteDragDrop(PasteDragDropEventArgs)
Occurs when a paste or drag/drop operation occurs over the control, allowing for customization of the text to be inserted.
protected virtual void OnPasteDragDrop(PasteDragDropEventArgs e)
Parameter | Type | Description |
---|---|---|
e | PasteDragDropEventArgs | The |
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.
OnPrint(PaintEventArgs)
Occurs when printing the control.
protected override void OnPrint(PaintEventArgs e)
Parameter | Type | Description |
---|---|---|
e | PaintEventArgs | The |
OnPropertyChanged(PropertyChangedEventArgs)
Raises the PropertyChanged event.
protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)
Parameter | Type | Description |
---|---|---|
e | PropertyChangedEventArgs | The PropertyChangedEventArgs that contains the event data. |
OnResize(EventArgs)
Raises the Resize
event.
protected override void OnResize(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | An |
OnTextChanged(EventArgs)
Occurs when the Text property is changed.
protected override void OnTextChanged(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | An |
OnUserInterfaceUpdate(EventArgs)
Occurs after a brief delay following any document text, parse data, or view selection update, allowing consumers to update the user interface during an idle period.
protected virtual void OnUserInterfaceUpdate(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | The |
OnViewActionExecuting(EditActionEventArgs)
Occurs before an IEditAction is executed in an IEditorView.
protected virtual void OnViewActionExecuting(EditActionEventArgs e)
Parameter | Type | Description |
---|---|---|
e | EditActionEventArgs | The |
OnViewClosed(TextViewEventArgs)
Occurs when an ITextView is closed.
protected virtual void OnViewClosed(TextViewEventArgs e)
Parameter | Type | Description |
---|---|---|
e | TextViewEventArgs | The |
OnViewIsIncrementalSearchActiveChanged(TextViewEventArgs)
Occurs when the incremental search mode of an ITextView is activated or deactivated.
protected virtual void OnViewIsIncrementalSearchActiveChanged(TextViewEventArgs e)
Parameter | Type | Description |
---|---|---|
e | TextViewEventArgs | The |
OnViewOpened(TextViewEventArgs)
Occurs when an ITextView is opened.
protected virtual void OnViewOpened(TextViewEventArgs e)
Parameter | Type | Description |
---|---|---|
e | TextViewEventArgs | The |
OnViewSearch(EditorViewSearchEventArgs)
Occurs when a IEditorView search operation is performed.
protected virtual void OnViewSearch(EditorViewSearchEventArgs e)
Parameter | Type | Description |
---|---|---|
e | EditorViewSearchEventArgs | The |
OnViewSelectionChanged(EditorViewSelectionEventArgs)
Occurs when a IEditorView selection has changed.
protected virtual void OnViewSelectionChanged(EditorViewSelectionEventArgs e)
Parameter | Type | Description |
---|---|---|
e | EditorViewSelectionEventArgs | The |
OnViewSplitAdded(EventArgs)
Occurs when an IEditorView split is added.
protected virtual void OnViewSplitAdded(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | The |
OnViewSplitMoved(EventArgs)
Occurs when an IEditorView split is moved.
protected virtual void OnViewSplitMoved(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | The |
OnViewSplitRemoved(EventArgs)
Occurs when an IEditorView split is removed.
protected virtual void OnViewSplitRemoved(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | The |
OnVisibleChanged(EventArgs)
Occurs when the control's visibility changes.
protected override void OnVisibleChanged(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | An |
OnWordWrapModeChanged(EventArgs)
Occurs after the WordWrapMode property is changed.
protected virtual void OnWordWrapModeChanged(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | The |
OnWordWrapModePropertyChanged(WordWrapMode, WordWrapMode)
Occurs when the WordWrapMode property is changed.
protected virtual void OnWordWrapModePropertyChanged(WordWrapMode oldValue, WordWrapMode newValue)
Parameter | Type | Description |
---|---|---|
oldValue | WordWrapMode | The old value. |
newValue | WordWrapMode | The new value. |
ProcessCmdKey(ref Message, Keys)
Processes command keys.
protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
Parameter | Type | Description |
---|---|---|
msg | Message | The message. |
keyData | Keys | The key data. |
Returns
- bool:
true
if the command was handled; otherwise,false
.
ResetBorderColor()
Resets the BorderColor property to its default value.
public void ResetBorderColor()
ResetFont()
Resets the Font property to its default value.
public override void ResetFont()
ResetInputBindings()
Resets the input bindings to their default values.
public virtual void ResetInputBindings()
ResetScrollBarAccelerationInterval()
Resets the ScrollBarAccelerationInterval property to its default value.
public void ResetScrollBarAccelerationInterval()
ResetViews()
Resets the splits and creates an initial view.
public void ResetViews()
ResumeCaretBlinking()
Resumes the blinking of the caret(s).
public void ResumeCaretBlinking()
ShouldSerializeBorderColor()
Indicates whether the BorderColor property should be persisted.
public bool ShouldSerializeBorderColor()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeFont()
Indicates whether the Font property should be persisted.
public bool ShouldSerializeFont()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeScrollBarAccelerationInterval()
Indicates whether the ScrollBarAccelerationInterval property should be persisted.
public bool ShouldSerializeScrollBarAccelerationInterval()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShowPrintDialog()
Displays the print dialog.
public bool ShowPrintDialog()
Returns
- bool:
true
if the dialog was displayed successfully and printing occurred; otherwise,false
.
ShowPrintPreviewDialog()
Displays the print preview dialog.
public bool ShowPrintPreviewDialog()
Returns
- bool:
true
if the dialog was displayed successfully; otherwise,false
.
Remarks
This dialog cannot be displayed in an XBAP.
SuspendCaretBlinking(bool)
Suspends the blinking of the caret(s).
public void SuspendCaretBlinking(bool show)
Parameter | Type | Description |
---|---|---|
show | bool | Whether to display the caret(s). |
WndProc(ref Message)
Occurs when a message is sent to the control.
protected override void WndProc(ref Message m)
Parameter | Type | Description |
---|---|---|
m | Message | Information about the message. |
Events
ActiveViewChanged
Occurs after the ActiveView property is changed.
public event EventHandler<EditorViewChangedEventArgs> ActiveViewChanged
Event Type
CutCopyDrag
Occurs before text is cut or copied to the clipboard, and also before a drag occurs.
public event EventHandler<CutCopyDragEventArgs> CutCopyDrag
Event Type
DocumentChanged
Occurs after the Document property is changed.
public event EventHandler<EditorDocumentChangedEventArgs> DocumentChanged
Event Type
DocumentIsModifiedChanged
Occurs after the current document's IsModified property value has changed.
DocumentIsReadOnlyChanged
Occurs after the current document's IsReadOnly property value has changed.
DocumentLanguageChanged
Occurs when the current document's Language property value has changed.
public event EventHandler<EditorDocumentLanguageChangedEventArgs> DocumentLanguageChanged
Event Type
DocumentParseDataChanged
Occurs after the current document's ParseData property value has changed.
DocumentTextChanged
Occurs after a text change occurs to the Document.
public event EventHandler<EditorSnapshotChangedEventArgs> DocumentTextChanged
Event Type
DocumentTextChanging
Occurs before a text change occurs to the Document.
public event EventHandler<EditorSnapshotChangingEventArgs> DocumentTextChanging
Event Type
IsOverwriteModeActiveChanged
Occurs when the IsOverwriteModeActive property value changes.
MacroRecordingStateChanged
Occurs when the macro recording state changes.
MenuRequested
Occurs when a menu is requested, which will be opened in the editor.
public event EventHandler<SyntaxEditorMenuEventArgs> MenuRequested
Event Type
OverlayPaneClosed
Occurs after an overlay pane is closed.
public event EventHandler<OverlayPaneEventArgs> OverlayPaneClosed
Event Type
OverlayPaneOpened
Occurs after an overlay pane is opened.
public event EventHandler<OverlayPaneEventArgs> OverlayPaneOpened
Event Type
PasteDragDrop
Occurs when a paste or drag/drop operation occurs over the control, allowing for customization of the text to be inserted.
public event EventHandler<PasteDragDropEventArgs> PasteDragDrop
Event Type
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.
PropertyChanged
Occurs when a property has been changed.
UserInterfaceUpdate
Occurs after a brief delay following any document text, parse data, or view selection update, allowing consumers to update the user interface during an idle period.
ViewActionExecuting
Occurs before an IEditAction is executed in an IEditorView.
public event EventHandler<EditActionEventArgs> ViewActionExecuting
Event Type
ViewClosed
Occurs when an ITextView is closed.
ViewIsIncrementalSearchActiveChanged
Occurs when the incremental search mode of an ITextView is activated or deactivated.
public event EventHandler<TextViewEventArgs> ViewIsIncrementalSearchActiveChanged
Event Type
ViewOpened
Occurs when an ITextView is opened.
ViewSearch
Occurs when a IEditorView search operation is performed.
public event EventHandler<EditorViewSearchEventArgs> ViewSearch
Event Type
ViewSelectionChanged
Occurs when a IEditorView selection has changed.
public event EventHandler<EditorViewSelectionEventArgs> ViewSelectionChanged
Event Type
ViewSplitAdded
Occurs when an IEditorView split is added.
ViewSplitMoved
Occurs when an IEditorView split is moved.
ViewSplitRemoved
Occurs when an IEditorView split is removed.
WordWrapModeChanged
Occurs after the WordWrapMode property is changed.
Inherited Members
- UIControl.AddPendingGraphicsInversion(Rectangle)
- UIControl.AddPendingScrollOperation(Rectangle, Orientation, int)
- UIControl.AddPendingScrollOperation(Rectangle, int, int)
- UIControl.AddToInvalidatedRegion()
- UIControl.AddToInvalidatedRegion(Rectangle)
- UIControl.Arrange(Rectangle)
- UIControl.ContainsLocation(Point)
- UIControl.GetCursor(Point)
- UIControl.Invalidate(InvalidationLevels, InvalidationTypes)
- UIControl.InvalidateArrange()
- UIControl.InvalidateMeasure()
- UIControl.Measure(Graphics, Size)
- UIControl.OnClick(EventArgs)
- UIControl.OnDoubleClick(EventArgs)
- UIControl.OnDpiChangedAfterParent(EventArgs)
- UIControl.OnHandleCreated(EventArgs)
- UIControl.OnLayout(LayoutEventArgs)
- UIControl.OnLocationChanged(EventArgs)
- UIControl.OnMouseCaptureChanged(EventArgs)
- UIControl.OnMouseDown(MouseEventArgs)
- UIControl.OnMouseEnter(EventArgs)
- UIControl.OnMouseHover(EventArgs)
- UIControl.OnMouseLeave(EventArgs)
- UIControl.OnMouseMove(MouseEventArgs)
- UIControl.OnMouseUp(MouseEventArgs)
- UIControl.OnMouseWheel(MouseEventArgs)
- UIControl.OnPaint(PaintEventArgs)
- UIControl.OnPaintBackground(PaintEventArgs)
- UIControl.OnParentChanged()
- UIControl.OnParentChanged(EventArgs)
- UIControl.OnRender(PaintEventArgs)
- UIControl.OnRenderChildElements(PaintEventArgs)
- UIControl.OnRightToLeftChanged(EventArgs)
- UIControl.Render(PaintEventArgs)
- UIControl.ResetDoubleBufferCanvas(bool)
- UIControl.ResumePainting()
- UIControl.SuspendPainting()
- UIControl.TransformToAncestor(IUIElement)
- UIControl.TransformToDescendant(IUIElement)
- UIControl.UpdateCursor()
- UIControl.UpdateLayout()
- UIControl.ActualHeight
- UIControl.ActualWidth
- UIControl.BackgroundImage
- UIControl.CaptureMouseWhenPressed
- UIControl.ClipBounds
- UIControl.DesiredSize
- UIControl.DpiScaleFactor
- UIControl.IsArrangeValid
- UIControl.IsMeasureValid
- UIControl.IsPaintValid
- UIControl.IsRightToLeft
- UIControl.LastMouseUpButton
- UIControl.PaintingSuspended
- UIControl.UseControlGraphicsForMeasure
- UIControl.UseExtendedDoubleBuffering
- MarshalByRefObject.GetLifetimeService()
- MarshalByRefObject.InitializeLifetimeService()
- MarshalByRefObject.MemberwiseClone(bool)
- object.GetType()
- object.MemberwiseClone()
- object.ToString()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()