ITrackingSpan.GetText(ITextSnapshot) Method

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.

Maps the tracking span to a particular snapshot of its text buffer and gets the text it designates.

public:
 System::String ^ GetText(Microsoft::VisualStudio::Text::ITextSnapshot ^ snapshot);

public:
 Platform::String ^ GetText(Microsoft::VisualStudio::Text::ITextSnapshot ^ snapshot);

std::wstring GetText(Microsoft::VisualStudio::Text::ITextSnapshot const & snapshot);

public string GetText (Microsoft.VisualStudio.Text.ITextSnapshot snapshot);

abstract member GetText : Microsoft.VisualStudio.Text.ITextSnapshot -> string

Public Function GetText (snapshot As ITextSnapshot) As String

Parameters

snapshot: ITextSnapshot

The snapshot to which to map the tracking span.

Returns

String

The contents of the tracking span in the specified text snapshot.

Exceptions

ArgumentNullException

snapshot is null.

ArgumentException

snapshot is not a snapshot of TextBuffer.

Applies to