IProjectionSnapshot Interface

An immutable text snapshot that represents a state of an IProjectionBuffer.

Namespace:  Microsoft.VisualStudio.Text.Projection
Assembly:  Microsoft.VisualStudio.Text.Data (in Microsoft.VisualStudio.Text.Data.dll)

Syntax

'Declaration
Public Interface IProjectionSnapshot _
    Inherits ITextSnapshot
public interface IProjectionSnapshot : ITextSnapshot
public interface class IProjectionSnapshot : ITextSnapshot
type IProjectionSnapshot =  
    interface 
        interface ITextSnapshot 
    end
public interface IProjectionSnapshot extends ITextSnapshot

The IProjectionSnapshot type exposes the following members.

Properties

  Name Description
Public property ContentType Gets the IContentType of the TextBuffer when this snapshot was current. (Inherited from ITextSnapshot.)
Public property Item Gets one character at the specified position. (Inherited from ITextSnapshot.)
Public property Length Gets the number of UTF-16 characters in the snapshot. (Inherited from ITextSnapshot.)
Public property LineCount Gets the number of lines in the snapshot. (Inherited from ITextSnapshot.)
Public property Lines Gets an enumerator for the set of lines in the snapshot. (Inherited from ITextSnapshot.)
Public property SourceSnapshots Gets the set of one or more text snapshots that contribute source spans to this projection snapshot.
Public property SpanCount Gets the number of source spans in the projection snapshot.
Public property TextBuffer Gets the IProjectionBufferBase of which this is a snapshot.
Public property Version The version of the ITextBuffer that this ITextSnapshot represents. (Inherited from ITextSnapshot.)

Top

Methods

  Name Description
Public method CopyTo Copies a range of text to a character array. (Inherited from ITextSnapshot.)
Public method CreateTrackingPoint(Int32, PointTrackingMode) Creates a ITrackingPoint in this snapshot. (Inherited from ITextSnapshot.)
Public method CreateTrackingPoint(Int32, PointTrackingMode, TrackingFidelityMode) Creates a ITrackingPoint in this snapshot. (Inherited from ITextSnapshot.)
Public method CreateTrackingSpan(Span, SpanTrackingMode) Creates a ITrackingSpan in this snapshot. (Inherited from ITextSnapshot.)
Public method CreateTrackingSpan(Int32, Int32, SpanTrackingMode) Creates a ITrackingSpan in this snapshot. (Inherited from ITextSnapshot.)
Public method CreateTrackingSpan(Span, SpanTrackingMode, TrackingFidelityMode) Creates a ITrackingSpan in this snapshot. (Inherited from ITextSnapshot.)
Public method CreateTrackingSpan(Int32, Int32, SpanTrackingMode, TrackingFidelityMode) Creates a ITrackingSpan in this snapshot. (Inherited from ITextSnapshot.)
Public method GetLineFromLineNumber Gets an ITextSnapshotLine for the given line number. (Inherited from ITextSnapshot.)
Public method GetLineFromPosition Gets an ITextSnapshotLine for a line at the given position. (Inherited from ITextSnapshot.)
Public method GetLineNumberFromPosition Gets the number of the line that contains the character at the specified position. (Inherited from ITextSnapshot.)
Public method GetMatchingSnapshot Gets the snapshot of the specified text buffer that corresponds to this snapshot.
Public method GetSourceSpans() Gets all the source spans for the projection snapshot.
Public method GetSourceSpans(Int32, Int32) Gets a read-only collection of source snapshot spans starting at the specified location of the span.
Public method GetText() Gets all the text in the snapshot. (Inherited from ITextSnapshot.)
Public method GetText(Span) Gets text from the snapshot starting at the beginning of the span and having a length equal to the length of the span. (Inherited from ITextSnapshot.)
Public method GetText(Int32, Int32) Gets text from the snapshot starting at startIndex and having a length equal to length. (Inherited from ITextSnapshot.)
Public method MapFromSourceSnapshot(SnapshotSpan) Maps a snapshot span of a source buffer to a list of spans of the projection snapshot.
Public method MapFromSourceSnapshot(SnapshotPoint, PositionAffinity) Maps from a snapshot point in one of the source snapshots to the corresponding position in the projection snapshot.
Public method MapToSourceSnapshot(Int32) Maps a position in the projection snapshot to the corresponding position in a source snapshot.
Public method MapToSourceSnapshot(Int32, PositionAffinity) Maps a position in the projection snapshot to the corresponding position in a source snapshot.
Public method MapToSourceSnapshots(Int32) Maps a position in the projection snapshot to the corresponding position in one or more source snapshots.
Public method 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.
Public method ToCharArray Converts a range of text to a character array. (Inherited from ITextSnapshot.)
Public method Write(TextWriter) Writes the contents of the snapshot. (Inherited from ITextSnapshot.)
Public method Write(TextWriter, Span) Writes a substring of the contents of the snapshot. (Inherited from ITextSnapshot.)

Top

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.

See Also

Reference

Microsoft.VisualStudio.Text.Projection Namespace