ITextSnapshot Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text

Assembly:: Microsoft.VisualStudio.Text.Data.dll

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.

Provides read access to an immutable snapshot of a ITextBuffer containing a sequence of Unicode characters. The first character in the sequence has index zero.

public interface class ITextSnapshot

public interface class ITextSnapshot

__interface ITextSnapshot

public interface ITextSnapshot

type ITextSnapshot = interface

Public Interface ITextSnapshot

Derived: Microsoft.VisualStudio.Text.ITextSnapshot2

Microsoft.VisualStudio.Text.Projection.IElisionSnapshot

Microsoft.VisualStudio.Text.Projection.IProjectionSnapshot

Microsoft.VisualStudio.Text.Projection.IProjectionSnapshot2

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.

Properties

ContentType	The IContentType of the TextBuffer when this snapshot was current.
Item[Int32]	Gets a single character at the specified position.
Length	Gets the number of UTF-16 characters contained in the snapshot.
LineCount	Gets the positive number of lines in the snapshot. A snapshot whose Length is zero is considered to have one line.
Lines	An enumerator for the set of lines in the snapshot.
TextBuffer	The ITextBuffer of which this is a snapshot.
Version	The version of the ITextBuffer that this ITextSnapshot represents.

Methods

CopyTo(Int32, Char[], Int32, Int32)	Copies a range of text to a character array.
CreateTrackingPoint(Int32, PointTrackingMode)	Creates a ITrackingPoint against this snapshot.
CreateTrackingPoint(Int32, PointTrackingMode, TrackingFidelityMode)	Creates a ITrackingPoint against this snapshot.
CreateTrackingSpan(Int32, Int32, SpanTrackingMode)	Creates a ITrackingSpan against this snapshot.
CreateTrackingSpan(Int32, Int32, SpanTrackingMode, TrackingFidelityMode)	Creates a ITrackingSpan against this snapshot.
CreateTrackingSpan(Span, SpanTrackingMode)	Creates a ITrackingSpan against this snapshot.
CreateTrackingSpan(Span, SpanTrackingMode, TrackingFidelityMode)	Creates a ITrackingSpan against this snapshot.
GetLineFromLineNumber(Int32)	Gets an ITextSnapshotLine for the given line number.
GetLineFromPosition(Int32)	Gets an ITextSnapshotLine for a line at the given position.
GetLineNumberFromPosition(Int32)	Gets the number of the line that contains the character at the specified position.
GetText()	Gets all the text in the snapshot.
GetText(Int32, Int32)	Gets text from the snapshot starting at `startIndex` and having length equal to `length`.
GetText(Span)	Gets text from the snapshot starting at the beginning of the span and having length equal to the length of the span.
ToCharArray(Int32, Int32)	Converts a range of text to a character array.
Write(TextWriter)	Writes the contents of the snapshot.
Write(TextWriter, Span)	Writes a substring of the contents of the snapshot.

Applies to