Objects of this class collect all settings pertaining to tables.

PI: tbabsend

Returns where the right edge of the table is measured from.

PI: tbabsstart

Returns where the left edge of the table is measured from.

PI: tbbreaks

Returns true if breaks are allowed for the table.

PI: tbavoidall

PI: tbavoidclear

PI: tbavoidme

PI: tbavoidnone

PI: tbavoidpreserve

PI: tbbgc

Returns the background colour of the table.

PI: tbcolsets

Returns the column set display definitions.

PI: tbspanspec

Returns the column span specifications for the table.

Returns the individual columns of the table.

Returns the default settings for cells in this table.

Returns the default settings for rows in this table.

PI: tbfnote

Specifies a footnote control stream for table footnotes.

Returns the footnote object for the table when one has been defined, otherwise null is returned.

PI: tbrulefc

Returns true if the table-columns on the left of frame-columns will return true for (?l) or [l] when specified as the conditions for cell rules/background colours. Works similarly for right hand edges and (?r) or [r].

PI: tbgutl

Returns the width of the table's left gutter. NOTE: If value = 0, nothing will be returned.

PI: tbgutr

Returns the width of the table's left gutter. NOTE: If value = 0, nothing will be returned.

PI: tbhkeeptog

Returns true if any header rows for the table are to be automatically kept together.

PI: tbfmth

Returns the table format criteria.

PI: tbfmthdir

Returns the value of the property. If horizontalProgression is 1, the system will transpose left and right settings of the horizontalAlign property. This will only affect tables which are smaller than the parent column. See also progression.

PI: tbigfill

Returns true if the table will restrict the fillers and stop the space at the bottom of cells from being filled.

PI: tbignrw

Returns the value of the property. If false then table rules extend into the table and their width reduces the amount of space for content. If true then the width of any table rules are ignored and they are drawn centred on the table boundary.

Returns true if the current cell is a repeated header.

PI: tbkeeptog

Returns the priority that the contents of the table is kept together, using the priorities in the same way other table keeps work

PI: tbkeep

Returns the priority used to keep the end of a table with the item following it, with the priority behaving in a similar way to paragraph keeps.

PI: tbkeepp

Returns the priority used that the start of this table is kept with the previous item, using the priorities in the same way that paragraph keeps work.

PI: tbma

Returns the width of the top, bottom, left and right margins.

PI: tbmb

Returns the width of the bottom table margin.

PI: tbmbp

Returns the priority for bottom margin.

PI: tbmct

Returns the width of the Margin at the top of each column.

PI: tbmctp

Returns the priority for column top margin.

PI: tbmdt

Returns the width of the top drop which will occur whenever a table is at the top of a column.

PI: tborientm

Returns true if the values for marginTop, marginLeft, marginBottom and marginRight are adjusted so they follow the orientation of the table.

PI: tbml

Returns the width of the left table margin.

PI: tbmmid

Returns the height of the margin between duplicate sets of a table: the default value is 0.

PI: tbmr

Returns the width of the right table margin.

PI: tbmt

Returns the width of the margin above the table.

PI: tbmtmodea

By default tables following a break across will use a column top margin. Returns true if the table is using normal top margins.

PI: tbmtmodet

By default tables following a table will use a column top margin. If this returns true then this will mean the table is using normal top margins.

PI: tbmtp

Returns the priority for the top margin.

PI: tbmtspan

Returns true if the table top or column top margins specified after a span are spanning as well.

PI: tbmustfit

Returns true if the table must fit.

A name can be given to the table in order to make it easier to determine which table is being started and ended using the tableStart() and tableEnd() routines and to determine which table object is being formatted.

PI: tbnsshow

Returns true when table headers and footers are being skipped (using mode 2), then by default any changes to the showstring counters are also skipped/ignored.

PI: tbcoln

Returns the number of columns defined for the current table.

PI: tbrown

Returns the number of rows in the table.

PI: tborient

Returns the value relating to how a table is rotated. This property is used to rotate a table 90 degrees counter clockwise.

PI: tbovflow

Returns the table overflow mode, as described in OverflowMode.

PI: tbovrowz

Returns the row number defined when a table overflows from one page to the next, or one column to the next, then the appropriate row number will be reset to zero when the table restarts. See fTableResolved.RowZeroModes.

PI: tbpadb

Returns the amount of padding at the bottom of the table.

PI: tbpadl

Returns the amount of padding left of the table.

PI: tbpadr

Returns the amount of padding right of the table.

PI: tbpadt

Returns the amount of padding at the top of the table.

PI: tbposreset

