Row Table Attributes
In addition to the attributes listed in the
Shared table attributes help topic, the following attributes are supported on row table objects.
BREAK_PENALTY
The value of BREAK_PENALTY is used to determine whether to cause a page break. BREAK_PENALTY can be one of the following values:
◦ default — No preference on a break.
◦ allow — Permit a break.
◦ inhibit — Do not permit a break.
◦ force — Insert a break.
◦ recto — Break to the next odd page.
◦ verso — Break to the next even page.
FOOTER_LEVEL
If the row is a footer row, this attribute will be one (1) otherwise it will be zero (0). This attribute cannot be set to one (1) if the HEADER_LEVEL attribute is already set to one (1).
For the Arbortext table model, no row may have a non-zero footer level. For the CALS table model (OASIS Exchange), the table can include a block of header rows, followed by a block of footer rows, followed by a block of body rows. For the CALS table model, setting a row's footer level will cause the row to be moved to the footer or body block, as appropriate.
You can not mark a row as a footer row if doing so removes the only row from the table that is not a footer row. For example, if there is only one row in the table, it can't be a footer row as there must always be at least one row in the table that is not a footer row.
Do not change the value of FOOTER_LEVEL. Doing so will render the original row invalid and may cause an AOM exception to be thrown or cause Arbortext Editor to terminate unexpectedly.
HEADER_LEVEL
If the row is a header row, this attribute will be one (1), otherwise it will be zero (0). This attribute cannot be set to one (1) if the FOOTER_LEVEL attribute is already set to one (1).
For the Arbortext table model, only the first row in the table may have a nonzero header level. For the CALS table model (OASIS Exchange), the table can include of a block of header rows, followed by a block of footer rows, followed by a block of body rows. For the CALS table model, setting a row's header level will cause the row to be moved to the header or body block, as appropriate.
You can't mark a row as a header row if this action removes the only row from the table that is not a header row. For example, if there is only one row in the table, it can't be a header row as there must always be at least one row in the table that is not a header row.
Do not change the value of HEADER_LEVEL. Doing so will render the original row invalid and may cause an AOM exception to be thrown or cause Arbortext Editor to terminate unexpectedly.
HEIGHT_UNIT
This attribute is the unit portion of the TARGET_HEIGHT attribute. This attribute exists to allow the user to convert between units without doing actual calculations. If a row's TARGET_HEIGHT attribute is 1.0in, a call to the tbl_obj_attr_set function with a HEIGHT_UNIT attribute value of cm will cause the row's TARGET_HEIGHTunit to be changed to 2.54cm.
TARGET_HEIGHT
If the row's USE_TARGET_HEIGHT attribute is one ( 1), this attribute is a unitdim value indicating the height that is used to display the row. Permissible values are in, pt, pi, px, cm, or mm meaning inches, points, picas, pixels, centimeters, or millimeters.
Setting this attribute causes the USE_TARGET_HEIGHT attribute to be set to one (1). Resetting this attribute to its default value (using tbl_obj_attr_delete) causes the USE_TARGET_HEIGHT attribute to be set to zero ( 0).
USE_TARGET_HEIGHT
This attribute may be zero (0) or one ( 1) to indicate whether the value of the TARGET_HEIGHT attribute should be used. The user can not set this attribute directly, but can influence its value by calling tbl_obj_attr_get or tbl_obj_attr_delete for the TARGET_HEIGHT attribute.
Related Topics