IntraTextAdornmentTag Class

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

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)

public class IntraTextAdornmentTag : ITag

The IntraTextAdornmentTag type exposes the following members.

  NameDescription
Public propertyAdornmentGets the adornment to be displayed at the position of the tag. Must not be null.
Public propertyAffinityGets the PositionAffinity of the space-negotiating adornment.
Public propertyBaselineGets the baseline of the space-negotiating adornment.
Public propertyBottomSpaceGets the amount of space that is required between the bottom of the text in the ITextViewLine and the bottom of the ITextViewLine.
Public propertyRemovalCallbackCalled when adornment is removed from the view. May be null.
Public propertyTextHeightGets the height of the text portion of the space-negotiating adornment.
Public propertyTopSpaceGets the amount of space that is required between the top of the text in the ITextViewLine and the top of the ITextViewLine.
Top

  NameDescription
Public methodEqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft