The <binding-properties/> command

Sets binding properties for the current element.

Where allowed

Any mapping.

Range of effect

The current element.

Attributes

allow-columnbreak

Specifies whether column breaks are permitted within bound content. The permitted values are:

  • yes — Content that is bound together must be rendered on the same page, but is permitted to break across column boundaries within multi-column layouts.

  • no — Content that is bound together must be rendered on the same page, or within a single column in a multi-column layout.

  • legacy — Content that is bound together must be rendered on the same page, or within a single column in a multi-column layout, unless an internal boundary is declared within the scope of that content. When the internal boundary is processed, TopLeaf will automatically cancel the binding. Content on either side of the internal boundary will appear on the same page, but a page break is permitted. The amount of content that is held together can be configured by adjusting the value of the minimum segment depth.

If not specified, the default value is legacy.

allow-pagebreak

Specifies whether page breaks are permitted within bound content. The permitted values are:

  • no — Content that is bound together must not appear on different pages.

  • legacy — Content that is bound together must not appear on different pages, unless an internal boundary is declared within the scope of that content. When the internal boundary is processed, TopLeaf will automatically cancel the binding. Content on either side of the internal boundary will appear on the same page, but a page break is permitted. The amount of content that is held together can be configured by adjusting the value of the minimum segment depth.

If not specified, the default value is legacy.

Example

In the following example, bound content rendered within a multi-column layout must be rendered on the same page, but may break across columns:

<binding-properties allow-pagebreak="no" allow-columnbreak="yes" />
[Note] Note

The allow-columnbreak and allow-pagebreak properties can only be declared at the outer most level of a bound content region. The application of these properties to specific components within bound element content is not supported.

If the amount of content bound together exceeds the depth of the page data area, TopLeaf will automatically break the bind, and generate an error.