EditorView Class

public class EditorView : TextView, IInputElement, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, IEditorView, ITextView, ITextViewTaggerProvider, IEditorViewIntelliPrompt, IEditorViewSearcher, IEditorViewTextChangeActions, ITextPositionFinder

public bool CanSplitHorizontally { get; }

Property Value

bool:

true if the view can be split horizontally via a splitter; otherwise, false.

protected override ITagAggregator<IClassificationTag> ClassificationTagAggregator { get; }

Property Value

ITagAggregator<IClassificationTag>:

The IClassificationTag aggregator for the view.

public override ICollapsedRegionManager CollapsedRegionManager { get; }

Property Value

ICollapsedRegionManager:

An ICollapsedRegionManager that provides information about collapsed regions in the view.

public bool ContainsFocus { get; }

Property Value

bool:

true if the view currently has or contains keyboard focus; otherwise, false.

Remarks

A view can contain focus if a nested control such as an adornment or search overlay pane has focus.

public ITextSnapshotLine CurrentSnapshotLine { get; }

Property Value

ITextSnapshotLine:

The current ITextSnapshotLine that the primary caret appears on within the view.

public ITextViewLine CurrentViewLine { get; }

Property Value

ITextViewLine:

The current ITextViewLine that the primary caret appears on within the view.

public bool HasFocus { get; }

Property Value

bool:

true if the view currently has keyboard focus; otherwise, false.

public ISearchOptions HighlightedResultSearchOptions { get; set; }

Property Value

ISearchOptions:

The ISearchOptions to use for searching when highlighting search results.

Remarks

Highlighted results are displayed when using incremental search and the IsSearchResultHighlightingEnabled property is set to true. This property can also be manually set when using a search pane as the user types, so that results will be immediately displayed. Set the property to null to stop highlighting.

public override IHighlightingStyleRegistry HighlightingStyleRegistry { get; }

Property Value

IHighlightingStyleRegistry:

The IHighlightingStyleRegistry used by this view.

public IEditorViewIntelliPrompt IntelliPrompt { get; }

Property Value

IEditorViewIntelliPrompt:

The IEditorViewIntelliPrompt to use for requesting IntelliPrompt within the view.

protected override ITagAggregator<IIntraLineSpacerTag> IntraLineSpacerTagAggregator { get; }

Property Value

ITagAggregator<IIntraLineSpacerTag>:

The IIntraLineSpacerTag aggregator for the view.

protected override ITagAggregator<IIntraTextSpacerTag> IntraTextSpacerTagAggregator { get; }

Property Value

ITagAggregator<IIntraTextSpacerTag>:

The IIntraTextSpacerTag aggregator for the view.

public bool IsActive { get; }

Property Value

bool:

true if the view is the currently-active view in the editor; otherwise, false.

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

Property Value

bool:

true if incremental searching is active; otherwise, false.

public override bool IsWhitespaceVisible { get; }

Property Value

bool:

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

public IEditorViewMarginCollection Margins { get; }

Property Value

IEditorViewMarginCollection:

The collection of margins that are currently in the view.

public IEditorViewOverlayPaneCollection OverlayPanes { get; }

Property Value

IEditorViewOverlayPaneCollection:

The collection of IOverlayPane instances that are open in the view.

public EditorViewPlacement Placement { get; }

Property Value

EditorViewPlacement:

A EditorViewPlacement indicating the location of the view.

public ITextPositionFinder PositionFinder { get; }

Property Value

ITextPositionFinder:

The ITextPositionFinder instance.

protected override Rectangle ScrollableContentHostBounds { get; }

Property Value

Rectangle:

A Rectangle indicating the bounds of scrollable content host, relative to view coordinates.

public IEditorViewSearcher Searcher { get; }

Property Value

IEditorViewSearcher:

The IEditorViewSearcher that is used to perform find/replace and other search-related operations on the view.

public string SelectedText { get; set; }

Property Value

string:

The text of the current primary selection range in the view.

public IEditorViewSelection Selection { get; }

Property Value

IEditorViewSelection:

An IEditorViewSelection that manages the selection within the view.

public TextSnapshotRange SelectionScopeSnapshotRange { get; }

Property Value

TextSnapshotRange:

The TextSnapshotRange in which to search for selection-based scopes.

protected override ITagAggregator<ISquiggleTag> SquiggleTagAggregator { get; }

