ContainerStructureTag Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Editor.Tags

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

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

Caution

Do not use. This interface has not been finalized and may change without warning.

Extends StructureTag with SubHeadings property improving structure visualization support for secondary structure elements such as C# "else" statement, also support for the "catch" and "case"statement.

[System.Obsolete("Do not use. This interface has not been finalized and may change without warning.")]
public class ContainerStructureTag : Microsoft.VisualStudio.Text.Tagging.StructureTag, Microsoft.VisualStudio.Text.Tagging.IContainerStructureTag, Microsoft.VisualStudio.Text.Tagging.ITag

[<System.Obsolete("Do not use. This interface has not been finalized and may change without warning.")>]
type ContainerStructureTag = class
    inherit StructureTag
    interface IContainerStructureTag
    interface IStructureTag
    interface ITag

Public Class ContainerStructureTag
Inherits StructureTag
Implements IContainerStructureTag, ITag

Inheritance: Object

StructureTag
ContainerStructureTag

Attributes: ObsoleteAttribute

Implements: IContainerStructureTag IStructureTag ITag

Constructors

ContainerStructureTag(ITextSnapshot, Nullable<Span>, Nullable<Span>, Nullable<Span>, Nullable<Int32>, String, Boolean, Boolean, Boolean, Object, Object, IReadOnlyList<SubHeadingStructureData>)

Constructs an instance of the ContainerStructureTag.

Properties

GuideLineHorizontalAnchorPoint	Gets the point with which the block structure adornment will be horizontally aligned. (Inherited from StructureTag)
GuideLineSpan	Gets the vertical span within which the block structure adornment will be drawn. (Inherited from StructureTag)
HeaderSpan	Gets the span of the statement that controls the structural block. (Inherited from StructureTag)
IsCollapsible	Determines whether or not a block can be collapsed. (Inherited from StructureTag)
IsDefaultCollapsed	Determines whether a block is collapsed by default. (Inherited from StructureTag)
IsImplementation	Determines whether a StructureTag represents an implementation block region. (Inherited from StructureTag)
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. (Inherited from StructureTag)
PrimaryHeaderSpan	Gets the optional Span of the primary header of the code block represented by this tag. (Inherited from StructureTag)
Snapshot	The Snapshot from which this structure tag was generated. (Inherited from StructureTag)
SubHeadings	Gets the optional SubHeadingStructureData of the sub headings of the code block represented by this tag. This Tag will provide below information: Get the whole span of this code block. Gets the span of the statement that controls the structural block. Determines the semantic type of the structural block.
Type	Determines the semantic type of the structural block. (Inherited from StructureTag)

Methods

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

Applies to

Share via