InterLineAdornmentTag Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Editor

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

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

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 above or below lines of text.

public class InterLineAdornmentTag : System.Windows.DependencyObject, Microsoft.VisualStudio.Text.Tagging.ITag

type InterLineAdornmentTag = class
    inherit DependencyObject
    interface ITag

Public Class InterLineAdornmentTag
Inherits DependencyObject
Implements ITag

Inheritance: DependencyObject
InterLineAdornmentTag

Implements: ITag

Remarks

The starting point of the tag's span is used to position the tag. The rest of the span is ignored.

The adornments used by these tags should never be shared across multiple tags (since WPF does not allow UIElements to be displayed in multiple visual trees).

These tags should never be created by an ITaggerProvider since that could attempt to display the same adornment in multiple views. Only IViewTaggerProvider can be used to create taggers that return this type of tag.

Constructors

InterLineAdornmentTag(InterLineAdornmentFactory, Boolean, Double, HorizontalPositioningMode, Double, AdornmentRemovedCallback)

Initializes a new instance of a InterLineAdornmentTag.

Fields

HeightProperty
HorizontalOffsetProperty

Properties

AdornmentFactory	Gets the factory to create the adornment for this tag. It may be null.
Height	The height of of the space created for the adornment.
HorizontalOffset	Horizontal offset of the adornment with respect to the location defined by this.HorizontalPositioningMode.
HorizontalPositioningMode	Specifies how the adornment is positioned horizontally on the line (offset by this.HorizontalOffset).
IsAboveLine	Indicated whether the adornment is displayed on top of or at the bottom of the line.
IsAnimating	Indicates whether or not the tag's height is currently being animated.
RemovalCallback	Called when adornment is removed from the view. It may be null.

Events

HeightChanged	Raised whenever the Height property of this tag is changed.
HorizontalOffsetChanged	Raised whenever the HorizontalOffset of this tag is changed.

Applies to

Share via