Property Value

ITagAggregator<ISquiggleTag>:

The ISquiggleTag aggregator for the view.

public IEnumerable<Type> TagTypes { get; }

Property Value

IEnumerable<Type>:

The ITagType objects that are supported by the ITagger<T> objects created by this provider.

public override Padding TextAreaPadding { get; }

Property Value

Padding:

The padding thickness around the text area content.

public override Size TextAreaSize { get; }

Property Value

Size:

The size of the text area in text area coordinates.

public override Rectangle TextAreaViewportBounds { get; }

Property Value

Rectangle:

A Rectangle indicating the bounds of the visible portion of the text area, relative to view coordinates.

public IEditorViewTextChangeActions TextChangeActions { get; }

Property Value

IEditorViewTextChangeActions:

The IEditorViewTextChangeActions that is used to perform text change actions in the view.

protected override ITagAggregator<IUnusedRegionTag> UnusedRegionTagAggregator { get; }

Property Value

ITagAggregator<IUnusedRegionTag>:

The IUnusedRegionTag aggregator for the view.

protected override bool UseSyntaxEditorDisplayItemProperties { get; }

Property Value

bool:

true if SyntaxEditor display item properties should be used; otherwise, false.

protected override WordWrapMode WordWrapMode { get; }

Property Value

WordWrapMode:

A WordWrapMode value indicating the type of word wrapping that is performed.

public void Activate()

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.

protected override Size ArrangeOverride(Size finalSize)

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

Returns

Size:

The actual size used.

Remarks

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

public void Backspace()

public void BackspaceToPreviousWord()

public void ChangeCharacterCasing(CharacterCasing casing)

Parameter	Type	Description
casing	CharacterCasing	A CharacterCasing indicating the character case to change to.

Remarks

If no text is currently selected in the view, only the character after the caret is changed. A casing value of CharacterCasing.Normal will capitalize the first letter of each word.

protected override void Close()

public void CommentLines()

public void ConvertSpacesToTabs()

public void ConvertTabsToSpaces()

public void CopyAndAppendToClipboard()

public void CopyToClipboard()

protected override IList CreateChildren()

Returns

IList:

The IList that should be assigned to the Children property.

Remarks

By default no child collection is created.

public override ITagAggregator<T> CreateTagAggregator<T>() where T : ITag

Type Parameters:

T -

The type of ITag associated with this aggregator.

Returns

ITagAggregator<T>:

The ITagAggregator<T> that was created.

public void CutAndAppendToClipboard()

public void CutLineToClipboard()

public void CutToClipboard()

public void Delete()

public void DeleteBlankLines()

Remarks

If there is no selection and the current line is not blank, any blank view lines immediately before the current view line will be deleted.

public void DeleteHorizontalWhitespace()

public void DeleteLine()

public bool DeleteSelectedText(ITextChangeType type)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

public bool DeleteSelectedText(ITextChangeType type, IEditorViewTextChangeOptions options)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
options	IEditorViewTextChangeOptions	The IEditorViewTextChangeOptions for the change.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

public void DeleteToLineEnd()

public void DeleteToLineStart()

public void DeleteToNextWord()

public void Duplicate()

public bool ExecuteEditAction(IEditAction action)

Parameter	Type	Description
action	IEditAction	The IEditAction to execute.

Returns

bool:

true if the action was able to execute; otherwise, false.

public string ExportSelectedText(ITextExporter exporter)

Parameter	Type	Description
exporter	ITextExporter	The ITextExporter to use for the export operation.

Returns

string:

The exported text.

public ISearchResultSet FindAll(IEditorSearchOptions options)

Parameter	Type	Description
options	IEditorSearchOptions	The IEditorSearchOptions to use.

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

public ISearchResultSet FindCurrentOrNext(IEditorSearchOptions options)

Parameter	Type	Description
options	IEditorSearchOptions	The IEditorSearchOptions to use.

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

public int FindCurrentWordEnd()

Returns

int:

The document offset of the word end character that occurs at or after the primary caret.

public int FindCurrentWordStart()

Returns

int:

The document offset of the word start character that occurs at or before the primary caret.

public ISearchResultSet FindNext(IEditorSearchOptions options)

Parameter	Type	Description
options	IEditorSearchOptions	The IEditorSearchOptions to use.

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

