Share via


IntraTextAdornmentTag Class

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

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Text.Editor.IntraTextAdornmentTag

Namespace:  Microsoft.VisualStudio.Text.Editor
Assembly:  Microsoft.VisualStudio.Text.UI.Wpf (in Microsoft.VisualStudio.Text.UI.Wpf.dll)

Syntax

'Declaration
Public Class IntraTextAdornmentTag _
    Implements ITag
public class IntraTextAdornmentTag : ITag
public ref class IntraTextAdornmentTag : ITag
type IntraTextAdornmentTag =  
    class 
        interface ITag 
    end
public class IntraTextAdornmentTag implements ITag

The IntraTextAdornmentTag type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property Adornment Gets the adornment to be displayed at the position of the tag. Must not be nulla null reference (Nothing in Visual Basic).
Public property Affinity Gets the PositionAffinity of the space-negotiating adornment.
Public property Baseline Gets the baseline of the space-negotiating adornment.
Public property BottomSpace Gets the amount of space that is required between the bottom of the text in the ITextViewLine and the bottom of the ITextViewLine.
Public property RemovalCallback Called when adornment is removed from the view. May be nulla null reference (Nothing in Visual Basic).
Public property TextHeight Gets the height of the text portion of the space-negotiating adornment.
Public property TopSpace Gets the amount of space that is required between the top of the text in the ITextViewLine and the top of the ITextViewLine.

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

The tag span is elided from the view and that text is replaced by the adornment that is provided by this tag.

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

This works only for views that have the Structured view role.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Text.Editor Namespace