SyntaxEditor Class

[TemplatePart(Name = "PART_EditorViewHost", Type = typeof(EditorViewHost))]
public class SyntaxEditor : Control, DUCE.IResource, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IHaveResources, IQueryAmbient

public SyntaxEditor()

public bool AcceptsTab { get; set; }

Property Value

System.Boolean:

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.

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.

public bool AllowDrag { get; set; }

Property Value

System.Boolean:

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

public bool AreColumnGuidesVisible { get; set; }

Property Value

System.Boolean:

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

public bool AreIndentationGuidesVisible { get; set; }

Property Value

System.Boolean:

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

public bool AreLineModificationMarksVisible { get; set; }

Property Value

System.Boolean:

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

public bool AreMultipleSelectionRangesEnabled { get; set; }

Property Value

System.Boolean:

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

System.Boolean:

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

public bool AreWordWrapGlyphsVisible { get; set; }

Property Value

System.Boolean:

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 bool CanBackspaceOverSpacesToTabStop { get; set; }

Property Value

System.Boolean:

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

System.Boolean:

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

System.Boolean:

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

System.Boolean:

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

System.Boolean:

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

System.Boolean:

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

System.Boolean:

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

System.Boolean:

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

System.Boolean:

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

public bool CanScrollPastDocumentEnd { get; set; }

Property Value

System.Boolean:

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

System.Boolean:

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

System.Boolean:

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

System.Int32:

The interval at which the caret blinks, in milliseconds. The default value is 500ms.

public Brush CaretBrush { get; set; }

Property Value

System.Windows.Media.Brush:

The System.Windows.Media.Brush to use for rendering the caret.

public CaretKind CaretInsertKind { get; set; }

Property Value

CaretKind:

A CaretKind indicating the kind of the caret when in insert mode. The default value is CaretKind.VerticalLine.

public int CaretInsertWidth { get; set; }

Property Value

System.Int32:

The width of the caret when in insert mode. The width must be within 1 and 8. The default value is 1.

public CaretKind CaretOverwriteKind { get; set; }

Property Value

CaretKind:

A CaretKind indicating the kind of the caret when in overwrite mode. The default value is CaretKind.Block.

public int CaretOverwriteWidth { get; set; }

Property Value

System.Int32:

The width of the caret when in overwrite mode. The width must be within 1 and 8. The default value is 1.

public IColumnGuideCollection ColumnGuides { get; set; }

Property Value

IColumnGuideCollection:

An instance of IColumnGuideCollection.

public IEditorDocument Document { get; set; }

Property Value

IEditorDocument:

The IEditorDocument being edited by the control.

public bool HasHorizontalSplit { get; set; }

Property Value

System.Boolean:

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

System.Boolean:

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.

public IHighlightingStyleRegistry HighlightingStyleRegistry { get; set; }

Property Value

IHighlightingStyleRegistry:

The default IHighlightingStyleRegistry to use.

Remarks

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

public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }

Property Value

System.Windows.Controls.ScrollBarVisibility:

The System.Windows.Controls.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.

public double HorizontalSplitPercentage { get; set; }

Property Value

System.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 Brush InactiveSelectedTextBackground { get; set; }

Property Value

System.Windows.Media.Brush:

The System.Windows.Media.Brush to use when rendering the inactive selection background.

public Brush IndicatorMarginBackground { get; set; }

Property Value

System.Windows.Media.Brush:

The System.Windows.Media.Brush to use when rendering the indicator margin background.

public IIntelliPromptManager IntelliPrompt { get; }

Property Value

IIntelliPromptManager:

The IIntelliPromptManager that manages IntelliPrompt user interface functionality for this editor.

public bool IsAutoCorrectEnabled { get; set; }

Property Value

System.Boolean:

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

System.Boolean:

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

public bool IsCurrentLineHighlightingEnabled { get; set; }

Property Value

System.Boolean:

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

public bool IsDefaultContextMenuEnabled { get; set; }

Property Value

System.Boolean:

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

public bool IsDelimiterAutoCompleteEnabled { get; set; }

Property Value

System.Boolean:

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

System.Boolean:

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

public bool IsDocumentReadOnly { get; set; }

Property Value

System.Boolean:

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

Remarks

You may also use the ITextDocument.IsReadOnly property to alter this value.