public ISearchResultSet FindNextIncremental(bool searchUp)

Parameter	Type	Description
searchUp	bool	Whether to search upwards.

Returns

ISearchResultSet:

A ISearchResultSet that specifies the result of the operation.

public int FindNextWordStart()

Returns

int:

The document offset of the word start character that occurs after the primary caret.

public int FindPreviousWordStart()

Returns

int:

The document offset of the word start character that occurs before the primary caret.

public bool Focus()

Returns

bool:

true if focus was successfully set; otherwise, false.

public bool Focus(FocusState state)

Parameter	Type	Description
state	FocusState	A FocusState specifying the reason for focus to be set.

Returns

bool:

true if focus was successfully set or was already set; otherwise, false.

public void FormatDocument()

public void FormatSelection()

public override IAdornmentLayer GetAdornmentLayer(AdornmentLayerDefinition layerDefinition)

Parameter	Type	Description
layerDefinition	AdornmentLayerDefinition	The layer definition.

Returns

IAdornmentLayer:

An IAdornmentLayer for the view with the specified string-based key.

Remarks

If no IAdornmentLayer already exists with the specified name, one is created.

public TextBounds GetCharacterBounds(TextPosition position)

Parameter	Type	Description
position	TextPosition	The TextPosition whose bounds need to be retrieved.

Returns

TextBounds:

A TextBounds containing the visible character bounds for the specified TextPosition.

public TextBounds GetCharacterBounds(int offset)

Parameter	Type	Description
offset	int	The offset whose bounds need to be retrieved.

Returns

TextBounds:

A TextBounds containing the visible character bounds for the specified offset.

public TextBounds GetCharacterBounds(int offset, bool hasFarAffinity)

Parameter	Type	Description
offset	int	The offset whose bounds need to be retrieved.
hasFarAffinity	bool	Whether the offset has affinity for the far side, which is used when the offset is where a view line is wrapped to a second view line.

Returns

TextBounds:

A TextBounds containing the visible character bounds for the specified offset.

public int GetCharacterColumn(TextPosition position)

Parameter	Type	Description
position	TextPosition	The TextPosition whose column index is being requested.

Returns

int:

The column index within the view for the specified TextPosition.

public int GetCharacterColumn(int offset)

Parameter	Type	Description
offset	int	The offset whose column index is being requested.

Returns

int:

The column index within the view for the specified offset.

public int GetCharacterColumn(int offset, bool hasFarAffinity)

Parameter	Type	Description
offset	int	The offset whose column index is being requested.
hasFarAffinity	bool	Whether the offset has affinity for the far side, which is used when the offset is where a view line is wrapped to a second view line.

Returns

int:

The column index within the view for the specified offset.

public IList<Range> GetCharacterIndexRanges(TextPositionRange positionRange)

Parameter	Type	Description
positionRange	TextPositionRange	The TextPositionRange to examine.

Returns

IList<Range>:

The collection of character index Range objects for characters contained on each view line in the specified TextPositionRange.

public IList<Range> GetCharacterIndexRanges(TextPositionRange positionRange, int minimumLines)

Parameter	Type	Description
positionRange	TextPositionRange	The TextPositionRange to examine.
minimumLines	int	The minimum number of lines to return, used for block selections. For continuous stream selections, pass 1.

Returns

IList<Range>:

The collection of character index Range objects for characters contained on each view line in the specified TextPositionRange.

public string GetCurrentWordText()

Returns

string:

The text of the current word.

public TextRange GetCurrentWordTextRange()

Returns

TextRange:

A TextRange containing the offset range for the current word.

public override Cursor GetCursor(Point point)

Parameter	Type	Description
point	Point	The Point to examine.

Returns

Cursor:

The Cursor that should be used when the mouse is over the element at the specified Point.

public TextPosition GetPositionForCharacterDelta(TextPosition position, int characterDelta, bool wrapAtLineTerminators, bool forceVirtualSpace)

Parameter	Type	Description
position	TextPosition	The start TextPosition from which to search.
characterDelta	int	The number of visible characters (can be negative) relative to the start TextPosition that should be traversed to find the result.
wrapAtLineTerminators	bool	Whether to wrap to the next/previous view line when a line terminator is encountered.
forceVirtualSpace	bool	Whether to force virtual space to be used (for block selections).

Returns

