SurroundHeader Property

Description

Gets or sets a value indicating whether the page border surrounds the section's header. If this property is set to true, the page border surrounds the header, otherwise it surrounds only the text. This property only has a meaning, if the MeasureFromText property has been set to true.

Syntax

public bool SurroundHeader { get; set; }

Public Property SurroundHeader As Boolean

Examples

The following example configures the page border of the first document section by using PageBorder.SurroundHeader.

PageBorder pageBorder = textControl.Sections[1].Format.PageBorder;

pageBorder.SurroundHeader = true;
if (pageBorder.SurroundHeader)
{
    Console.WriteLine("Page Border: Surround Header is enabled.");
}

Dim pageBorder As PageBorder = textControl.Sections(1).Format.PageBorder

pageBorder.SurroundHeader = True
If pageBorder.SurroundHeader Then
    Console.WriteLine("Page Border: Surround Header is enabled.")
End If

Remarks

The property's default value is false.

The property returns its default value when the text selection contains multiple sections with mixed setting. The Selection.IsCommonValueSelected method can be used to check for mixed attributes.