public bool IsDragDropTextReselectEnabled { get; set; }

Property Value

System.Boolean:

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

System.Boolean:

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

System.Boolean:

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

System.Boolean:

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

System.Boolean:

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

System.Boolean:

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

System.Boolean:

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

public bool IsRulerMarginVisible { get; set; }

Property Value

System.Boolean:

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

System.Boolean:

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

System.Boolean:

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

System.Boolean:

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 dependency 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 dependency 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 IsViewLineMeasureEnabled { get; set; }

Property Value

System.Boolean:

true if the editor view lines can be measured; otherwise, false. The default value is false.

Remarks

This property affects performance and should only be set to true in specific scenarios where it is desired for the editor to resize based on contents, such as when used within a StackPanel.

public bool IsVirtualSpaceAtLineEndEnabled { get; set; }

Property Value

System.Boolean:

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

System.Boolean:

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

public bool IsWordWrapEnabled { get; set; }

Property Value

System.Boolean:

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

System.Boolean:

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

public Brush LineNumberMarginBackground { get; set; }

Property Value

System.Windows.Media.Brush:

The System.Windows.Media.Brush to use when rendering the line number margin background.

public FontFamily LineNumberMarginFontFamily { get; set; }

Property Value

System.Windows.Media.FontFamily:

The System.Windows.Media.FontFamily to use when rendering line number margin text. The default value is a null value, meaning use the same font family as the text area.

public double LineNumberMarginFontSize { get; set; }

Property Value

System.Double:

The font size to use when rendering line number margin text. The default value is 0, meaning us the same font size as the text area.

public Brush LineNumberMarginForeground { get; set; }

Property Value

System.Windows.Media.Brush:

The System.Windows.Media.Brush to use when rendering line number margin text.

public IMacroRecording MacroRecording { get; }

Property Value

IMacroRecording:

The IMacroRecording that manages macro recording and playback functionality.

public double MaxIntelliPromptZoomLevel { get; set; }

Property Value

System.Double:

A percentage value indicating the maximum zoom level of IntelliPrompt content when the ZoomLevel property is changed. The default value is 3.0, meaning 300%.

Remarks

Ensure the ZoomModesAllowed property is set to an option that supports zooming.

See Also

• MinIntelliPromptZoomLevel
• ZoomLevel
• ZoomModesAllowed

public double MaxZoomLevel { get; set; }

Property Value

System.Double:

A percentage value indicating the maximum zoom level of editor view content. The default value is 3.0, meaning 300%.

Remarks

Ensure the ZoomModesAllowed property is set to an option that supports zooming.

See Also

• MinZoomLevel
• ZoomLevel
• ZoomModesAllowed

public double MinIntelliPromptZoomLevel { get; set; }

Property Value

System.Double:

A percentage value indicating the minimum zoom level of IntelliPrompt content when the ZoomLevel property is changed. The default value is 1.0, meaning 100%.

Remarks

Ensure the ZoomModesAllowed property is set to an option that supports zooming.

See Also

• MaxIntelliPromptZoomLevel
• ZoomLevel
• ZoomModesAllowed

public double MinZoomLevel { get; set; }

Property Value

System.Double:

A percentage value indicating the minimum zoom level of editor view content. The default value is 0.5, meaning 50%.

Remarks

Ensure the ZoomModesAllowed property is set to an option that supports zooming.

See Also

• MaxZoomLevel
• ZoomLevel
• ZoomModesAllowed

public Brush OutliningMarginBackground { get; set; }

Property Value

System.Windows.Media.Brush:

The System.Windows.Media.Brush to use when rendering the outlining margin background.

public IPrintSettings PrintSettings { get; set; }

Property Value

IPrintSettings:

The IPrintSettings that provides access to all printing functionality.

public Brush RulerMarginBackground { get; set; }

Property Value

System.Windows.Media.Brush:

The System.Windows.Media.Brush to use when rendering the ruler margin background.

public Brush RulerMarginForeground { get; set; }

Property Value

System.Windows.Media.Brush:

The System.Windows.Media.Brush to use when rendering the ruler margin foreground.

public TimeSpan ScrollBarAccelerationInterval { get; set; }

Property Value

System.TimeSpan:

A TimeSpan indicating the interval. 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

System.Int32:

A value between 1 and 10 indicating the maximum number of units. 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 DataTemplate ScrollBarTrayBottomTemplate { get; set; }

