EditorViewSelectionEventArgs Class
Provides arguments for IEditorView selection change events.
public class EditorViewSelectionEventArgs : EventArgs
Constructors
EditorViewSelectionEventArgs(EditorViewSelectionEventArgs)
Initializes an instance of the class by cloning an existing instance.
public EditorViewSelectionEventArgs(EditorViewSelectionEventArgs e)
| Parameter | Type | Description |
|---|---|---|
| e | EditorViewSelectionEventArgs | The EditorViewSelectionEventArgs to clone. |
EditorViewSelectionEventArgs(IEditorView, ITextPositionRangeCollection, EditorViewSelectionBatchOptions)
Initializes an instance of the 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
Indicates whether a primary selection exactly over a collapsed outlining node will expand the node.
public bool CanEnsureExpanded { get; }
Property Value
- bool:
trueif a primary selection exactly over a collapsed outlining node will expand the node; otherwise,false.
CanResetSearchStartOffset
Indicates whether to reset the search start offset from this selection change.
public bool CanResetSearchStartOffset { get; }
Property Value
- bool:
trueif the view should reset its search start offset for this selection change; otherwise,false.
CanScrollToCaret
Indicates whether to scroll to the caret for this selection change.
public bool CanScrollToCaret { get; }
Property Value
- bool:
trueif the view should scroll to the caret for this selection change; otherwise,false.
CaretCharacterColumn
The character column of the primary selection's caret.
public int CaretCharacterColumn { get; }
Property Value
Remarks
This property returns the value of the CaretCharacterColumn property.
CaretDisplayCharacterColumn
The character column of the primary selection's caret, adding one to the value for display purposes.
public int CaretDisplayCharacterColumn { get; }
Property Value
Remarks
This property returns the value of the CaretDisplayCharacterColumn property.
CaretPosition
The TextPosition of the primary selection's caret.
public TextPosition CaretPosition { get; }
Property Value
Remarks
This property returns the value of the CaretPosition property.
PreviousCaretPosition
The TextPosition of the primary selection's caret prior to the selection change.
PreviousSelectionRanges
The collection of selection ranges prior to the selection change.
public ITextPositionRangeCollection PreviousSelectionRanges { get; }
Property Value
View
The IEditorView whose selection is affected by this event.
Inherited Members
- EventArgs.Empty
- object.GetType()
- object.MemberwiseClone()
- object.ToString()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()