Share via


ShowBreaksInFrames Class

Display Page/Column Breaks Present in Frames.When the object is serialized out as xml, its qualified name is w:showBreaksInFrames.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public Class ShowBreaksInFrames _
    Inherits OnOffType
'Usage
Dim instance As ShowBreaksInFrames
public class ShowBreaksInFrames : OnOffType

Remarks

[ISO/IEC 29500-1 1st Edition]

9.7.3.36 showBreaksInFrames (Display Page/Column Breaks Present in Frames)

This element specifies whether applications should honor the presence of page and/or column breaks which are present within the contents of paragraphs which have been defined as frames using the framePr element (Part 1, §17.3.1.11).

Typically, breaks within frames shall be ignored and shall have no effect on the display of the paragraph in which they are contained. This element, when present with a val attribute value of true (or equivalent), specifies that rather than completely ignoring these breaks, applications should display the break and move the remaining frame content, and all subsequent text, to the next page and/or column, as needed.

[Example: Consider a WordprocessingML document with a paragraph contained within a text frame:

DocumentFormat.OpenXml.Wordprocessing.ShowBreaksIn

The default presentation would display the page break inline in the frame (breaking the frame into two) but would not actually break the page:

DocumentFormat.OpenXml.Wordprocessing.ShowBreaksIn

However, if this compatibility setting is turned on:

<w:compat>
<w:showBreaksInFrames />
</w:compat>

Then the page breaks is used even though they are present in the frame, breaking the page and resulting in the following output:

DocumentFormat.OpenXml.Wordprocessing.ShowBreaksIn

end example]

Parent Elements

compat (Part 1, §17.15.1.21)

This element’s content model is defined by the common boolean property definition in Part 1, §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

ShowBreaksInFrames Members

DocumentFormat.OpenXml.Wordprocessing Namespace