Share via

IStructureTag2.PrimaryHeaderSpan Property

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Text.Tagging
Assembly:
Microsoft.VisualStudio.Text.UI.dll
Package:
Microsoft.VisualStudio.Text.UI v17.12.215

Gets the optional Span of the primary header of the code block represented by this tag.

public Microsoft.VisualStudio.Text.Span? PrimaryHeaderSpan { get; }
member this.PrimaryHeaderSpan : Nullable<Microsoft.VisualStudio.Text.Span>
Public ReadOnly Property PrimaryHeaderSpan As Nullable(Of Span)

Property Value

Nullable<Span>

Remarks

For example, in the following snippet of code, 

if (condition1)
{
    //something;
}
else
{
    // something else;
}

PrimaryHeaderSpan of the IStructureTag2 representing "else" statement block would be the same as the HeaderSpan of the IStructureTag representing "if" statement block. This allows structure visualizing features to provide more useful context when visualizing "else" structure blocks.

Applies to