DecorationAdornmentManagerBase<TView, TTag> Class

Namespace:: ActiproSoftware.Windows.Controls.SyntaxEditor.Adornments.Implementation

Assembly:: ActiproSoftware.SyntaxEditor.Wpf.dll

Provides a helpful base class for implementing an adornment manager that displays text decorations.

public abstract class DecorationAdornmentManagerBase<TView, TTag> : AdornmentManagerBase<TView>, IAdornmentManager where TView : ITextView where TTag : ITag

Type Parameters:: TView -
The type of ITextView to support. Use ITextView to support all text view types.

TTag -
The type of ITag to aggregate.

Inheritance:: object AdornmentManagerBase<TView> object

Implements:: IAdornmentManager

Constructors

DecorationAdornmentManagerBase(TView, AdornmentLayerDefinition)

Initializes a new instance of the DecorationAdornmentManagerBase class.

protected DecorationAdornmentManagerBase(TView view, AdornmentLayerDefinition layerDefinition)

Parameter	Type	Description
view	TView	The view to which this manager is attached.
layerDefinition	AdornmentLayerDefinition	The AdornmentLayerDefinition indicating which adornment layer to use.

DecorationAdornmentManagerBase(TView, AdornmentLayerDefinition, bool)

Initializes a new instance of the DecorationAdornmentManagerBase class.

protected DecorationAdornmentManagerBase(TView view, AdornmentLayerDefinition layerDefinition, bool isForLanguage)

Parameter	Type	Description
view	TView	The view to which this manager is attached.
layerDefinition	AdornmentLayerDefinition	The AdornmentLayerDefinition indicating which adornment layer to use.
isForLanguage	bool	Indicates whether this adornment manager is for a language. If `true`, the adornment manager is closed when the language or document within a SyntaxEditor changes.

Methods

AddAdornment(AdornmentChangeReason, ITextViewLine, TagSnapshotRange<TTag>, TextBounds)

Adds an adornment to the AdornmentLayer.

protected abstract void AddAdornment(AdornmentChangeReason reason, ITextViewLine viewLine, TagSnapshotRange<TTag> tagRange, TextBounds bounds)

Parameter	Type	Description
reason	AdornmentChangeReason	An AdornmentChangeReason indicating the add reason.
viewLine	ITextViewLine	The current ITextViewLine being examined.
tagRange	TagSnapshotRange<TTag>	The ITag and the range it covers.
bounds	TextBounds	The text bounds in which to render an adornment.

OnClosed()

Occurs when the manager is closed and detached from the view.

protected override void OnClosed()

Remarks

Overrides should release any event handlers set up in the manager's constructor.

In This Article