Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

IEditorView Interface

Namespace:
ActiproSoftware.UI.WinForms.Controls.SyntaxEditor
Assembly:
ActiproSoftware.SyntaxEditor.WinForms.dll

Provides the base requirements for a text view that supports editing and is presented in a SyntaxEditor.

public interface IEditorView : ITextView

Properties

ContainsFocus

Indicates whether the view currently has or contains keyboard focus.

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.

CurrentSnapshotLine

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

ITextSnapshotLine CurrentSnapshotLine { get; }

Property Value

ITextSnapshotLine

CurrentViewLine

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

ITextViewLine CurrentViewLine { get; }

Property Value

ITextViewLine

HasFocus

Indicates whether the view currently has keyboard focus.

bool HasFocus { get; }

Property Value

bool:

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

HighlightedResultSearchOptions

The ISearchOptions to use for searching when highlighting search results.

ISearchOptions? HighlightedResultSearchOptions { get; set; }

Property Value

ISearchOptions

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.

IntelliPrompt

The IEditorViewIntelliPrompt to use for requesting IntelliPrompt within the view.

IEditorViewIntelliPrompt IntelliPrompt { get; }

Property Value

IEditorViewIntelliPrompt

IsActive

Indicates whether the view is the currently-active view in the editor.

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

IsIncrementalSearchActive

Indicates whether incremental searching is active.

bool IsIncrementalSearchActive { get; set; }

Property Value

bool:

true if incremental searching is active; otherwise, false.

Margins

The collection of margins that are currently in the view.

IEditorViewMarginCollection Margins { get; }

Property Value

IEditorViewMarginCollection

OverlayPanes

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

IEditorViewOverlayPaneCollection OverlayPanes { get; }

Property Value

IEditorViewOverlayPaneCollection

Placement

An EditorViewPlacement indicating the location of the view.

EditorViewPlacement Placement { get; }

Property Value

EditorViewPlacement

PositionFinder

The ITextPositionFinder that can be used to find TextPosition objects relative to another specified TextPosition.

ITextPositionFinder PositionFinder { get; }

Property Value

ITextPositionFinder

Scroller

The IEditorViewScroller to use for scrolling the view.

IEditorViewScroller Scroller { get; }

Property Value

IEditorViewScroller

Searcher

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

IEditorViewSearcher Searcher { get; }

Property Value

IEditorViewSearcher

SelectedText

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

string SelectedText { get; set; }

Property Value

string

Selection

An IEditorViewSelection that manages the selection within the view.

IEditorViewSelection Selection { get; }

Property Value

IEditorViewSelection

TextChangeActions

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

IEditorViewTextChangeActions TextChangeActions { get; }

Property Value

IEditorViewTextChangeActions

Methods

Activate()

Activates this 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.

CopyAndAppendToClipboard()

Copies the currently selected text and appends it to the existing text on the clipboard.

void CopyAndAppendToClipboard()

CopyToClipboard()

Copies the currently selected text to the clipboard.

void CopyToClipboard()

CutAndAppendToClipboard()

Cuts the currently selected text and appends it to the existing text on the clipboard.

void CutAndAppendToClipboard()

CutLineToClipboard()

Cuts the currently active view line to the clipboard.

void CutLineToClipboard()

CutToClipboard()

Cuts the currently selected text to the clipboard.

void CutToClipboard()

DeleteSelectedText(ITextChangeType, IEditorViewTextChangeOptions?)

Performs a delete text change by deleting the view's selected text ranges.

bool DeleteSelectedText(ITextChangeType type, IEditorViewTextChangeOptions? options = null)
Parameter Type Description
type ITextChangeType

An ITextChangeType specifying the type of change.
options IEditorViewTextChangeOptions

The optional IEditorViewTextChangeOptions for the change.

Returns

bool:

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

ExecuteEditAction(IEditAction)

Executes the specified IEditAction within the view and records the action within a macro when appropriate.

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.

ExportSelectedText(ITextExporter)

Exports the selected text to another text format, such as HTML or RTF.

string ExportSelectedText(ITextExporter exporter)
Parameter Type Description
exporter ITextExporter

The ITextExporter to use for the export operation.

Returns

string:

The exported text.

FindCurrentWordEnd()

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

int FindCurrentWordEnd()

Returns

int

FindCurrentWordStart()

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

int FindCurrentWordStart()

Returns

int

FindNextWordStart()

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

int FindNextWordStart()

Returns

int

FindPreviousWordStart()

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

int FindPreviousWordStart()

Returns

int

Focus()

Ensures the view has focus.

bool Focus()

Returns

bool:

true if focus was successfully set; otherwise, false.

