BordersDoNotSurroundHeader Class

Page Border Excludes Header.When the object is serialized out as xml, its qualified name is w:bordersDoNotSurroundHeader.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.OnOffType
        DocumentFormat.OpenXml.Wordprocessing.BordersDoNotSurroundHeader

Namespace:  DocumentFormat.OpenXml.Wordprocessing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
Public Class BordersDoNotSurroundHeader _
    Inherits OnOffType
'Usage
Dim instance As BordersDoNotSurroundHeader

public class BordersDoNotSurroundHeader : OnOffType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.15.1.15 bordersDoNotSurroundHeader (Page Border Excludes Header)

This element specifies that a given WordprocessingML document’s page border specified using the pgBorders element (§17.6.10) should not surround contents of the header.

If this element is omitted, then the page border shall not exclude the header on the page. As well, this element shall be ignored if the pgBorders element has a offsetFrom attribute which is not equal to text.

[Note: If the pgBorders element has a offsetFrom attribute equal to page, the bordersDoNotSurroundHeader element is ignored as specifying the pgBorders element with a offsetFrom attribute equal to page is to specify that the positioning of borders within the document shall be calculated relative to the edge of the page and therefore irrespective of document content in the header. end note]

[Example: Consider the following page in a WordprocessingML document:

If this WordprocessingML document is modified to leverage the behavior enabled by this element, this setting would be specified using the following WordprocessingML fragment in the document settings:

<w:bordersDoNotSurroundHeader w:val="true"/>

The bordersDoNotSurroundHeader element's val attribute is equal to true specifying that the page border shall not surround the text extents of the header, as follows:

end example]

This element’s content model is defined by the common boolean property definition in §17.17.4.

© ISO/IEC29500: 2008.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

BordersDoNotSurroundHeader Members

DocumentFormat.OpenXml.Wordprocessing Namespace