IEditorViewSelection Interface

public interface IEditorViewSelection

int CaretCharacterColumn { get; }

Property Value

int:

The character column of the primary selection's caret.

Remarks

This property is the same as calling the GetCharacterColumn(int, bool) method using the value of the EndPosition property.

int CaretDisplayCharacterColumn { get; }

Property Value

int:

The CaretCharacterColumn property value, offset by one.

int CaretOffset { get; set; }

Property Value

int:

The offset of the primary selection's caret.

Remarks

This property is the same as getting the EndOffset property and setting the StartOffset property.

TextPosition CaretPosition { get; set; }

Property Value

TextPosition:

The TextPosition of the primary selection's caret.

Remarks

This property is the same as getting the EndPosition property and setting the StartPosition property.

int EndOffset { get; set; }

Property Value

int:

The end offset of the primary selection range.

Remarks

The end offset may occur before the start offset if the selection range is not normalized. The IsNormalized property indicates if the selection range is normalized. To get the normalized first offset in the selection range, use the FirstOffset property. To get the normalized last offset in the selection range, use the LastOffset property.

TextPosition EndPosition { get; set; }

Property Value

TextPosition:

The TextPosition that represents the end of the primary selection range.

Remarks

This property's value comes from the end TextPosition of the PositionRange property. The EndPosition may occur before the StartPosition if the selection range is not normalized. The IsNormalized property indicates if the selection range is normalized. To get the normalized first TextPosition in the selection range, use the FirstPosition property. To get the normalized last TextPosition in the selection range, use the LastPosition property.

TextSnapshotOffset EndSnapshotOffset { get; }

Property Value

TextSnapshotOffset:

The TextSnapshotOffset that specifies the end offset of the primary selection range.

Remarks

The start offset may occur after the end offset if the selection range is not normalized. The IsNormalized property indicates if the selection range is normalized.

int FirstOffset { get; }

Property Value

int:

The first offset in the primary selection range.

Remarks

This property returns either the StartOffset or EndOffset property, whichever comes first.

TextPosition FirstPosition { get; }

Property Value

TextPosition:

The first TextPosition in the primary selection range.

Remarks

This property returns either the StartPosition or EndPosition property, whichever comes first.

bool IsNormalized { get; }

Property Value

bool:

true if the primary selection range is normalized; otherwise, false.

bool IsReadOnly { get; }

Property Value

bool:

true if any character in the selection ranges are flagged as read-only; otherwise, false.

bool IsZeroLength { get; }

Property Value

bool:

true if the primary selection range has a zero length; otherwise, false.

int LastOffset { get; }

Property Value

int:

The last offset in the primary selection range.

Remarks

This property returns either the StartOffset or EndOffset property, whichever comes last.

TextPosition LastPosition { get; }

Property Value

TextPosition:

The last TextPosition in the primary selection range.

Remarks

This property returns either the StartPosition or EndPosition property, whichever comes last.

int Length { get; }

Property Value

int:

The absolute offset length of the primary selection range.

Remarks

This value is always positive.

SelectionModes Mode { get; }

Property Value

SelectionModes:

A SelectionModes that indicates the selection mode currently in use.

TextPositionRange PositionRange { get; set; }

Property Value

TextPositionRange:

The TextPositionRange that describes the start and end TextPosition of the primary selection.

ITextPositionRangeCollection Ranges { get; }

Property Value

ITextPositionRangeCollection:

The collection of selection ranges in the view.

Remarks

This collection ordinarily contains a single range, but can have more than one range when there are multiple selections. Each selection range has its own caret at the selection range's end position.

TextSnapshotRange SnapshotRange { get; }

Property Value

TextSnapshotRange:

The TextSnapshotRange that specifies the offset range of the primary selection.

int StartOffset { get; set; }

Property Value

int:

The start offset of the primary selection range.

Remarks

The start offset may occur after the end offset if the selection range is not normalized. The IsNormalized property indicates if the selection range is normalized. To get the normalized first offset in the selection range, use the FirstOffset property. To get the normalized last offset in the selection range, use the LastOffset property.

