IStructureTag Interface

Definition

Namespace:

Microsoft.VisualStudio.Text.Tagging

Assembly:

Microsoft.VisualStudio.Text.UI.dll

Package:

Microsoft.VisualStudio.Text.UI v17.11.260

Represents a structural code block, which is used for vertical structural line adornments and outlining collapse regions.

public interface class IStructureTag : Microsoft::VisualStudio::Text::Tagging::ITag

public interface IStructureTag : Microsoft.VisualStudio.Text.Tagging.ITag

type IStructureTag = interface
    interface ITag

Public Interface IStructureTag
Implements ITag

Derived

Microsoft.VisualStudio.Text.Editor.Tags.ContainerStructureTag

Microsoft.VisualStudio.Text.Tagging.IContainerStructureTag

Microsoft.VisualStudio.Text.Tagging.IStructureTag2

Microsoft.VisualStudio.Text.Tagging.StructureTag

Implements

ITag

Remarks

IStructureTag is the replacement for the IBlockTag which should not be used.

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 a block can be collapsed.
IsDefaultCollapsed	Determines whether a block is collapsed by default.
IsImplementation	Determines whether a block is an implementation block.
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.
Snapshot	The Snapshot from which this IStructureTag 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.