StructureTag Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Tagging

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

Package:: Microsoft.VisualStudio.Text.UI 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.

An implementation of IStructureTag2.

public ref class StructureTag : Microsoft::VisualStudio::Text::Tagging::IStructureTag, Microsoft::VisualStudio::Text::Tagging::ITag

public class StructureTag : Microsoft.VisualStudio.Text.Tagging.IStructureTag, Microsoft.VisualStudio.Text.Tagging.ITag

public class StructureTag : Microsoft.VisualStudio.Text.Tagging.IStructureTag2, Microsoft.VisualStudio.Text.Tagging.ITag

type StructureTag = class
    interface IStructureTag
    interface ITag

type StructureTag = class
    interface IStructureTag2
    interface IStructureTag
    interface ITag

Public Class StructureTag
Implements IStructureTag, ITag

Public Class StructureTag
Implements IStructureTag2, ITag

Inheritance: Object
StructureTag

Derived: Microsoft.VisualStudio.Text.Editor.Tags.ContainerStructureTag

Implements: IStructureTag ITag IStructureTag2

Remarks

Using this class is the recommended way to create an instance of IStructureElement for most purposes.

Constructors

StructureTag(ITextSnapshot, Nullable<Span>, Nullable<Span>, Nullable<Span>, Nullable<Int32>, String, Boolean, Boolean, Boolean, Object, Object, Nullable<Span>)	Constructs an instance of the IStructureTag.
StructureTag(ITextSnapshot, Nullable<Span>, Nullable<Span>, Nullable<Span>, Nullable<Int32>, String, Boolean, Boolean, Boolean, Object, Object)	Constructs an instance of the IStructureTag.

Properties

GuideLineHorizontalAnchorPoint	Gets the point with which the block structure adornment will be horizontally aligned.
GuideLineSpan	Gets the vertical span within which the block structure adornment will be drawn.
HeaderSpan	Gets the span of the statement that controls the structural block.
IsCollapsible	Determines whether or not a block can be collapsed.
IsDefaultCollapsed	Determines whether a block is collapsed by default.
IsImplementation	Determines whether a StructureTag represents an implementation block region.
OutliningSpan	Gets the span containing the entire contents of the block (minus the block header). This span will be collapsed or expanded when the block outlining adornment is invoked.
PrimaryHeaderSpan	Gets the optional Span of the primary header of the code block represented by this tag.
Snapshot	The Snapshot from which this structure tag was generated.
Type	Determines the semantic type of the structural block.

Methods

GetCollapsedForm()	Gets the data object for the collapsed UI. If the default is set, returns null.
GetCollapsedHintForm()	Gets the data object for the collapsed UI tooltip. If the default is set, returns null.

Applies to

Share via