TextPosition:

The TextPosition that would found based on the criteria.

public TextPosition GetPositionForLineDelta(TextPosition position, int lineDelta, int? preferredHorizontalLocation, bool forceVirtualSpace)

Parameter	Type	Description
position	TextPosition	The start TextPosition from which to search.
lineDelta	int	The number of visible view lines (can be negative) relative to the start TextPosition that should be traversed to find the result.
preferredHorizontalLocation	int?	The preferred horizontal location, if known.
forceVirtualSpace	bool	Whether to force virtual space to be used (for block selections).

Returns

TextPosition:

The TextPosition that would found based on the criteria.

public TextPosition GetPositionForLineEnd(TextPosition position)

Parameter	Type	Description
position	TextPosition	The start TextPosition from which to search.

Returns

TextPosition:

The TextPosition that would found based on the criteria.

public TextPosition GetPositionForLineStart(TextPosition position)

Parameter	Type	Description
position	TextPosition	The start TextPosition from which to search.

Returns

TextPosition:

The TextPosition that would found based on the criteria.

public ITextSnapshotReader GetReader()

Returns

ITextSnapshotReader:

An ITextBufferReader, initialized at the caret offset, that can be used to navigate through the text and token contents of the current snapshot.

public ITagger<T> GetTagger<T>(ITextView view) where T : ITag

Type Parameters:

T -

The type of ITag created by the tagger.

Parameter	Type	Description
view	ITextView	The ITextView that requires an ITagger<T>.

Returns

ITagger<T>:

An ITagger<T> for the specified ITextView.

public ITextStatistics GetTextStatisticsForSelectedText()

Returns

ITextStatistics:

The ITextStatistics for the selected text in the view.

public ITextViewLine GetViewLine(double verticalLocation, LocationToPositionAlgorithm algorithm)

Parameter	Type	Description
verticalLocation	double	The Y location to examine, in text area-relative coordinates.
algorithm	LocationToPositionAlgorithm	The LocationToPositionAlgorithm to use for calculation.

Returns

ITextViewLine:

The ITextViewLine that contains the specified Y location.

public string GetVirtualCharacterFillString(TextPosition position, bool returnCharacterFill)

Parameter	Type	Description
position	TextPosition	The TextPosition to be examined.
returnCharacterFill	bool	Whether to return a character fill in addition to line fill.

Returns

string:

A string specifying the indentation (tabs and/or spaces) needed to fill a view line up to the specified TextPosition.

Remarks

This method will return Empty if the character is not a virtual character.

public void Indent()

public void InsertFile(string path)

Parameter	Type	Description
path	string	The fully qualified path to the file that will be inserted.

public void InsertLineBreak()

public bool InsertSurroundingText(ITextChangeType type, string preText, string postText)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
preText	string	The text to insert before the currently selected text ranges.
postText	string	The text to insert after the currently selected text ranges.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

public bool InsertSurroundingText(ITextChangeType type, string preText, string postText, bool reselect)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
preText	string	The text to insert before the currently selected text ranges.
postText	string	The text to insert after the currently selected text ranges.
reselect	bool	Whether to reselect the inner text.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

public bool InsertSurroundingText(string preText, string postText)

Parameter	Type	Description
preText	string	The text to insert before the currently selected text ranges.
postText	string	The text to insert after the currently selected text ranges.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

public bool IsVirtualCharacter(TextPosition position, bool lineTerminatorsAreVirtual)

Parameter	Type	Description
position	TextPosition	The TextPosition to examine.
lineTerminatorsAreVirtual	bool	Indicates whether to treat line terminators as virtual characters.

Returns

bool:

true if the specified TextPosition is a virtual character (beyond line or document end); otherwise, false.

public bool IsVirtualLine(TextPosition position)

Parameter	Type	Description
position	TextPosition	The TextPosition to examine.

Returns

bool:

true if the specified TextPosition is a virtual line (beyond document end); otherwise, false.

public bool IsVirtualLine(int positionLineIndex)

Parameter	Type	Description
positionLineIndex	int	The TextPosition line index to examine.

Returns

bool:

true if the specified TextPosition line index is a virtual line (beyond document end); otherwise, false.

public TextPosition LocationToPosition(Point location, LocationToPositionAlgorithm algorithm)