Property Value

System.Windows.DataTemplate:

The System.Windows.DataTemplate containing controls that are displayed under the vertical ScrollBar in an IEditorView.

public DataTemplate ScrollBarTrayLeftTemplate { get; set; }

Property Value

System.Windows.DataTemplate:

The System.Windows.DataTemplate containing controls that are displayed left of the horizontal ScrollBar in an IEditorView.

public DataTemplate ScrollBarTrayRightTemplate { get; set; }

Property Value

System.Windows.DataTemplate:

The System.Windows.DataTemplate containing controls that are displayed right of the horizontal ScrollBar in an IEditorView.

public DataTemplate ScrollBarTrayTopTemplate { get; set; }

Property Value

System.Windows.DataTemplate:

The System.Windows.DataTemplate containing controls that are displayed above the vertical ScrollBar in an IEditorView.

public bool ScrollToCaretOnSelectAll { get; set; }

Property Value

System.Boolean:

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

public IEditorSearchOptions SearchOptions { get; set; }

Property Value

IEditorSearchOptions:

The IEditorSearchOptions to use when searching within the editor with the search overlay pane.

Remarks

This property defaults to using the static Default property value.

public Brush SelectedTextBackground { get; set; }

Property Value

System.Windows.Media.Brush:

The System.Windows.Media.Brush to use when rendering the active selection background.

public bool SelectionCollapsesOnCopy { get; set; }

Property Value

System.Boolean:

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

public bool SelectionCollapsesToAnchor { get; set; }

Property Value

System.Boolean:

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

public Brush SelectionMarginBackground { get; set; }

Property Value

System.Windows.Media.Brush:

The System.Windows.Media.Brush to use when rendering the selection margin background.

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 and ContinuousStream.

public string Text { get; set; }

Property Value

System.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.

Data binding is off by default on the Text property for two reasons. First, supporting the Text dependency 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 dependency property after each text change, meaning performance could suffer depending on the size of the document.

Data binding can be enabled by setting the IsTextDataBindingEnabled property to true. 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.

When IsTextDataBindingEnabled is false, the TextProperty dependency property is not used and text is get/set directly from the document.

To properly get text substrings from the document, get the current ITextSnapshot from ITextDocument.CurrentSnapshot and use the GetSubstring(Int32, Int32) method. Likewise, to determine document length, use the ITextSnapshot.Length property.

Programmatic document updates should be performed using methods on ITextDocument.

public double TextAreaFontSize { get; set; }

Property Value

System.Double:

The font size to use in the editor's text area only. The default value is 0.0, meaning use the value of the FontSize property.

Remarks

The FontSize property will also affect IntelliPrompt popups and overlay panes. Use this text area font size property if you wish to keep those user interface pieces the normal font size and wish to only update the default text area font size.

public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }

Property Value

System.Windows.Controls.ScrollBarVisibility:

The System.Windows.Controls.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.

public IEditorViewMarginFactoryCollection ViewMarginFactories { get; }

Property Value

IEditorViewMarginFactoryCollection:

A IEditorViewMarginFactoryCollection that contains the factories. The default collection contains a DefaultEditorViewMarginFactory.

public Brush VisibleWhitespaceForeground { get; set; }

Property Value

System.Windows.Media.Brush:

The System.Windows.Media.Brush to use when rendering visible whitespace.

public Brush WordWrapGlyphMarginBackground { get; set; }

Property Value

System.Windows.Media.Brush:

The System.Windows.Media.Brush to use when rendering the word wrap glyph margin background.

public Brush WordWrapGlyphMarginForeground { get; set; }

Property Value

System.Windows.Media.Brush:

The System.Windows.Media.Brush to use when rendering the word wrap glyph margin foreground.

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.

public int WrappedLineIndentAmount { get; set; }

Property Value

System.Int32:

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.

public double ZoomAnimationDuration { get; set; }

Property Value

System.Double:

The duration in milliseconds to animate the scale from one zoom level to the next. The default value is 200ms.

Remarks

Set to 0ms to disable zoom animation.

See Also

• ZoomLevel

public double ZoomLevel { get; set; }

Property Value

System.Double:

A percentage value indicating the zoom level of editor view content. The default value is 1.0, meaning 100%.

See Also

