IntraTextAdornmentTag Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Editor

Assembly:: Microsoft.VisualStudio.Text.UI.Wpf.dll

Package:: Microsoft.VisualStudio.Text.UI.Wpf v17.11.260

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.

Represents a tag that provides adornments to be displayed as interspersed with text.

public ref class IntraTextAdornmentTag : Microsoft::VisualStudio::Text::Tagging::ITag

[Windows::Foundation::Metadata::WebHostHidden]
class IntraTextAdornmentTag : Microsoft::VisualStudio::Text::Tagging::ITag

public class IntraTextAdornmentTag : Microsoft.VisualStudio.Text.Tagging.ITag

type IntraTextAdornmentTag = class
    interface ITag

Public Class IntraTextAdornmentTag
Implements ITag

Inheritance: Object
IntraTextAdornmentTag

Implements: ITag

Remarks

The tag's span will be elided from the view and that text will be replaced by the adornment provided by this tag.

The aggregator for these tags is created on a per-view basis and handles the production of SpaceNegotiatingAdornmentTag objects, text hiding, and the positioning of adornments on the adornment layer.

This will only work for views that have the Structured view role.

Constructors

IntraTextAdornmentTag(UIElement, AdornmentRemovedCallback, Nullable<Double>, Nullable<Double>, Nullable<Double>, Nullable<Double>, Nullable<PositionAffinity>, Double)	Initializes a new instance of a IntraTextAdornmentTag.
IntraTextAdornmentTag(UIElement, AdornmentRemovedCallback, Nullable<Double>, Nullable<Double>, Nullable<Double>, Nullable<Double>, Nullable<PositionAffinity>)	Initializes a new instance of a IntraTextAdornmentTag.
IntraTextAdornmentTag(UIElement, AdornmentRemovedCallback, Nullable<PositionAffinity>)	Initializes a new instance of a IntraTextAdornmentTag.
IntraTextAdornmentTag(UIElement, AdornmentRemovedCallback)	Initializes a new instance of a IntraTextAdornmentTag.

Properties

Adornment	Gets the adornment to be displayed at the position of the tag. It must not be null.
Affinity	Gets the PositionAffinity of the space-negotiating adornment.
Baseline	Gets the baseline of the space-negotiating adornment.
BottomSpace	Gets the amount of space needed between the bottom of the text in the ITextViewLine and the bottom of the ITextViewLine.
Ranking	Gets the adornments ranking (used as a tie breaker to position coincident adornments).
RemovalCallback	Called when adornment is removed from the view. It may be null.
TextHeight	Gets the height of the text portion of the space-negotiating adornment.
TopSpace	Gets the amount of space needed between the top of the text in the ITextViewLine and the top of the ITextViewLine.

Applies to

Share via