PI: tbprescan

Returns true if the current table is in pre-scan mode.

PI: tbdir

Returns 1 if the columns flow from right to left. Default is 0.

By default only the cells for the top level table are editable during formatting. This property returns whether the cells for the desired table are read only.

PI: tbreshow

Returns the current value of the property. When a table overflows a page and headers and footers etc. are inserted then by default the showstring counters flow through from the main body of the table. If resetCounters is non-zero, then when 3B2 re-inserts the header, the showstring counters are put back to the values that they had when the header was first encountered and stored. The header is then formatted and then the counters are restored to the value they had ready for the rest of the body of the table.

N.B. This includes restoring the value of the show string counters for the current page number. So within the header the page number being displayed will be the page on which the header was defined.

When using column and frame references there is a potential clash with any table headers and particularly when using resetCounters = 1. The column and frame references are inserted within the context of the header, so will pick up the header's show string counters, will modify those counters for the duration of the header, and then those changes will be discarded for the main body of the table and any text afterwards. To add more flexibility in this situation, from version 8.10s, resetCounters can also take the value 2. When setting resetCounters = 2, the header is still formatted within its original context and counters, but the frame and column references get given the counters from the main body of the table, and any changes they make are then carried over into the main body of the table after the header finishes.

Added num[,slot] option from version 8.11q, which only applies if num is non-zero. slot is allowed to take a value from 1-5 which has two corresponding effects:

The point of these options is to allow the header to pick up the counters it had when it was originally defined so that it formats as expected; but also to allow the header to make changes within the body of the table - ie to increment a count for each header displayed. The expected use is that for any counter changes that the header needs to make for the body of the table, the following actions will be done:

PI: tbrfill

Returns true when there is a need for more cells in a table to fill a line. rowFill will add more cells so that a line is full. The cells generated by Arbortext APP use, if it exists, the empty cell reference declared with fTableResolvedCell::emptyReference.

PI: tbrorp

Returns the priority of the rowOrphans. Orphans are the first rows of a table which occur at the bottom of a column or page. See KeepPriorities.

PI: tbror

Returns the minimum number of orphan rows for the current table. Orphans are the first rows of a table which occur at the bottom of a column or page.

PI: tbrorx

This option determines when the orphans are applied to tables. Reutrns false (the default) if the orphans are only applied to the first rows in the table. Returns true if the orphans are applied to the first rows in any portion of the table where it overflows.

PI: tbrwidp

Returns the priority of the rowWidows. Widows are the last rows of a table which overflow to the top of a column or page. Default is 255, which is the same as 1. See KeepPriorities.

PI: tbrwid

Returns the minimum number of widows rows for the current table. Widows are the last rows of a table which overflow to the top of a column or page.

The number of rows in the table must be specified using fTableResolved.numRows for row widows to be used.

PI: tbbotr

Returns true when this property forces the bottom rules to be displayed when a table flows over from one page to the next, or one column to the next.

PI: tbtopr

Returns true when this property forces the top rules to be displayed when a table flows over from one page to the next, or one column to the next.

PI: tbrules

Returns the table rules object.

PI: tbsimcol

Returns the current value of the property. In normal tables, the top of each cell is treated like the top of a column, in that paragraph column top margins will be used. However, this does not allow fParagraph::topDrop to be used and if you overflow the cell, column top margins won't apply after the break. When using overflow = 3 for slim tables, it is designed to simulate frame columns and so as well as flowing from one column to the next on overflows, it also works with fParagraph::topDrop and follows the behaviour of normal text at the top of each cell, as if it was at the top of a column; including broken cells.

Setting simulateColumns = 1 allows normal non-slim tables to also simulate column tops at the top of each cell and when breaking and hence also allows fParagraph::topDrop to be used.

When specifying simulateColumns = 2 it works in the same way as simulateColumns = 1 but only applies to cells that are themselves at the top of a frame column. See marginColumnTop and marginDropTop for definition of what is at the top of a frame column and note that the use of simulateColumns allows this definition to cascade down a series of nested tables.

When using simulateColumns = 2 within a boxhead the behaviour is slightly different, as the expected use is to try and align content with the top of a column and within a boxed row the top of cells don't necessarily align with each other. Therefore within the boxhead, fParagraph::topDrop doesn't get applied to each individual cell, but is applied as a one-off to the whole boxed row. This is done by picking up the value of fParagraph::topDrop for the highest cell within the row and using this as a vertical shift for the whole row.

When specifying simulateColumns = 3 it works in the same way as simulateColumns = 1 allowing the use of fParagraph::topDrop, but normal top margins are used instead of using column top margins. This will then also cascade into nested tables or blocks at the top of the cell.

