VirtualSnapshotPoint Struct

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text

Assembly:: Microsoft.VisualStudio.Text.Logic.dll

Package:: Microsoft.VisualStudio.Text.Logic v17.11.260

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a SnapshotPoint that may have virtual spaces.

public value class VirtualSnapshotPoint : IComparable<Microsoft::VisualStudio::Text::VirtualSnapshotPoint>

public struct VirtualSnapshotPoint : IComparable<Microsoft.VisualStudio.Text.VirtualSnapshotPoint>

type VirtualSnapshotPoint = struct

Public Structure VirtualSnapshotPoint
Implements IComparable(Of VirtualSnapshotPoint)

Inheritance: ValueType
VirtualSnapshotPoint

Implements: IComparable<VirtualSnapshotPoint>

Remarks

Virtual spaces are "extra" spaces at the end of a line that do not add to the length of the line. You can enable or disable virtual spaces in Visual Studio. When virtual spaces are disabled, pressing on the right arrow key at the end of a line causes the caret to move to the beginning of the next line. When virtual spaces are enabled, pressing on the right arrow key at the end of a line causes the caret to move forward on the same line.

Constructors

VirtualSnapshotPoint(ITextSnapshot, Int32)	Initializes a new instance of a VirtualSnapshotPoint at `position` in a `snapshot`, with zero virtual spaces.
VirtualSnapshotPoint(ITextSnapshotLine, Int32)	Initializes a new instance of a VirtualSnapshotPoint at `offset` of `line`, placing the point in virtual space if necessary.
VirtualSnapshotPoint(SnapshotPoint, Int32)	Initializes a new instance of a VirtualSnapshotPoint at `position`, with the specified number of virtual spaces.
VirtualSnapshotPoint(SnapshotPoint)	Initializes a new instance of a VirtualSnapshotPoint at `position`, with zero virtual spaces.

Properties

IsInVirtualSpace	Determines whether the snapshot point has virtual spaces.
Position	Gets the position of the snapshot point.
VirtualSpaces	Gets the number of virtual spaces.

Methods

CompareTo(VirtualSnapshotPoint)	Compares one VirtualSnapshotPoint to another.
Equals(Object)	Determines whether two VirtualSnapshotPoint objects are the same.
GetHashCode()	Gets the hash code for the object.
ToString()	Converts the object to a string.
TranslateTo(ITextSnapshot, PointTrackingMode)	Translates this point to the `snapshot` with the given tracking mode.
TranslateTo(ITextSnapshot)	Translates this point to the `snapshot`.

Operators

Equality(VirtualSnapshotPoint, VirtualSnapshotPoint)	Determines whether two VirtualSnapshotPoint objects are the same.
GreaterThan(VirtualSnapshotPoint, VirtualSnapshotPoint)	Determines whether the position of the left point is greater than the position of the right point.
GreaterThanOrEqual(VirtualSnapshotPoint, VirtualSnapshotPoint)	Determines whether the position of the left point is greater than or equal to the position of the right point.
Inequality(VirtualSnapshotPoint, VirtualSnapshotPoint)	Determines whether two VirtualSnapshotPoint objects are different.
LessThan(VirtualSnapshotPoint, VirtualSnapshotPoint)	Determines whether the position of the left point is less than the position of the right point.
LessThanOrEqual(VirtualSnapshotPoint, VirtualSnapshotPoint)	Determines whether the position of the left point is less than or equal to the position of the right point.

Applies to

Share via