ITextSnapshot Interface

Provides read access to an immutable snapshot of a ITextBuffer that contains a sequence of Unicode characters.

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

Syntax

'Declaration
Public Interface ITextSnapshot
public interface ITextSnapshot
public interface class ITextSnapshot
type ITextSnapshot =  interface end
public interface ITextSnapshot

The ITextSnapshot type exposes the following members.

Properties

  Name Description
Public property ContentType Gets the IContentType of the TextBuffer when this snapshot was current.
Public property Item Gets one character at the specified position.
Public property Length Gets the number of UTF-16 characters in the snapshot.
Public property LineCount Gets the number of lines in the snapshot.
Public property Lines Gets an enumerator for the set of lines in the snapshot.
Public property TextBuffer The ITextBuffer of which this is a snapshot.
Public property Version The version of the ITextBuffer that this ITextSnapshot represents.

Top

Methods

  Name Description
Public method CopyTo Copies a range of text to a character array.
Public method CreateTrackingPoint(Int32, PointTrackingMode) Creates a ITrackingPoint in this snapshot.
Public method CreateTrackingPoint(Int32, PointTrackingMode, TrackingFidelityMode) Creates a ITrackingPoint in this snapshot.
Public method CreateTrackingSpan(Span, SpanTrackingMode) Creates a ITrackingSpan in this snapshot.
Public method CreateTrackingSpan(Int32, Int32, SpanTrackingMode) Creates a ITrackingSpan in this snapshot.
Public method CreateTrackingSpan(Span, SpanTrackingMode, TrackingFidelityMode) Creates a ITrackingSpan in this snapshot.
Public method CreateTrackingSpan(Int32, Int32, SpanTrackingMode, TrackingFidelityMode) Creates a ITrackingSpan in this snapshot.
Public method GetLineFromLineNumber Gets an ITextSnapshotLine for the given line number.
Public method GetLineFromPosition Gets an ITextSnapshotLine for a line at the given position.
Public method GetLineNumberFromPosition Gets the number of the line that contains the character at the specified position.
Public method GetText() Gets all the text in the snapshot.
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.
Public method GetText(Int32, Int32) Gets text from the snapshot starting at startIndex and having a length equal to length.
Public method ToCharArray Converts a range of text to a character array.
Public method Write(TextWriter) Writes the contents of the snapshot.
Public method Write(TextWriter, Span) Writes a substring of the contents of the snapshot.

Top

Remarks

For more information about text snapshots, see "A Closer Look at the Text Model and the Text View" in Inside the Editor.

The first character in the sequence has index zero.

See Also

Reference

Microsoft.VisualStudio.Text Namespace