Share via


IStructureElement Interface

Definition

Represents a unit of structure in a code ITextBuffer.

public interface class IStructureElement
public interface IStructureElement
type IStructureElement = interface
Public Interface IStructureElement

Remarks

This class is an immutable subtree of the code structure in the view.

Properties

Children

The IStructureElements nested within this one.

ExtentSpan

The full extent of the block, from the start of the header to the end of the guideline.

GuideLineHorizontalAnchorPoint

The horizontal offset with which to align the structure guide line.

GuideLineSpan

The vertical span within which the structure guide line adornment should be drawn.

HeaderSpan

The span of text at the top of the structural element. e.g.: 'if (true)'

IsCollapsible

Indicates whether or not this element should display a collapse adornment.

IsDefaultCollapsed

Indicates whether or not this element should be collapsed at document open.

IsImplementation

Indicates whether or not this element is related to implementation of a method, function, or property.

OutliningSpan

The span of text to collapse when the outlining adornment is invoked.

Type

One of the PredefinedStructureTagTypes, indicating the semantics of this structural element.

Methods

GetCollapsedForm()

Gets the text to display in the collapse adornment.

GetCollapsedHintForm()

Gets the text to display in the collapse adornment tooltip.

Applies to