• MinZoomLevel
• MaxZoomLevel
• ZoomAnimationDuration
• ZoomModesAllowed

public double ZoomLevelAnimated { get; set; }

Property Value

System.Double:

A percentage value indicating the current animated zoom level of editor view content.

Remarks

Never set this property directly. Use the ZoomLevel property instead.

See Also

• ZoomLevel

public double ZoomLevelIncrement { get; set; }

Property Value

System.Double:

The percentage increment by which the zoom level changes. The default value is 0.25, meaning 25% increments.

Remarks

Ensure the ZoomModesAllowed property is set to an option that supports zooming.

See Also

• ZoomLevel
• ZoomModesAllowed

public ZoomModes ZoomModesAllowed { get; set; }

Property Value

ZoomModes:

The ZoomModes that indicates the input modes by which zooming can occur. The default value is All.

Remarks

Zooming occurs at 0.25 (25%) increments so plan your MinZoomLevel and MaxZoomLevel settings in increments of 0.25 for best results.

See Also

• MinZoomLevel
• MaxZoomLevel
• ZoomLevel

public static void CloseOverlayPanes(string key)

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

See Also

• OverlayPaneKeys

protected virtual ContextMenu CreateDefaultContextMenu(IEditorView targetView)

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

Returns

System.Windows.Controls.ContextMenu:

The default menu to use.

protected virtual IMacroRecording CreateMacroRecording()

Returns

IMacroRecording:

The IMacroRecording object to use for this editor.

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	System.Windows.Point	The System.Windows.Point to hit test, relative to the editor's coordinates.

Returns

IHitTestResult:

An IHitTestResult that contains the hit test results.

public void InvalidateViews()

public bool IsSelectionModeAllowed(SelectionModes mode)

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

Returns

System.Boolean:

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

protected virtual void OnActiveViewChanged(EditorViewChangedEventArgs e)

Parameter	Type	Description
e	EditorViewChangedEventArgs	The EditorViewChangedEventArgs that contains the event data.

public override void OnApplyTemplate()

protected virtual void OnAreWordWrapGlyphsVisiblePropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	System.Boolean	The old value.
newValue	System.Boolean	The new value.

protected virtual void OnCanSplitHorizontallyPropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	System.Boolean	The old value.
newValue	System.Boolean	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 override void OnContextMenuOpening(ContextMenuEventArgs e)

Parameter	Type	Description
e	System.Windows.Controls.ContextMenuEventArgs	The System.Windows.Controls.ContextMenuEventArgs that contains the event data.

protected override AutomationPeer OnCreateAutomationPeer()

Returns

System.Windows.Automation.Peers.AutomationPeer:

An System.Windows.Automation.Peers.AutomationPeer instance.

protected virtual void OnCutCopyDrag(CutCopyDragEventArgs e)

Parameter	Type	Description
e	CutCopyDragEventArgs	The CutCopyDragEventArgs that contains the event data.

protected virtual void OnDocumentChanged(EditorDocumentChangedEventArgs e)

Parameter	Type	Description
e	EditorDocumentChangedEventArgs	The EditorDocumentChangedEventArgs that contains the event data.

protected virtual void OnDocumentIsModifiedChanged(RoutedEventArgs e)

Parameter	Type	Description
e	System.Windows.RoutedEventArgs	The EventArgs that contains the event data.

protected virtual void OnDocumentIsReadOnlyChanged(RoutedEventArgs e)

Parameter	Type	Description
e	System.Windows.RoutedEventArgs	The EventArgs that contains the event data.

protected virtual void OnDocumentLanguageChanged(EditorDocumentLanguageChangedEventArgs e)

Parameter	Type	Description
e	EditorDocumentLanguageChangedEventArgs	The EditorDocumentLanguageChangedEventArgs that contains the event data.

protected virtual void OnDocumentParseDataChanged(RoutedEventArgs e)

Parameter	Type	Description
e	System.Windows.RoutedEventArgs	The EventArgs that contains 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 EditorSnapshotChangedEventArgs that contains the event data.

protected virtual void OnDocumentTextChanging(EditorSnapshotChangingEventArgs e)

Parameter	Type	Description
e	EditorSnapshotChangingEventArgs	The EditorSnapshotChangingEventArgs that contains the event data.

