PageBreakBefore Class

Defines the PageBreakBefore Class.When the object is serialized out as xml, its qualified name is w:pageBreakBefore.

Inheritance Hierarchy

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

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

Syntax

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

public class PageBreakBefore : OnOffType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.3.1.23 pageBreakBefore (Start Paragraph on Next Page)

This element specifies that when rendering this document in a paginated view, the contents of this paragraph are rendered on the start of a new page in the document.

This means that if the contents of the current paragraph would normally be rendered on the middle of a page in the host document, then the paragraph shall be rendered on a new page as if the paragraph was preceded by a page break in the WordprocessingML contents of the document. This property supersedes any use of the keepNext property, so that if any paragraph wishes to be on the same page as this paragraph, they are still be separated by a page break.

If this element is omitted on a given paragraph, its value is determined by the setting previously set at any level of the style hierarchy (i.e. that previous setting remains unchanged). If this setting is never specified in the style hierarchy, then this property shall not be applied.

[Example: Consider the following document with three paragraphs:

As shown above, the second paragraph is rendered at the bottom of page one. However, a producer can specify that the second paragraph should be displayed at the top of a new page by setting the pageBreakBefore element as follows:

<w:pPr>
  <w:pageBreakBefore/>
</w:pPr>

This would ensure that the second paragraph is displayed on a new page:

Since the paragraph is specified to start on a new page, it begins page two even though it could have fit on page one. end example]

Parent Elements
pPr (§17.3.1.26); pPr (§17.3.1.25); pPr (§17.7.5.2); pPr (§17.7.6.1); pPr (§17.9.23); pPr (§17.7.8.2)

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

PageBreakBefore Members

DocumentFormat.OpenXml.Wordprocessing Namespace