ISingleTextRangeIndicatorManager<TTagger, TTag> Interface
Provides the base requirements for a class containing helper methods related to working with an IEditorDocument's text range-based indicators, where a single indicator instance is ever present.
public interface ISingleTextRangeIndicatorManager<TTagger, TTag> where TTagger : class, ICollectionTagger<TTag> where TTag : IIndicatorTag, new()- Type Parameters:
-
TTagger-TTag-
Properties
this[TTag]
Gets the tag range that points to the specified indicator tag.
[C#] In C#, this property is the indexer for the type.
TagVersionRange<TTag> this[TTag tag] { get; }| Parameter | Type | Description |
|---|---|---|
| tag | TTag | The indicator tag for which to search. |
Property Value
- TagVersionRange<TTag>:
The indicator tag range that points to the specified tag.
Methods
Clear()
Removes all indicators.
void Clear()GetInstance()
Returns the single indicator tag range.
TagVersionRange<TTag> GetInstance()Returns
- TagVersionRange<TTag>:
The collection of indicator tag ranges.
SetInstance(TextSnapshotRange)
Removes any other existing indicator and adds new default indicator that is applied to a snapshot text range.
TagVersionRange<TTag> SetInstance(TextSnapshotRange snapshotRange)| Parameter | Type | Description |
|---|---|---|
| snapshotRange | TextSnapshotRange | The target TextSnapshotRange. |
Returns
- TagVersionRange<TTag>:
The TagVersionRange<T> that was created.
SetInstance(TextSnapshotRange, TTag)
Removes any other existing indicator and adds new indicator that is applied to a snapshot text range.
TagVersionRange<TTag> SetInstance(TextSnapshotRange snapshotRange, TTag tag)| Parameter | Type | Description |
|---|---|---|
| snapshotRange | TextSnapshotRange | The target TextSnapshotRange. |
| tag | TTag | The IIndicatorTag to add. |
Returns
- TagVersionRange<TTag>:
The TagVersionRange<T> that was created.