protected override void OnGotKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameter	Type	Description
e	System.Windows.Input.KeyboardFocusChangedEventArgs	A System.Windows.Input.KeyboardFocusChangedEventArgs that contains the event data.

protected virtual void OnHasHorizontalSplitPropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	System.Boolean	The old value.
newValue	System.Boolean	The new value.

protected virtual void OnHasSearchOverlayPaneKeyBindingsPropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	System.Boolean	The old value.
newValue	System.Boolean	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	System.Double	The old value.
newValue	System.Double	The new value.

protected virtual void OnIsMultiLinePropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	System.Boolean	The old value.
newValue	System.Boolean	The new value.

protected virtual void OnIsOverwriteModeActiveChanged(RoutedEventArgs e)

Parameter	Type	Description
e	System.Windows.RoutedEventArgs	The EventArgs that contains the event data.

protected virtual void OnIsSearchResultHighlightingEnabledPropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	System.Boolean	The old value.
newValue	System.Boolean	The new value.

protected virtual void OnIsVirtualSpaceAtLineEndEnabledPropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	System.Boolean	The old value.
newValue	System.Boolean	The new value.

protected virtual void OnIsWordWrapEnabledPropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	System.Boolean	The old value.
newValue	System.Boolean	The new value.

protected virtual void OnMacroRecordingStateChanged(RoutedEventArgs e)

Parameter	Type	Description
e	System.Windows.RoutedEventArgs	The EventArgs that contains the event data.

protected virtual void OnMenuRequested(SyntaxEditorMenuEventArgs e)

Parameter	Type	Description
e	SyntaxEditorMenuEventArgs	The SyntaxEditorMenuEventArgs that contains the event data.

protected virtual void OnOverlayPaneClosed(OverlayPaneEventArgs e)

Parameter	Type	Description
e	OverlayPaneEventArgs	The OverlayPaneEventArgs that contains the event data.

protected virtual void OnOverlayPaneOpened(OverlayPaneEventArgs e)

Parameter	Type	Description
e	OverlayPaneEventArgs	The OverlayPaneEventArgs that contains the event data.

protected virtual void OnPasteDragDrop(PasteDragDropEventArgs e)

Parameter	Type	Description
e	PasteDragDropEventArgs	The PasteDragDropEventArgs that contains 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 OnPropertyChanged(DependencyPropertyChangedEventArgs e)

Parameter	Type	Description
e	System.Windows.DependencyPropertyChangedEventArgs	A DependencyPropertyChangedEventArgs that contains the event data.

protected virtual void OnUserInterfaceUpdate(RoutedEventArgs e)

Parameter	Type	Description
e	System.Windows.RoutedEventArgs	The EventArgs that contains the event data.

protected virtual void OnViewActionExecuting(EditActionEventArgs e)

Parameter	Type	Description
e	EditActionEventArgs	The EditActionEventArgs that contains the event data.

protected virtual void OnViewClosed(TextViewEventArgs e)

Parameter	Type	Description
e	TextViewEventArgs	The TextViewEventArgs that contains the event data.

protected virtual void OnViewIsIncrementalSearchActiveChanged(TextViewEventArgs e)

Parameter	Type	Description
e	TextViewEventArgs	The TextViewEventArgs that contains the event data.

protected virtual void OnViewOpened(TextViewEventArgs e)

Parameter	Type	Description
e	TextViewEventArgs	The TextViewEventArgs that contains the event data.

protected virtual void OnViewSearch(EditorViewSearchEventArgs e)

Parameter	Type	Description
e	EditorViewSearchEventArgs	The EditorViewSearchEventArgs that contains the event data.

protected virtual void OnViewSelectionChanged(EditorViewSelectionEventArgs e)

Parameter	Type	Description
e	EditorViewSelectionEventArgs	The EditorViewSelectionEventArgs that contains the event data.

protected virtual void OnViewSplitAdded(RoutedEventArgs e)

Parameter	Type	Description
e	System.Windows.RoutedEventArgs	The EventArgs that contains the event data.

protected virtual void OnViewSplitMoved(RoutedEventArgs e)

Parameter	Type	Description
e	System.Windows.RoutedEventArgs	The EventArgs that contains the event data.

protected virtual void OnViewSplitRemoved(RoutedEventArgs e)

Parameter	Type	Description
e	System.Windows.RoutedEventArgs	The EventArgs that contains the event data.

