ITagger<T>::GetTags Method (NormalizedSnapshotSpanCollection^)

Visual Studio 2015

Gets all the tags that intersect the specified spans.

Namespace: Microsoft.VisualStudio.Text.Tagging
Assembly: Microsoft.VisualStudio.Text.Logic (in Microsoft.VisualStudio.Text.Logic.dll)

Syntax

C++

IEnumerable<ITagSpan<T>^>^ GetTags(
	NormalizedSnapshotSpanCollection^ spans
)

Parameters

spans: Type: Microsoft.VisualStudio.Text::NormalizedSnapshotSpanCollection^
The spans to visit.

Return Value

Type: System.Collections.Generic::IEnumerable<ITagSpan<T>^>^

A TagSpan<T> for each tag.

Remarks

Two spans intersect if they have positions in common, or if the end of one span coincides with the start of the other span, and neither is empty.

Taggers are not required to return their tags in any specific order. The recommended way to implement this method is by using generators (yield return), which allows lazy evaluation of the entire tagging stack.

Examples

For an example of how to implement this method, see Walkthrough: Highlighting Text.