ITagAggregator<T> Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Tagging

Assembly:: Microsoft.VisualStudio.Text.Logic.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.

Aggregates all the tag providers in a buffer graph for the specified type of tag.

generic <typename T>
 where T : ITagpublic interface class ITagAggregator : IDisposable

public interface ITagAggregator<out T> : IDisposable where T : ITag

type ITagAggregator<'T (requires 'T :> ITag)> = interface
    interface IDisposable

Public Interface ITagAggregator(Of Out T)
Implements IDisposable

Type Parameters

T

The type of tag returned by the aggregator.

This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics.

Derived: Microsoft.VisualStudio.Text.Tagging.IAccurateTagAggregator<T>

Implements: IDisposable

Remarks

The default tag aggregator implementation also does the following: for each ITagger<T> over which it aggregates tags, if the tagger is IDisposable, call Dispose() on it when the aggregator is disposed or when the taggers are dropped. For example, you should call Dispose() when the content type of a text buffer changes or when a buffer is removed from the buffer graph.

Properties

BufferGraph

The buffer graph over which this aggregator operates.

Methods

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

Events

BatchedTagsChanged	Occurs on idle after one or more TagsChanged events.
TagsChanged	Occurs when tags are added to or removed from providers.

Applies to