protected virtual void OnWordWrapModeChanged(RoutedEventArgs e)

Parameter	Type	Description
e	System.Windows.RoutedEventArgs	The EventArgs that contains 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 virtual void OnZoomLevelPropertyChanged(double oldValue, double newValue)

Parameter	Type	Description
oldValue	System.Double	The old value.
newValue	System.Double	The new value.

public virtual void ResetCommandBindings()

public virtual void ResetInputBindings()

public void ResetViews()

public void ResumeCaretBlinking()

public bool ShowPrintDialog()

Returns

System.Boolean:

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

public bool ShowPrintPreviewDialog()

Returns

System.Boolean:

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

Remarks

This dialog cannot be displayed in an XBAP.

public void SuspendCaretBlinking(bool show)

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

public event EventHandler<EditorViewChangedEventArgs> ActiveViewChanged

Event Type

System.EventHandler<EditorViewChangedEventArgs>

public event EventHandler<CutCopyDragEventArgs> CutCopyDrag

Event Type

System.EventHandler<CutCopyDragEventArgs>

public event EventHandler<EditorDocumentChangedEventArgs> DocumentChanged

Event Type

System.EventHandler<EditorDocumentChangedEventArgs>

public event RoutedEventHandler DocumentIsModifiedChanged

Event Type

System.Windows.RoutedEventHandler

public event RoutedEventHandler DocumentIsReadOnlyChanged

Event Type

System.Windows.RoutedEventHandler

public event EventHandler<EditorDocumentLanguageChangedEventArgs> DocumentLanguageChanged

Event Type

System.EventHandler<EditorDocumentLanguageChangedEventArgs>

public event RoutedEventHandler DocumentParseDataChanged

Event Type

System.Windows.RoutedEventHandler

public event EventHandler<EditorSnapshotChangedEventArgs> DocumentTextChanged

Event Type

System.EventHandler<EditorSnapshotChangedEventArgs>

public event EventHandler<EditorSnapshotChangingEventArgs> DocumentTextChanging

Event Type

System.EventHandler<EditorSnapshotChangingEventArgs>

public event RoutedEventHandler IsOverwriteModeActiveChanged

Event Type

System.Windows.RoutedEventHandler

public event RoutedEventHandler MacroRecordingStateChanged

Event Type

System.Windows.RoutedEventHandler

public event EventHandler<SyntaxEditorMenuEventArgs> MenuRequested

Event Type

System.EventHandler<SyntaxEditorMenuEventArgs>

public event EventHandler<OverlayPaneEventArgs> OverlayPaneClosed

Event Type

System.EventHandler<OverlayPaneEventArgs>

public event EventHandler<OverlayPaneEventArgs> OverlayPaneOpened

Event Type

System.EventHandler<OverlayPaneEventArgs>

public event EventHandler<PasteDragDropEventArgs> PasteDragDrop

Event Type

System.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 RoutedEventHandler UserInterfaceUpdate

Event Type

System.Windows.RoutedEventHandler

public event EventHandler<EditActionEventArgs> ViewActionExecuting

Event Type

System.EventHandler<EditActionEventArgs>

public event EventHandler<TextViewEventArgs> ViewClosed

Event Type

System.EventHandler<TextViewEventArgs>

public event EventHandler<TextViewEventArgs> ViewIsIncrementalSearchActiveChanged

Event Type

System.EventHandler<TextViewEventArgs>

public event EventHandler<TextViewEventArgs> ViewOpened

Event Type

System.EventHandler<TextViewEventArgs>

public event EventHandler<EditorViewSearchEventArgs> ViewSearch

Event Type

System.EventHandler<EditorViewSearchEventArgs>

public event EventHandler<EditorViewSelectionEventArgs> ViewSelectionChanged

Event Type

System.EventHandler<EditorViewSelectionEventArgs>

public event RoutedEventHandler ViewSplitAdded

Event Type

System.Windows.RoutedEventHandler

public event RoutedEventHandler ViewSplitMoved

Event Type

System.Windows.RoutedEventHandler

public event RoutedEventHandler ViewSplitRemoved

Event Type

System.Windows.RoutedEventHandler

public event RoutedEventHandler WordWrapModeChanged

Event Type

System.Windows.RoutedEventHandler

public static readonly DependencyProperty AcceptsTabProperty

