CachedColumnBalance Class

Use Cached Paragraph Information for Column Balancing.When the object is serialized out as xml, its qualified name is w:cachedColBalance.

Inheritance Hierarchy

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

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

Syntax

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

public class CachedColumnBalance : OnOffType

Remarks

[ISO/IEC 29500-1 1st Edition]

9.7.3.5 cachedColBalance (Use Cached Paragraph Information for Column Balancing)

This element specifies whether applications shall incorrectly calculate the height of a paragraph for the purposes of column balancing when rendering WordprocessingML documents. Specifically, this element specifies that when a paragraph's lines have differing heights, an application shall treat this paragraph as though it had only one line equaling the full paragraph height, regardless of the actual number of lines in the paragraph.

[Guidance: It is recommended that applications not intentionally replicate this behavior; it is maintained only for compatibility with existing documents from a legacy application. end guidance]

Typically, lines are correctly measured for their height when balancing columns as part of a WordprocessingML document. This element, when present with a val attribute value of true (or equivalent), specifies that applications shall perform the incorrect calculation in the conditions described above.

[Example: Consider a WordprocessingML document with two columns of text which shall be balanced.

If this compatibility setting is turned on:

<w:compat>
<w:cachedColBalance />
</w:compat>

Then applications should perform the calculation described above to balance the columns, as needed. end example]

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

CachedColumnBalance Members

DocumentFormat.OpenXml.Wordprocessing Namespace