TextPosition StartPosition { get; set; }

Property Value

TextPosition:

The TextPosition that represents the start of the primary selection range.

Remarks

This property's value comes from the start TextPosition of the PositionRange property. The StartPosition may occur after the EndPosition if the selection range is not normalized. The IsNormalized property indicates if the selection range is normalized. To get the normalized first TextPosition in the selection range, use the FirstPosition property. To get the normalized last TextPosition in the selection range, use the LastPosition property.

TextSnapshotOffset StartSnapshotOffset { get; }

Property Value

TextSnapshotOffset:

The TextSnapshotOffset that specifies the start offset of the primary selection range.

Remarks

The start offset may occur after the end offset if the selection range is not normalized. The IsNormalized property indicates if the selection range is normalized.

TextRange TextRange { get; set; }

Property Value

TextRange:

The TextRange that specifies the offset range of the primary selection.

void AddNextOccurrence()

void AddRange(TextPositionRange positionRange)

Parameter	Type	Description
positionRange	TextPositionRange	The TextPositionRange containing the range of characters to select.

Remarks

This method results in multiple selection ranges and related carets.

IEditorViewSelectionState CaptureState()

Returns

IEditorViewSelectionState:

An IEditorViewSelectionState that represents the current selection state.

Remarks

When capturing the selection state, the future restoration should be performed immediately after any programmatic text changes that are made following the capture.

IEditorViewSelectionState CaptureState(TextRangeTrackingModes trackingModes)

Parameter	Type	Description
trackingModes	TextRangeTrackingModes	The TextRangeTrackingModes to use for translating between snapshots.

Returns

IEditorViewSelectionState:

An IEditorViewSelectionState that represents the current selection state.

Remarks

When capturing the selection state, the future restoration should be performed immediately after any programmatic text changes that are made following the capture.

bool CodeBlockContract()

Returns

bool:

true of selection was contracted; otherwise, false.

Remarks

This method iterates backward through the selection history produced by calls to CodeBlockExpand(). The code block selection history resets after any other selection or text changes.

bool CodeBlockExpand()

Returns

bool:

true of selection was expanded; otherwise, false.

Remarks

Syntax languages can implement an ICodeBlockFinder service to support this feature.

void Collapse()

void CollapseLeft()

void CollapseRight()

bool Contains(TextPosition position)

Parameter	Type	Description
position	TextPosition	The TextPosition to check.

Returns

bool:

true if a selection range contains the specified TextPosition; otherwise false.

bool Contains(int offset)

Parameter	Type	Description
offset	int	The offset to check.

Returns

bool:

true if a selection range contains the specified offset; otherwise false.

IDisposable CreateBatch(EditorViewSelectionBatchOptions options)

Parameter	Type	Description
options	EditorViewSelectionBatchOptions	An EditorViewSelectionBatchOptions that indicates batch options.

Returns

IDisposable:

An IDisposable object. Once disposed, the batch is ended.

IList<double> GetPreferredCaretHorizontalLocations()

Returns

IList<double>:

The collection of preferred caret horizontal locations.

Remarks

The returned collection will have the same number of items as the Ranges collection.

IList<TextRange> GetTextRanges()

Returns

IList<TextRange>:

The collection of TextRange objects that specify the ranges of text that is selected.

Remarks

Normally a single TextRange is returned. However in the case of a block selection or multiple selection ranges, more than one TextRange can be returned.

IList<TextRange> GetTextRanges(int minimumLines)

Parameter	Type	Description
minimumLines	int	The minimum number of lines to return when the selection is a block selection.

Returns

IList<TextRange>:

The collection of TextRange objects that specify the ranges of text that is selected.

Remarks

Normally a single TextRange is returned. However in the case of a block selection or multiple selection ranges, more than one TextRange can be returned.

void MoveDown()

void MoveLeft()

void MovePageDown()

void MovePageUp()

void MoveRight()

void MoveToDocumentEnd()

void MoveToDocumentStart()

void MoveToLineEnd()

void MoveToLineStart()

void MoveToLineStartAfterIndentation()

