IProjectionSnapshot Interface

Definition

Namespace:

Microsoft.VisualStudio.Text.Projection

Assembly:

Microsoft.VisualStudio.Text.Data.dll

Package:

Microsoft.VisualStudio.Text.Data v17.11.260

An immutable text snapshot that represents a state of an IProjectionBuffer. This snapshot contains projections of other text snapshots, described by a list of tracking spans from those buffers. Every modification of a projection buffer or one of its source buffers generates a new projection snapshot.

public interface class IProjectionSnapshot : Microsoft::VisualStudio::Text::ITextSnapshot

public interface class IProjectionSnapshot : Microsoft::VisualStudio::Text::ITextSnapshot

__interface IProjectionSnapshot : Microsoft::VisualStudio::Text::ITextSnapshot

public interface IProjectionSnapshot : Microsoft.VisualStudio.Text.ITextSnapshot

type IProjectionSnapshot = interface
    interface ITextSnapshot

Public Interface IProjectionSnapshot
Implements ITextSnapshot

Derived

Microsoft.VisualStudio.Text.Projection.IElisionSnapshot

Microsoft.VisualStudio.Text.Projection.IProjectionSnapshot2

Implements

ITextSnapshot

Remarks

This snapshot contains projections of other text snapshots, described by a list of tracking spans from those buffers. Every modification of a projection buffer or one of its source buffers generates a new projection snapshot.

Properties

ContentType	The IContentType of the TextBuffer when this snapshot was current. (Inherited from ITextSnapshot)
Item[Int32]	Gets a single character at the specified position. (Inherited from ITextSnapshot)
Length	Gets the number of UTF-16 characters contained in the snapshot. (Inherited from ITextSnapshot)
LineCount	Gets the positive number of lines in the snapshot. A snapshot whose Length is zero is considered to have one line. (Inherited from ITextSnapshot)
Lines	An enumerator for the set of lines in the snapshot. (Inherited from ITextSnapshot)
SourceSnapshots	Gets the set of one or more text snapshots that contribute source spans to this projection snapshot. The ordering of the list is arbitrary. It does not contain duplicates.
SpanCount	Gets the number of source spans in the projection snapshot.
TextBuffer	Gets the IProjectionBufferBase of which this is a snapshot.
Version	The version of the ITextBuffer that this ITextSnapshot represents. (Inherited from ITextSnapshot)

Methods

CopyTo(Int32, Char[], Int32, Int32)	Copies a range of text to a character array. (Inherited from ITextSnapshot)
CreateTrackingPoint(Int32, PointTrackingMode, TrackingFidelityMode)	Creates a ITrackingPoint against this snapshot. (Inherited from ITextSnapshot)
CreateTrackingPoint(Int32, PointTrackingMode)	Creates a ITrackingPoint against this snapshot. (Inherited from ITextSnapshot)
CreateTrackingSpan(Int32, Int32, SpanTrackingMode, TrackingFidelityMode)	Creates a ITrackingSpan against this snapshot. (Inherited from ITextSnapshot)
CreateTrackingSpan(Int32, Int32, SpanTrackingMode)	Creates a ITrackingSpan against this snapshot. (Inherited from ITextSnapshot)
CreateTrackingSpan(Span, SpanTrackingMode, TrackingFidelityMode)	Creates a ITrackingSpan against this snapshot. (Inherited from ITextSnapshot)
CreateTrackingSpan(Span, SpanTrackingMode)	Creates a ITrackingSpan against this snapshot. (Inherited from ITextSnapshot)
GetLineFromLineNumber(Int32)	Gets an ITextSnapshotLine for the given line number. (Inherited from ITextSnapshot)
GetLineFromPosition(Int32)	Gets an ITextSnapshotLine for a line at the given position. (Inherited from ITextSnapshot)
GetLineNumberFromPosition(Int32)	Gets the number of the line that contains the character at the specified position. (Inherited from ITextSnapshot)
GetMatchingSnapshot(ITextBuffer)	Gets the snapshot of the specified text buffer that corresponds to this snapshot.
GetSourceSpans()	Gets all the source spans for the projection snapshot.
GetSourceSpans(Int32, Int32)	Gets a read-only collection of source snapshot spans starting at the specified span index. The startSpanIndex is an index into the collection of source spans, not into the characters in the text buffer.
GetText()	Gets all the text in the snapshot. (Inherited from ITextSnapshot)
GetText(Int32, Int32)	Gets text from the snapshot starting at startIndex and having length equal to length. (Inherited from ITextSnapshot)
GetText(Span)	Gets text from the snapshot starting at the beginning of the span and having length equal to the length of the span. (Inherited from ITextSnapshot)
MapFromSourceSnapshot(SnapshotPoint, PositionAffinity)	Maps from a snapshot point in one of the source snapshots to the corresponding position in the projection snapshot.
MapFromSourceSnapshot(SnapshotSpan)	Maps a snapshot span of a source buffer to a list of spans of the projection snapshot. The resulting ordered list may be empty, contain a single element, or contain multiple elements.
MapToSourceSnapshot(Int32, PositionAffinity)	Maps a position in the projection snapshot to the corresponding position in a source snapshot.
MapToSourceSnapshot(Int32)	Maps a position in the projection snapshot to the corresponding position in a source snapshot. If the mapping is ambiguous (occurs on a source span seam), see GetTypicalInsertionPosition(SnapshotPoint, ReadOnlyCollection<SnapshotPoint>) to choose a source buffer.
MapToSourceSnapshots(Int32)	Maps a position in the projection snapshot to the corresponding position in one or more source snapshots.
MapToSourceSnapshots(Span)	Maps a span of the current projection snapshot to a list of snapshot spans belonging to source snapshots. The resulting spans will be ordered by the order of their appearance in the projection.
ToCharArray(Int32, Int32)	Converts a range of text to a character array. (Inherited from ITextSnapshot)
Write(TextWriter, Span)	Writes a substring of the contents of the snapshot. (Inherited from ITextSnapshot)
Write(TextWriter)	Writes the contents of the snapshot. (Inherited from ITextSnapshot)