fBlockRow interface

FOM Reference > Formatting > Blocks > fBlockRow interface

fBlockRow interface

This class provides objects that contain default settings for the rows of a block.

columnTopPreserve attribute

PI: blockrowctp

BlockRegions and their content within a row behave slightly differently when that row is at the top of a column, in terms of conditional rules, margins, drop tops etc. Setting this to true lets you specify that iff this row is at the top of a column, then that property is preserved for the following row. It can be a useful property to apply to a header, so that rows immediately after the header are treated as being at top of column.

columnTopPreserve
Access	read-write
Returns	boolean

defaultParagraph attribute

Specify default paragraph properties for cells in this row.

defaultParagraph
Access	read-write
Returns	fParagraph

defaultRegion attribute

Specify default cell properties for cells in this row.

defaultRegion
Access	read-write
Returns	fBlockRegion

defaultStyle attribute

Specify default styling for cells in this row.

defaultStyle
Access	read-write
Returns	fStyle

gutterAbove attribute

PI: blockrowtguttop

It is possible to allocate a gutter above a row in your block with gutterAbove. You must include a height measurement (e.g. row.gutterAbove = '20mm'). The command must be included at the start of a row for it to be effective, however if the command is found at the first row of the block it will be ignored. If you include the command at the top of the block it will define the default for every row.

gutterAbove
Access	read-write
Returns	fLength

gutterBelow attribute

PI: blockrowgut

Specifies the measure of the block gutter under a row in a block.

gutterBelow
Access	read-write
Returns	fLength

rowFill attribute

PI: blockrowfill

This feature or command has not been fully implemented in 3B2 or is still under development for a future release. Use of this feature or command is done so entirely at your own risk before notification of full implementation in the release notes or documentation.

Block Line padding. When there is a need for more regions in a block to fill a line, rowFill will add more regions so that a line is full. The regions generated by Arbortext APP use, if it exists, the empty region reference declared with fBlockRegion::emptyReference.

rowFill
Access	read-write
Returns	boolean

verticalAlignInherit attribute

PI: blockrowvjinherit

Row inherits vj values for the row from region contents.

verticalAlignInherit
Access	read-write
Returns	boolean

verticalAlignInheritBottom attribute

PI: blockrowvjinheritb

Row inherits bottom vj values for the row from region contents.

verticalAlignInheritBottom
Access	read-write
Returns	boolean

fBlockRow method

Create a new fBlockRow object.

fBlockRow
Parameters	None
Returns	fBlockRow. The newly created object.

readResolve method

Return the object corresponding to the given serialized representation.

readResolveobj
Parameters	Objectobj The serialized representation.
Returns	fBlockRow. The object corresponding to the serialized representation.

writeReplace method

Create a serializable representation of this object.

writeReplace
Parameters	None
Returns	Object. A serializable representation of this object.