FOM Reference > Formatting > Tables > fTableColumnSpan interface
  
fTableColumnSpan interface
Objects of this class collect settings for collections of columns of a table.
ColumnHorizontalAlignment enumeration
These constants define horizontal alignment of the cell or its contents.
The ColumnHorizontalAlignment enumeration has the following constants of type DOMString.
ALIGN_LEFT = "left"
Horizontally left aligned and justified.
ALIGN_MIDDLE = "middle"
Horizontally centered.
ALIGN_CENTER = "center"
Horizontally centered.
ALIGN_RIGHT = "right"
Horizontally right aligned.
align attribute
PI: tbcolalignh
Allows you to specify the way that the spanned columns are 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 a 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.
align
Access
read-write
Returns
String
alignChar attribute
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.
alignChar
Access
read-write
Returns
String
defaultCell attribute
PI: tbspanspec
The default cell properties for the table cells in the spanned columns.
defaultCell
Access
read-write
Returns
fTableCell
endColumn attribute
PI: tbspanspec
The name or column index of the last column spanned by this fTableColumnSpan.
endColumn
Access
read-write
Returns
String
groupNext attribute
PI: tbcolgroupn
Groups the last spanned column with the next one - used in conjunction with the 'T', 'B', 'L' and 'R' tests for cell rules.
groupNext
Access
read-write
Returns
boolean
horizontalAlign attribute
PI: tbcolfmth
It is possible to specify the horizontal format of each paragraph of text within the spanned columns.
horizontalAlign
Access
read-write
Returns
String
paraReference attribute
PI: tbcolpref
Assigns a column style preference tag to the spanned columns.
paraReference
Access
read-write
Returns
fStream
recallRelativeIndent attribute
PI: tbcolrir
If recallRelativeIndent is true then sets all spanned columns to default to preserving relative indents. See fTableCell::recallRelativeIndent for a full description.
recallRelativeIndent
Access
read-write
Returns
boolean
reserve attribute
PI: tbcolres
If reserve = true it specifies that the spanned columns are to be reserved and by default the table contents will flow around this column.
reserve
Access
read-write
Returns
boolean
startColumn attribute
PI: tbspanspec
The name or column index of the first column spanned by this fTableColumnSpan.
startColumn
Access
read-write
Returns
String
suppress attribute
PI: tbcoldel
If true it specifies that the spanned columns are to be suppressed and not displayed in the output. When all columns in a table are seppressed then the whole table is swallowed up. The initial '+' is optional likewise the '@', see width for details.
suppress
Access
read-write
Returns
boolean
widthMode attribute
PI: tbcolhmode
widthMode allows you to set a default value for fTableCell::widthMode within the spanned columns. See fTableCell::widthMode for details of the value of code.
widthMode
Access
read-write
Returns
boolean
fTableColumnSpan method
Create a new fTableColumnSpan object.
fTableColumnSpan
Parameters
None
Returns
fTableColumnSpan. The newly created object.
readResolve method
Return the object corresponding to the given serialized representation.
readResolveobj
Parameters
Objectobj
The serialized representation.
Returns
fTableColumnSpan. The object corresponding to the serialized representation.