IEditorView Interface

public interface IEditorView : ITextView

bool ContainsFocus { get; }

Property Value

Boolean:

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.

ITextSnapshotLine CurrentSnapshotLine { get; }

Property Value

ITextSnapshotLine:

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

ITextViewLine CurrentViewLine { get; }

Property Value

ITextViewLine:

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

bool HasFocus { get; }

Property Value

Boolean:

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

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.

IEditorViewIntelliPrompt IntelliPrompt { get; }

Property Value

IEditorViewIntelliPrompt:

The IEditorViewIntelliPrompt to use for requesting IntelliPrompt within the view.

bool IsActive { get; }

Property Value

Boolean:

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. Use the HasFocus property to determine if the view currently has keyboard focus.

bool IsIncrementalSearchActive { get; set; }

Property Value

Boolean:

true if incremental searching is active; otherwise, false.

IEditorViewMarginCollection Margins { get; }

Property Value

IEditorViewMarginCollection:

The collection of margins that are currently in the view.

IEditorViewOverlayPaneCollection OverlayPanes { get; }

Property Value

IEditorViewOverlayPaneCollection:

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

EditorViewPlacement Placement { get; }

Property Value

EditorViewPlacement:

A EditorViewPlacement indicating the location of the view.

ITextPositionFinder PositionFinder { get; }

Property Value

ITextPositionFinder:

The ITextPositionFinder instance.

IEditorViewScroller Scroller { get; }

Property Value

IEditorViewScroller:

The IEditorViewScroller to use for scrolling the view.

IEditorViewSearcher Searcher { get; }

Property Value

IEditorViewSearcher:

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

string SelectedText { get; set; }

Property Value

String:

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

IEditorViewSelection Selection { get; }

Property Value

IEditorViewSelection:

An IEditorViewSelection that manages the selection within the view.

IEditorViewTextChangeActions TextChangeActions { get; }

Property Value

IEditorViewTextChangeActions:

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

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.

void CopyAndAppendToClipboard()

void CopyToClipboard()

void CutAndAppendToClipboard()

void CutLineToClipboard()

void CutToClipboard()

bool DeleteSelectedText(ITextChangeType type)

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

Returns

Boolean:

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

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

Boolean:

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

bool ExecuteEditAction(IEditAction action)

Parameter	Type	Description
action	IEditAction	The IEditAction to execute.

Returns

Boolean:

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

string ExportSelectedText(ITextExporter exporter)

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

Returns

String:

The exported text.

int FindCurrentWordEnd()

Returns

Int32:

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

int FindCurrentWordStart()

Returns

Int32:

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

int FindNextWordStart()

Returns

Int32:

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

int FindPreviousWordStart()

Returns

Int32:

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

bool Focus()

Returns

Boolean:

true if focus was successfully set; otherwise, false.

bool Focus(FocusState state)

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

Returns

Boolean:

true if focus was successfully set; otherwise, false.

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.

TextBounds GetCharacterBounds(int offset)

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

Returns

TextBounds:

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

TextBounds GetCharacterBounds(int offset, bool hasFarAffinity)

Parameter	Type	Description
offset	Int32	The offset whose bounds need to be retrieved.
hasFarAffinity	Boolean	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.

int GetCharacterColumn(TextPosition position)

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

Returns

Int32:

The column index within the view for the specified TextPosition.

int GetCharacterColumn(int offset)

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

Returns

Int32:

The column index within the view for the specified offset.

int GetCharacterColumn(int offset, bool hasFarAffinity)

Parameter	Type	Description
offset	Int32	The offset whose column index is being requested.
hasFarAffinity	Boolean	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

Int32:

The column index within the view for the specified offset.

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.

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

Parameter	Type	Description
positionRange	TextPositionRange	The TextPositionRange to examine.
minimumLines	Int32	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.

string GetCurrentWordText()

Returns

String:

The text of the current word.

TextRange GetCurrentWordTextRange()

Returns

TextRange:

A TextRange containing the offset range for the current word.

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.

ITextStatistics GetTextStatisticsForSelectedText()

Returns

ITextStatistics:

The ITextStatistics for the selected text in the view.

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.

string GetVirtualCharacterFillString(TextPosition position, bool returnCharacterFill)

Parameter	Type	Description
position	TextPosition	The TextPosition to be examined.
returnCharacterFill	Boolean	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 langword_csharp_String.Empty if the character is not a virtual character.

void InsertFile(string path)

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

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

Boolean:

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

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	Boolean	Whether to reselect the inner text.

Returns

Boolean:

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

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

Boolean:

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

bool IsVirtualCharacter(TextPosition position, bool lineTerminatorsAreVirtual)

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

Returns

Boolean:

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

bool IsVirtualLine(TextPosition position)

Parameter	Type	Description
position	TextPosition	The TextPosition to examine.

Returns

Boolean:

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

bool IsVirtualLine(int positionLineIndex)

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

Returns

Boolean:

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

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.

void PasteFromClipboard()

void PasteFromClipboard(IDataObject clipboardData)

Parameter	Type	Description
clipboardData	IDataObject	An IDataObject containing clipboard data.

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

Boolean:

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

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

Boolean:

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

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.

event RoutedEventHandler HasFocusChanged

Event Type

RoutedEventHandler

event RoutedEventHandler HighlightedResultSearchOptionsChanged

Event Type

RoutedEventHandler

event EventHandler<EditorViewSelectionEventArgs> SelectionChanged

Event Type

EventHandler<EditorViewSelectionEventArgs>