public static readonly RoutedEvent ActiveViewChangedEvent

public static readonly DependencyProperty ActiveViewProperty

public static readonly DependencyProperty AllowDragProperty

public static readonly DependencyProperty AreColumnGuidesVisibleProperty

public static readonly DependencyProperty AreIndentationGuidesVisibleProperty

public static readonly DependencyProperty AreLineModificationMarksVisibleProperty

public static readonly DependencyProperty AreMultipleSelectionRangesEnabledProperty

public static readonly DependencyProperty AreSelectionGrippersEnabledProperty

public static readonly DependencyProperty AreWordWrapGlyphsVisibleProperty

public static readonly DependencyProperty CanBackspaceOverSpacesToTabStopProperty

public static readonly DependencyProperty CanCutCopyBlankLineWhenNoSelectionProperty

public static readonly DependencyProperty CanCutCopyDragWithHtmlProperty

public static readonly DependencyProperty CanCutCopyDragWithRtfProperty

public static readonly DependencyProperty CanIncrementalSearchTrimUnmatchedFindTextProperty

public static readonly DependencyProperty CanMoveCaretForSecondaryPointerButtonProperty

public static readonly DependencyProperty CanMoveCaretToNextLineAtLineEndProperty

public static readonly DependencyProperty CanMoveCaretToPreviousLineAtLineStartProperty

public static readonly DependencyProperty CanPointerWheelScrollUnfocusedViewsProperty

public static readonly DependencyProperty CanScrollPastDocumentEndProperty

public static readonly DependencyProperty CanSplitHorizontallyProperty

public static readonly DependencyProperty CaretBlinkIntervalProperty

public static readonly DependencyProperty CaretBrushProperty

public static readonly DependencyProperty CaretInsertKindProperty

public static readonly DependencyProperty CaretInsertWidthProperty

public static readonly DependencyProperty CaretOverwriteKindProperty

public static readonly DependencyProperty CaretOverwriteWidthProperty

public static readonly DependencyProperty ColumnGuidesProperty

public static readonly RoutedEvent CutCopyDragEvent

public static readonly RoutedEvent DocumentChangedEvent

public static readonly RoutedEvent DocumentIsModifiedChangedEvent

public static readonly RoutedEvent DocumentIsReadOnlyChangedEvent

public static readonly RoutedEvent DocumentLanguageChangedEvent

public static readonly RoutedEvent DocumentParseDataChangedEvent

public static readonly DependencyProperty DocumentProperty

public static readonly RoutedEvent DocumentTextChangedEvent

public static readonly RoutedEvent DocumentTextChangingEvent

public static readonly DependencyProperty HasHorizontalSplitProperty

public static readonly DependencyProperty HasSearchOverlayPaneKeyBindingsProperty

public static readonly DependencyProperty HighlightingStyleRegistryProperty

public static readonly DependencyProperty HorizontalScrollBarVisibilityProperty

public static readonly DependencyProperty HorizontalSplitPercentageProperty

public static readonly DependencyProperty InactiveSelectedTextBackgroundProperty

public static readonly DependencyProperty IndicatorMarginBackgroundProperty

public static readonly DependencyProperty IsAutoCorrectEnabledProperty

public static readonly DependencyProperty IsCollapsibleRegionHighlightingEnabledProperty

public static readonly DependencyProperty IsCurrentLineHighlightingEnabledProperty

public static readonly DependencyProperty IsDefaultContextMenuEnabledProperty

public static readonly DependencyProperty IsDelimiterAutoCompleteEnabledProperty

public static readonly DependencyProperty IsDelimiterHighlightingEnabledProperty

public static readonly DependencyProperty IsDocumentReadOnlyProperty

public static readonly DependencyProperty IsDragDropTextReselectEnabledProperty

public static readonly DependencyProperty IsImeEnabledProperty

public static readonly DependencyProperty IsIndicatorMarginVisibleProperty

public static readonly DependencyProperty IsLineNumberMarginVisibleProperty

public static readonly DependencyProperty IsMultiLineProperty

public static readonly DependencyProperty IsOutliningMarginVisibleProperty

public static readonly RoutedEvent IsOverwriteModeActiveChangedEvent

public static readonly DependencyProperty IsOverwriteModeActiveProperty

public static readonly DependencyProperty IsRulerMarginVisibleProperty

