TaggerBase<T> Class

public abstract class TaggerBase<T> : ITagger<T>, ITaggerBase, IOrderable, IKeyedObject where T : ITag

protected TaggerBase(string key, IEnumerable<Ordering> orderings, ICodeDocument document)

Parameter	Type	Description
key	string	The string-based key that identifies the object.
orderings	IEnumerable<Ordering>	The collection of Ordering objects, used to determine how this object is positioned relative to other objects.
document	ICodeDocument	The document to which this manager is attached.

protected TaggerBase(string key, IEnumerable<Ordering> orderings, ICodeDocument document, bool isForLanguage)

Parameter	Type	Description
key	string	The string-based key that identifies the object.
orderings	IEnumerable<Ordering>	The collection of Ordering objects, used to determine how this object is positioned relative to other objects.
document	ICodeDocument	The document to which this manager is attached.
isForLanguage	bool	Indicates whether this tagger is for a language. If true, the tagger is closed when the document's language changes.

public ICodeDocument Document { get; }

Property Value

ICodeDocument:

The document to which this tagger is attached.

public string Key { get; }

Property Value

string:

The string-based key that identifies the object.

public IEnumerable<Ordering> Orderings { get; }

Property Value

IEnumerable<Ordering>:

The collection of Ordering objects, used to determine how this object is positioned relative to other objects.

protected void ChangeDocument(ICodeDocument newDocument)

Parameter	Type	Description
newDocument	ICodeDocument	The new ICodeDocument.

Remarks

This method is used when a view-based tagger needs to update the associated document.

public void Close()

public abstract IEnumerable<TagSnapshotRange<T>> GetTags(NormalizedTextSnapshotRangeCollection snapshotRanges, object parameter)

Parameter	Type	Description
snapshotRanges	NormalizedTextSnapshotRangeCollection	The collection of normalized snapshot ranges.
parameter	object	An optional parameter that provides contextual information about the tag request.

Returns

IEnumerable<TagSnapshotRange<T>>:

The tag ranges that intersect with the specified normalized snapshot ranges.

protected virtual void OnClosed()

Remarks

The default implementation of this method does nothing. Overrides should release any event handlers set up in the tagger's constructor.

protected virtual void OnTagAggregatorAttached(ITagAggregatorBase tagAggregator)

Parameter	Type	Description
tagAggregator	ITagAggregatorBase	The aggregator being attached.

Remarks

The default implementation of this method does nothing.

See Also

• OnTagAggregatorDetached(ITagAggregatorBase)

protected virtual void OnTagAggregatorDetached(ITagAggregatorBase tagAggregator)

Parameter	Type	Description
tagAggregator	ITagAggregatorBase	The aggregator being detached.

Remarks

The default implementation of this method does nothing.

See Also

• OnTagAggregatorAttached(ITagAggregatorBase)

protected virtual void OnTagsChanged(TagsChangedEventArgs e)

Parameter	Type	Description
e	TagsChangedEventArgs	A TagsChangedEventArgs that contains the event data.

public event EventHandler Closed

Event Type

EventHandler

public event EventHandler<TagsChangedEventArgs> TagsChanged

Event Type

EventHandler<TagsChangedEventArgs>