Focus(FocusState)

Ensures the view has focus.

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; otherwise, false.

GetCharacterBounds(TextPosition)

Returns the TextBounds for the specified TextPosition, relative to the text area's coordinates, if any.

TextBounds? GetCharacterBounds(TextPosition position)
Parameter Type Description
position TextPosition

The TextPosition whose bounds need to be retrieved.

Returns

TextBounds?

GetCharacterBounds(int, bool)

Returns the TextBounds for the specified offset, relative to the text area's coordinates, if any.

TextBounds? GetCharacterBounds(int offset, bool hasFarAffinity = false)
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. The default value is false.

Returns

TextBounds?

GetCharacterColumn(TextPosition)

Returns the column index within the view for the specified TextPosition or 0 if the position is out of range.

int GetCharacterColumn(TextPosition position)
Parameter Type Description
position TextPosition

The TextPosition whose column index is being requested.

Returns

int

GetCharacterColumn(int, bool)

Returns the column index within the view for the specified offset or 0 if the offset is out of range.

int GetCharacterColumn(int offset, bool hasFarAffinity = false)
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. The default value is false.

Returns

int

GetCharacterIndexRanges(TextPositionRange, int)

Returns 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 = 1)
Parameter Type Description
positionRange TextPositionRange

The TextPositionRange to examine.
minimumLines int

The optional minimum number of lines to return, used for block selections. For continuous stream selections, pass 1, which is the default.

Returns

IList<Range>

GetCurrentWordText()

Returns the text of the current word.

string GetCurrentWordText()

Returns

string

GetCurrentWordTextRange()

Returns the TextRange for the current word.

TextRange GetCurrentWordTextRange()

Returns

TextRange

GetReader()

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

ITextSnapshotReader GetReader()

Returns

ITextSnapshotReader

GetTextStatisticsForSelectedText()

Returns the ITextStatistics for the selected text in the view, which provides numerous statistics about the text such as word, sentence, character counts as well as readability scores.

ITextStatistics GetTextStatisticsForSelectedText()

Returns

ITextStatistics

GetViewLine(double, LocationToPositionAlgorithm)

Returns the ITextViewLine that contains the specified Y location, if any.

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

GetVirtualCharacterFillString(TextPosition, bool)

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

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

Remarks

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

InsertFile(string)

Inserts the text contents of the specified file into the view, replacing any selected text.

void InsertFile(string path)
Parameter Type Description
path string

The fully qualified path to the file that will be inserted.

InsertSurroundingText(ITextChangeType, string?, string, bool)

Inserts text into the document that surrounds the currently selected text ranges in the view.

bool InsertSurroundingText(ITextChangeType type, string? preText, string postText, bool reselect = false)
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.

InsertSurroundingText(string?, string)

Inserts text into the document that surrounds the currently selected text ranges in the view, using a TextChangeTypes.TextReplacement change type.

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.

IsVirtualCharacter(TextPosition, bool)

Returns whether the specified TextPosition is a virtual character (beyond line or document end).

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.

IsVirtualLine(TextPosition)

Returns whether the specified TextPosition is a virtual line (beyond document end).

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.

IsVirtualLine(int)

Returns whether the specified TextPosition line index is a virtual line (beyond document end).

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.

LocationToPosition(Point, LocationToPositionAlgorithm)

Returns the TextPosition for the specified location.

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?

Remarks

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

PasteFromClipboard()

Pastes text from the clipboard into the selection.

void PasteFromClipboard()

ReplaceSelectedText(ITextChangeType, string?, IEditorViewTextChangeOptions?)

Performs a replace text change by overwriting the view's selected text ranges.

bool ReplaceSelectedText(ITextChangeType type, string? text, IEditorViewTextChangeOptions? options = null)
Parameter Type Description
type ITextChangeType

An ITextChangeType specifying the type of change.
text string

The text to insert.
options IEditorViewTextChangeOptions

The optional IEditorViewTextChangeOptions for the change.

Returns

bool:

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

StartPointerSelection(InputPointerButtonEventArgs)

Starts a pointer selection operation during a pointer button down event.

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.

Events

HasFocusChanged

Occurs when the HasFocus property value is changed.

event EventHandler HasFocusChanged

Event Type

EventHandler

HighlightedResultSearchOptionsChanged

Occurs when the HighlightedResultSearchOptions property value is changed.

event EventHandler HighlightedResultSearchOptionsChanged

Event Type

EventHandler

SelectionChanged

Occurs after the selection is changed.

event EventHandler<EditorViewSelectionEventArgs> SelectionChanged

Event Type

EventHandler<EditorViewSelectionEventArgs>

Inherited Members

Extension Methods