public static readonly DependencyProperty IsSearchResultHighlightingEnabledProperty

public static readonly DependencyProperty IsSelectionMarginVisibleProperty

public static readonly DependencyProperty IsTextDataBindingEnabledProperty

public static readonly DependencyProperty IsViewLineMeasureEnabledProperty

public static readonly DependencyProperty IsVirtualSpaceAtLineEndEnabledProperty

public static readonly DependencyProperty IsWhitespaceVisibleProperty

public static readonly DependencyProperty IsWordWrapEnabledProperty

public static readonly DependencyProperty IsWordWrapGlyphMarginVisibleProperty

public static readonly DependencyProperty LineNumberMarginBackgroundProperty

public static readonly DependencyProperty LineNumberMarginFontFamilyProperty

public static readonly DependencyProperty LineNumberMarginFontSizeProperty

public static readonly DependencyProperty LineNumberMarginForegroundProperty

public static readonly RoutedEvent MacroRecordingStateChangedEvent

public static readonly DependencyProperty MaxIntelliPromptZoomLevelProperty

public static readonly DependencyProperty MaxZoomLevelProperty

public static readonly RoutedEvent MenuRequestedEvent

public static readonly DependencyProperty MinIntelliPromptZoomLevelProperty

public static readonly DependencyProperty MinZoomLevelProperty

public static readonly DependencyProperty OutliningMarginBackgroundProperty

public static readonly RoutedEvent OverlayPaneClosedEvent

public static readonly RoutedEvent OverlayPaneOpenedEvent

public static readonly RoutedEvent PasteDragDropEvent

public static readonly DependencyProperty PrintSettingsProperty

public static readonly DependencyProperty RulerMarginBackgroundProperty

public static readonly DependencyProperty RulerMarginForegroundProperty

public static readonly DependencyProperty ScrollBarAccelerationIntervalProperty

public static readonly DependencyProperty ScrollBarAccelerationMaximumProperty

public static readonly DependencyProperty ScrollBarTrayBottomTemplateProperty

public static readonly DependencyProperty ScrollBarTrayLeftTemplateProperty

public static readonly DependencyProperty ScrollBarTrayRightTemplateProperty

public static readonly DependencyProperty ScrollBarTrayTopTemplateProperty

public static readonly DependencyProperty ScrollToCaretOnSelectAllProperty

public static readonly DependencyProperty SearchOptionsProperty

public static readonly DependencyProperty SelectedTextBackgroundProperty

public static readonly DependencyProperty SelectionCollapsesOnCopyProperty

public static readonly DependencyProperty SelectionCollapsesToAnchorProperty

public static readonly DependencyProperty SelectionMarginBackgroundProperty

public static readonly DependencyProperty SelectionModesAllowedProperty

public static readonly DependencyProperty TextAreaFontSizeProperty

public static readonly DependencyProperty TextProperty

public static readonly RoutedEvent UserInterfaceUpdateEvent

public static readonly DependencyProperty VerticalScrollBarVisibilityProperty

public static readonly RoutedEvent ViewActionExecutingEvent

public static readonly RoutedEvent ViewClosedEvent

public static readonly RoutedEvent ViewIsIncrementalSearchActiveChangedEvent

public static readonly RoutedEvent ViewOpenedEvent

public static readonly RoutedEvent ViewSearchEvent

public static readonly RoutedEvent ViewSelectionChangedEvent

public static readonly RoutedEvent ViewSplitAddedEvent

public static readonly RoutedEvent ViewSplitMovedEvent

public static readonly RoutedEvent ViewSplitRemovedEvent

public static readonly DependencyProperty VisibleWhitespaceForegroundProperty

public static readonly DependencyProperty WordWrapGlyphMarginBackgroundProperty

public static readonly DependencyProperty WordWrapGlyphMarginForegroundProperty

public static readonly RoutedEvent WordWrapModeChangedEvent

public static readonly DependencyProperty WordWrapModeProperty

public static readonly DependencyProperty WrappedLineIndentAmountProperty

public static readonly DependencyProperty ZoomAnimationDurationProperty

public static readonly DependencyProperty ZoomLevelAnimatedProperty

public static readonly DependencyProperty ZoomLevelIncrementProperty

public static readonly DependencyProperty ZoomLevelProperty

public static readonly DependencyProperty ZoomModesAllowedProperty