Parameter	Type	Description
location	Point	A Point specifying a location in text area-relative coordinates.
algorithm	LocationToPositionAlgorithm	The LocationToPositionAlgorithm to use for calculation.

Returns

TextPosition:

The TextPosition for the specified location.

Remarks

If using an absolute algorithm and no valid TextPosition is located, TextPosition.Empty will be returned.

protected override Size MeasureOverride(Graphics g, Size availableSize)

Parameter	Type	Description
g	Graphics	The Graphics to use for measurement.
availableSize	Size	The available size.

Returns

Size:

The desired size.

public void MoveSelectedLinesDown()

public void MoveSelectedLinesUp()

protected virtual void OnCanSplitHorizontallyPropertyChanged(bool oldValue, bool newValue)

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

protected virtual void OnHasFocusChanged(EventArgs e)

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

protected virtual void OnHighlightedResultSearchOptionsChanged(EventArgs e)

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

protected override void OnRender(PaintEventArgs e)

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

protected override void OnRendered()

protected override void OnScrollStatePropertyChanged(TextViewScrollState oldValue, TextViewScrollState newValue)

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

protected virtual void OnSelectionChanged(EditorViewSelectionEventArgs e)

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

protected override void OnTextAreaLayout(TextViewTextAreaLayoutEventArgs e)

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

public void OpenLineAbove()

public void OpenLineBelow()

public void Outdent()

public void PasteFromClipboard()

public void PerformInsertTyping(string text)

Parameter	Type	Description
text	string	The text that was typed.

public void PerformOverwriteTyping(string text)

Parameter	Type	Description
text	string	The text that was typed.

public void PerformTyping(string text)

Parameter	Type	Description
text	string	The text that was typed.

public ISearchResultSet ReplaceAll(IEditorSearchOptions options)

Parameter	Type	Description
options	IEditorSearchOptions	The IEditorSearchOptions to use.

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

public ISearchResultSet ReplaceNext(IEditorSearchOptions options)

Parameter	Type	Description
options	IEditorSearchOptions	The IEditorSearchOptions to use.

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

public bool ReplaceSelectedText(ITextChangeType type, string text)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
text	string	The text to insert.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

public bool ReplaceSelectedText(ITextChangeType type, string text, IEditorViewTextChangeOptions options)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
text	string	The text to insert.
options	IEditorViewTextChangeOptions	The IEditorViewTextChangeOptions for the change.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

public void RequestAutoComplete()

public void RequestCompletionSession()

public void RequestInsertSnippetSession()

public void RequestParameterInfoSession()

public void RequestQuickInfoSession()

public void RequestSurroundWithSession()

public void SetSearchStartOffset(IEditorSearchOptions options)

Parameter	Type	Description
options	IEditorSearchOptions	The IEditorSearchOptions to use.

public void StartPointerSelection(InputPointerButtonEventArgs e)

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

Remarks

The left or right pointer button must be pressed when this method is called. When the left button pointer selection starts, the pointer will be captured and further selection processing will be handled automatically.

public void TabifySelectedLines()

public void ToggleCharacterCasing()

Remarks

If no text is currently selected, only the character after the caret is changed.

public override Point TransformFromTextArea(Point location)

Parameter	Type	Description
location	Point	The Point to transform.

Returns

Point:

The transformed Point.

public override Rectangle TransformFromTextArea(Rectangle bounds)

Parameter	Type	Description
bounds	Rectangle	The Rectangle to transform.

Returns

Rectangle:

The transformed Rectangle.

public override Point TransformToTextArea(Point location)

Parameter	Type	Description
location	Point	The Point to transform.

Returns

Point:

The transformed Point.

public override Rectangle TransformToTextArea(Rectangle bounds)

Parameter	Type	Description
bounds	Rectangle	The Rectangle to transform.

Returns

Rectangle:

The transformed Rectangle.

public void TransposeCharacters()

public void TransposeLines()

public void TransposeWords()

public void TrimAllTrailingWhitespace()

public void TrimTrailingWhitespace()

public void UncommentLines()

public void UntabifySelectedLines()

public event EventHandler HasFocusChanged

Event Type

EventHandler

public event EventHandler HighlightedResultSearchOptionsChanged

Event Type

EventHandler

public event EventHandler<EditorViewSelectionEventArgs> SelectionChanged

Event Type

EventHandler<EditorViewSelectionEventArgs>