In This Article

EditorViewSelectionEventArgs Class

Provides arguments for IEditorView selection change events.

public class EditorViewSelectionEventArgs : RoutedEventArgs
Inheritance:
Object EventArgs RoutedEventArgs Object

Constructors

EditorViewSelectionEventArgs(EditorViewSelectionEventArgs)

Initializes a new instance of the EditorViewSelectionEventArgs class.

public EditorViewSelectionEventArgs(EditorViewSelectionEventArgs e)
Parameter Type Description
e EditorViewSelectionEventArgs

The EditorViewSelectionEventArgs to clone.

EditorViewSelectionEventArgs(IEditorView, ITextPositionRangeCollection, EditorViewSelectionBatchOptions)

Initializes a new instance of the EditorViewSelectionEventArgs class.

public EditorViewSelectionEventArgs(IEditorView view, ITextPositionRangeCollection previousSelectionRanges, EditorViewSelectionBatchOptions options)
Parameter Type Description
view IEditorView

The IEditorView whose selection is affected by this event.

previousSelectionRanges ITextPositionRangeCollection

The collection of selection ranges prior to the selection change.

options EditorViewSelectionBatchOptions

The EditorViewSelectionBatchOptions that provides options.

Properties

CanEnsureExpanded

Gets whether a primary selection exactly over a collapsed outlining node will expand the node.

public bool CanEnsureExpanded { get; }

Property Value

Boolean:

true if a primary selection exactly over a collapsed outlining node will expand the node; otherwise, false.

CanResetSearchStartOffset

Gets whether to reset the search start offset from this selection change.

public bool CanResetSearchStartOffset { get; }

Property Value

Boolean:

true if the view should reset its search start offset for this selection change; otherwise, false.

CanScrollToCaret

Gets whether to scroll to the caret for this selection change.

public bool CanScrollToCaret { get; }

Property Value

Boolean:

true if the view should scroll to the caret for this selection change; otherwise, false.

CaretCharacterColumn

Gets the character column of the caret within the View.

public int CaretCharacterColumn { get; }

Property Value

Int32:

The character column of the caret within the View.

Remarks

This property returns the value of the CaretCharacterColumn property.

CaretDisplayCharacterColumn

Gets the character column of the caret within the View. and adds one to the value for display purposes.

public int CaretDisplayCharacterColumn { get; }

Property Value

Int32:

The character column of the caret within the View, offset by one.

Remarks

This property returns the value of the CaretDisplayCharacterColumn property.

CaretPosition

Gets the TextPosition of the caret within the View.

public TextPosition CaretPosition { get; }

Property Value

TextPosition:

The TextPosition of the caret within the View.

Remarks

This property returns the value of the CaretPosition property.

PreviousCaretPosition

Gets the TextPosition of the primary selection's caret prior to the selection change.

public TextPosition PreviousCaretPosition { get; }

Property Value

TextPosition:

The TextPosition of the primary selection's caret prior to the selection change.

PreviousSelectionRanges

Gets the collection of selection ranges prior to the selection change.

public ITextPositionRangeCollection PreviousSelectionRanges { get; }

Property Value

ITextPositionRangeCollection:

The collection of selection ranges prior to the selection change.

View

Gets the IEditorView whose selection is affected by this event.

public IEditorView View { get; }

Property Value

IEditorView:

The IEditorView whose selection is affected by this event.

Inherited Members