Objects of this class collect settings for individual columns of a table.

These constants define horizontal alignment of the cell or its contents.

The ColumnHorizontalAlignment enumeration has the following constants of type DOMString.

PI: tbcolalignh

Allows you to specify the way that this column is aligned. This feature could be very useful if you have columns of figures, as it allows you to line them up on the decimal points.

You must include a tab in the cells that you wish to align in this way, as Arbortext APP uses this to work out the amount of space needed for alignment. If a cell in the column does not contain a tab, it will be formatted in the normal way or as specified by horizontalAlign. You will need to set the table column alignment align at the start of the column you wish to align.

PI: tbcolalignc

You may have particular characters within the table text that you want to use to align on rather than a decimal point. This property will only work when used in conjunction with align. You specify the character that you want to use in the command, for example alignChar = '#' would use a # character to align on. You can add a @ or + for advanced options. See for details.

PI: tbcolspec

The default cell properties for the table cells in this column.

PI: tbcolfcnew

Start column in new frame column. Only relevant when used in conjunction with fTable::avoid = true. When working out how to allocate the table columns to fit into frame columns, if mode is true Arbortext APP will try and ensure that this column appears at the left hand edge of one of the frame columns.

PI: tbcolgroupn

Groups this column with the next one - used in conjunction with the 'T', 'B', 'L' and 'R' tests for cell rules.

PI: tbcolgut

Specifies the table column gutter measure or relative spacing specification.

PI: tbcolfmth

It is possible to specify the horizontal format of each paragraph of text within this column.

PI: tbcolmaster

Master columns are only relevant for fTable::widthMode = 2 . They are the columns that are included in every copy of the table when duplicating it. If false then the column is designated as not being a master, if true then the column is designated as a master column. You can have several master columns at once, but bear in mind that each set of columns must also include at least one normal column (or maybe more if keepWithNext is used). The initial '+' is optional likewise the '@', see width for details of use.

PI: tbcolkeepn

This command is only relevant for fTable::widthMode = 2 and when true it forces this column to be tied to the next column, so that they will stay together in a colset.

PI: tbcolmaxw

Arbortext APP automatically scans the table and looks at the longest cell to set column widths, there may be times when you want to override this. For example if the text in a column is all very short you would get a very small column width, you can specify a minimum column width using minimumWidth. The default value is 1mm, so if you want the minimum width to be 40mm you would insert the command column.minimumWidth = '40mm'. If you have a very long cell of text within a column by default Arbortext APP will use its width for the column. This can lead to you having extreme widths, to overcome this you can specify a maximum width using maximumWidth. Therefore if you want a maximum width of column to be 100mm you would insert column.maximumWidth = '100mm'. This command can have optional parameters of + and @. See width for details.

PI: tbcolminw

Normally, Arbortext APP automatically scans the table and looks at the longest cell to set column widths. However, there may be times when you want to override this. For example if the text in a column is all very short you would get a very small column width, you can specify a minimum column width using minimumWidth. The default value is 1mm, so if you want the minimum width to be 40mm you would insert the command column.minimumWidth = 140mm'. If you have a very long cell of text within a column by default Arbortext APP will use its width for the column. This can lead to you having extreme widths. To overcome this you can specify a maximum width using maximumWidth. Therefore if you want a maximum width of column to be 100mm you would insert column.maximumWidth = '100mm'. This command can have optional parameters of + and @. See width for details.

PI: tbcolname

This column's name for fFormatting::tableCellStart().

PI: tbcolpref

Assigns a column style preference tag to a particular column.

PI: tbcolrir

If recallRelativeIndent is true then sets the whole column to default to preserving relative indents. See fTableCell::recallRelativeIndent for a full description.

PI: tbcolres

If reserve = true it specifies that this column is to be reserved and by default the table contents will flow around this column.

PI: tbcolamast

Only relevant when using both fTable::spanColumns = true and fTable::avoid = 1. When acrossMaster is true then this column of the table will be repeated within each column of the frame.

PI: tbcoldel

If true it specifies that this column is to be suppressed and not displayed in the output. When all columns in a table are suppressed then the whole table is swallowed up. The initial '+' is optional likewise the '@', see width for details.

PI: tbcolalignt

When Arbortext APP pre scans the table it automatically works out the widths needed for each of the tabs within the sub-column and will then auto-generate tabs at the right positions when formatting the column for real.

PI: tbcolw

Allows you to specify the width of a column as a single value or as a combination of value(s).

PI: tbcolhmode

widthMode allows you to set a default value for fTableCell::widthMode within a column. See fTableCell::widthMode for details of the value of code.

Create a new fTableColumn object.

Return the object corresponding to the given serialized representation.

Create a serializable representation of this object.