IAccurateTagAggregator<T>.GetAllTags Method

Definition

Namespace:

Microsoft.VisualStudio.Text.Tagging

Assembly:

Microsoft.VisualStudio.Text.Logic.dll

Package:

Microsoft.VisualStudio.Text.Logic v17.9.187

Overloads

GetAllTags(IMappingSpan, CancellationToken)	Gets all the tags that intersect the specified span of the type of the aggregator.
GetAllTags(NormalizedSnapshotSpanCollection, CancellationToken)	Gets all the tags that intersect the specified snapshotSpans of the type of the aggregator.
GetAllTags(SnapshotSpan, CancellationToken)	Gets all the tags that intersect the specified span of the same type as the aggregator.

GetAllTags(IMappingSpan, CancellationToken)

Gets all the tags that intersect the specified span of the type of the aggregator.

public:
 System::Collections::Generic::IEnumerable<Microsoft::VisualStudio::Text::Tagging::IMappingTagSpan<T> ^> ^ GetAllTags(Microsoft::VisualStudio::Text::IMappingSpan ^ span, System::Threading::CancellationToken cancel);

public System.Collections.Generic.IEnumerable<Microsoft.VisualStudio.Text.Tagging.IMappingTagSpan<out T>> GetAllTags (Microsoft.VisualStudio.Text.IMappingSpan span, System.Threading.CancellationToken cancel);

abstract member GetAllTags : Microsoft.VisualStudio.Text.IMappingSpan * System.Threading.CancellationToken -> seq<Microsoft.VisualStudio.Text.Tagging.IMappingTagSpan<'T>>

Public Function GetAllTags (span As IMappingSpan, cancel As CancellationToken) As IEnumerable(Of IMappingTagSpan(Of Out T))

Parameters

span

IMappingSpan

The span to search.

cancel

CancellationToken

Cancellation token

Returns

IEnumerable<IMappingTagSpan<T>>

All the tags that intersect the region.

Remarks

This method is used when final results are needed (when, for example, when doing color printing) and is expected to return final results (however long it takes to compute) instead of quick but tentative results.

The default tag aggregator lazily enumerates the tags of its ITagger<T> objects. Because of this, the ordering of the returned mapping spans cannot be predicted. If you need an ordered set of spans, you should collect the returned tag spans, after being mapped to the buffer of interest, into a sortable collection.

If the underlying tagger does not support IAccurateTagger<T>, then ITagger<T>.GetTags(...) is used instead.

GetAllTags(NormalizedSnapshotSpanCollection, CancellationToken)

Gets all the tags that intersect the specified snapshotSpans of the type of the aggregator.

public:
 System::Collections::Generic::IEnumerable<Microsoft::VisualStudio::Text::Tagging::IMappingTagSpan<T> ^> ^ GetAllTags(Microsoft::VisualStudio::Text::NormalizedSnapshotSpanCollection ^ snapshotSpans, System::Threading::CancellationToken cancel);

public System.Collections.Generic.IEnumerable<Microsoft.VisualStudio.Text.Tagging.IMappingTagSpan<out T>> GetAllTags (Microsoft.VisualStudio.Text.NormalizedSnapshotSpanCollection snapshotSpans, System.Threading.CancellationToken cancel);

abstract member GetAllTags : Microsoft.VisualStudio.Text.NormalizedSnapshotSpanCollection * System.Threading.CancellationToken -> seq<Microsoft.VisualStudio.Text.Tagging.IMappingTagSpan<'T>>

Public Function GetAllTags (snapshotSpans As NormalizedSnapshotSpanCollection, cancel As CancellationToken) As IEnumerable(Of IMappingTagSpan(Of Out T))

Parameters

snapshotSpans

NormalizedSnapshotSpanCollection

The spans to search.

cancel

CancellationToken

Cancellation token

Returns

IEnumerable<IMappingTagSpan<T>>

All the tags that intersect the region.

Remarks

This method is used when final results are needed (when, for example, when doing color printing) and is expected to return final results (however long it takes to compute) instead of quick but tentative results.

The default tag aggregator lazily enumerates the tags of its ITagger<T> objects. Because of this, the ordering of the returned mapping spans cannot be predicted. If you need an ordered set of spans, you should collect the returned tag spans, after being mapped to the buffer of interest, into a sortable collection.

If the underlying tagger does not support IAccurateTagger<T>, then ITagger<T>.GetTags(...) is used instead.

GetAllTags(SnapshotSpan, CancellationToken)

Gets all the tags that intersect the specified span of the same type as the aggregator.

public:
 System::Collections::Generic::IEnumerable<Microsoft::VisualStudio::Text::Tagging::IMappingTagSpan<T> ^> ^ GetAllTags(Microsoft::VisualStudio::Text::SnapshotSpan span, System::Threading::CancellationToken cancel);

public System.Collections.Generic.IEnumerable<Microsoft.VisualStudio.Text.Tagging.IMappingTagSpan<out T>> GetAllTags (Microsoft.VisualStudio.Text.SnapshotSpan span, System.Threading.CancellationToken cancel);

abstract member GetAllTags : Microsoft.VisualStudio.Text.SnapshotSpan * System.Threading.CancellationToken -> seq<Microsoft.VisualStudio.Text.Tagging.IMappingTagSpan<'T>>

Public Function GetAllTags (span As SnapshotSpan, cancel As CancellationToken) As IEnumerable(Of IMappingTagSpan(Of Out T))

Parameters

span

SnapshotSpan

The span to search.

cancel

CancellationToken

Cancellation token

Returns

IEnumerable<IMappingTagSpan<T>>

All the tags that intersect the region.

Remarks

This method is used when final results are needed (when, for example, when doing color printing) and is expected to return final results (however long it takes to compute) instead of quick but tentative results.

The default tag aggregator lazily enumerates the tags of its ITagger<T> objects. Because of this, the ordering of the returned mapping spans cannot be predicted. If you need an ordered set of spans, you should collect the returned tag spans, after being mapped to the buffer of interest, into a sortable collection.

If the underlying tagger does not support IAccurateTagger<T>, then ITagger<T>.GetTags(...) is used instead.