void MoveToMatchingBracket()

void MoveToNextLineStartAfterIndentation()

void MoveToNextWord()

void MoveToPreviousLineStartAfterIndentation()

void MoveToPreviousWord()

void MoveToVisibleBottom()

void MoveToVisibleTop()

void MoveUp()

void SelectAll()

void SelectBlockDown()

void SelectBlockLeft()

void SelectBlockRight()

void SelectBlockToNextWord()

void SelectBlockToPreviousWord()

void SelectBlockUp()

void SelectDown()

void SelectLeft()

void SelectPageDown()

void SelectPageUp()

void SelectRange(TextPosition startPosition, TextPosition endPosition)

Parameter	Type	Description
startPosition	TextPosition	The TextPosition at which to start the selection.
endPosition	TextPosition	The TextPosition at which to end the selection.

void SelectRange(TextPosition startPosition, TextPosition endPosition, SelectionModes mode)

Parameter	Type	Description
startPosition	TextPosition	The TextPosition at which to start the selection.
endPosition	TextPosition	The TextPosition at which to end the selection.
mode	SelectionModes	The SelectionModes to use. This value must be either SelectionModes.ContinuousStream or SelectionModes.Block.

void SelectRange(TextPositionRange positionRange)

Parameter	Type	Description
positionRange	TextPositionRange	The TextPositionRange containing the range of characters to select.

void SelectRange(TextPositionRange positionRange, SelectionModes mode)

Parameter	Type	Description
positionRange	TextPositionRange	The TextPositionRange containing the range of characters to select.
mode	SelectionModes	The SelectionModes to use. This value must be either SelectionModes.ContinuousStream or SelectionModes.Block.

void SelectRange(TextRange textRange)

Parameter	Type	Description
textRange	TextRange	The TextRange containing the range of characters to select.

void SelectRange(TextRange textRange, SelectionModes mode)

Parameter	Type	Description
textRange	TextRange	The TextRange containing the range of characters to select.
mode	SelectionModes	The SelectionModes to use. This value must be either SelectionModes.ContinuousStream or SelectionModes.Block.

void SelectRange(int offset, int length)

Parameter	Type	Description
offset	int	The offset at which to start the selection.
length	int	The number of characters to select.

void SelectRange(int offset, int length, SelectionModes mode)

Parameter	Type	Description
offset	int	The offset at which to start the selection.
length	int	The number of characters to select.
mode	SelectionModes	The SelectionModes to use. This value must be either SelectionModes.ContinuousStream or SelectionModes.Block.

void SelectRanges(IEnumerable<TextPositionRange> positionRanges)

Parameter	Type	Description
positionRanges	IEnumerable<TextPositionRange>	The collection of TextPositionRange objects containing the ranges of characters to select.

Remarks

This method will switch the Mode to ContinuousStream.

void SelectRanges(IEnumerable<TextPositionRange> positionRanges, int? primaryIndex)

Parameter	Type	Description
positionRanges	IEnumerable<TextPositionRange>	The collection of TextPositionRange objects containing the ranges of characters to select.
primaryIndex	int?	The positionRanges item index to make the new primary selection range.

Remarks

This method will switch the Mode to ContinuousStream.

void SelectRight()

void SelectToDocumentEnd()

void SelectToDocumentStart()

void SelectToLineEnd()

void SelectToLineStart()

void SelectToLineStartAfterIndentation()

void SelectToMatchingBracket()

void SelectToNextWord()

void SelectToPreviousWord()

void SelectToVisibleBottom()

void SelectToVisibleTop()

void SelectUp()

void SelectWord()

bool ToggleRange(TextPositionRange positionRange)

Parameter	Type	Description
positionRange	TextPositionRange	The TextPositionRange containing the range of characters to select.

Returns

bool:

true if a selection range was added/merged; otherwise, false.

Remarks

This method can result in multiple selection ranges and related carets. If the specified selection range exactly matches an existing selection range, the existing selection range will be removed. Otherwise, any existing selection ranges that intersect will be removed, and the specified selection range will be added.