N.B. This does mean that if your cells have top rules, then fParagraph::topDrop won't be seen to have its usual effect.

Blocks: default to simulateColumns = 2 unless numColumns is set explicitly, at which point they use simulateColumns = 1 instead. The basic principle is that if the block is being used to define columns, then they will be treated as such.

PI: tbskipegut

Returns true if there is a gutter defined for the end of the table and this is to be ignored.

PI: tbamode

Returns true if Arbortext APP will try and fit the table columns within the frame columns whilst avoiding the frame gutters.

PI: tbacross

Returns true if the table will break across columns within the frame.

PI: tbacross

Returns the number of columns to span across.

PI: tbspanframe

Returns true if the table will break across all columns.

PI: tbspread

Returns the current value of spreadColumns. If true, the columns will all be expanded in proportion to their widths to make up the shortfall.

PI: tbabsvj

Returns true if any table's vertical margins specified are absolute limits to how much stretch can be applied.

PI: tbfvj

Returns true if the text in a table is set to fill the full column depth.

PI: tbvjmgut

Returns the space between rows of the table.

PI: tbvjpgut

Returns the priority for the space between rows of the table.

PI: tbfvjl

Returns true if there is less than the specified height left at the bottom of the column, then vjLimit will cause the whole table to VJ.

PI: tbvjmbot

Returns the space below the table, which is ignored if the table is the last thing in the column.

PI: tbvjpbot

Returns the priority for the space below the table, which is ignored if the table is the last thing in the column.

PI: tbvjmctop

Returns the space above the table when the table is the first thing in a column.

PI: tbvjpctop

Returns the priority for the space above the table when the table is the first thing in a column.

PI: tbvjmrow

Returns the space below the text in the row, which effectively makes each cell deeper. This will mean that if the text is vertically centred, flushed to bottom or VJ'ed itself, then it will use this extra space.

PI: tbvjmrowb

Returns the space below the text in each cell, but above any bottom cell rules. The text will not expand into this space, as it does with vjMarginRow.

PI: tbvjprowb

Returns the priority for the space below the text in each cell, but above any bottom cell rules. The text will not expand into this space, as it does with vjMarginRowPriority.

PI: tbvjprow

Returns the priority for the space below the text in the row, which effectively makes each cell deeper. This will mean that if the text is vertically centred, flushed to bottom or VJ'ed itself, then it will use this extra space.

PI: tbvjmrowt

Returns the space below any top rules in a cell, but above the text. The text will not ignore this space when vertically centring, VJ'ing etc.

PI: tbvjprowt

Returns the priority for the space below any top rules in a cell, but above the text. The text will not ignore this space when vertically centring, VJ'ing etc.

PI: tbvjmrbot

Returns the space between the last row of the table and the table bottom rules.

PI: tbvjprbot

Returns the priority for the space between the last row of the table and the table bottom rules.

PI: tbvjmrctop

Returns the space between the table top rule and the first row when the table is the first thing in a column.

PI: tbvjprctop

Returns the priority for space between the table top rule and the first row when the table is the first thing in a column.

PI: tbvjmrtop

Returns the space between the table top rule and the first row when the table is not the first thing in a column.

PI: tbvjprtop

Returns the priority for space between the table top rule and the first row when the table is not the first thing in a column.

PI: tbvjmtop

Returns the space above the table when the table is not the first thing in a column.

PI: tbvjptop

Returns the priority for space above the table when the table is not the first thing in a column.

PI: tbw

Returns the width of the table. NOTE: If value = 0, nothing will be returned.

PI: tbwcalc

Returns the value relating to the algorithm used when calculating the column widths, but only has any effect when the contents of cells spanning multiple columns are wider than the sum of the columns they span. The current methods implemented for num are as follows:

N.B.

PI: tbhcalc

Returns the value of the property. It effects the method that 3B2 will use to determine how to allocate space to columns, when there is enough space for all minimum measured column widths to be used, but not enough for maximum measured widths. This works in conjunction with widthCalc if the table contains cells that span columns. The values of code are as follows:

When pre-scanning to measure the column widths, by default 3B2 limits the width of any column to the maximum width of the frame/table. By setting wide_mode to 1, 3B2 will measure any columns as wide as possible. This has the effect of increasing the priority given to columns containing long paragraphs.

N.B.

PI: tbwmode

Returns the value of the property. When a table is too wide for a frame column, by default it just takes up the space that it needs. widthMode lets you specify alternative behaviours as follows: