FOM Reference > Formatting > Blocks > fBlockResolvedRegion interface
  
fBlockResolvedRegion interface
Objects of this class contain settings for individual block regions.
backgroundColor attribute
PI: blockcellbgcolor
The background color for this block region.
backgroundColor
Access
read-write
Returns
fColor
backgroundSpan attribute
PI: blockcellbgspangut
Returns whether background colours span into block gutters.
backgroundSpan
Access
read-write
Returns
boolean
columnNumber attribute
PI: tbcspan
Returns the column number the current cell is in.
columnNumber
Access
read-only
Returns
int
emptyReference attribute
PI: blockcellemptyref
Returns the reference tag you would like to be called at the occurance of an empty region in a block if any.
emptyReference
Access
read-write
Returns
fStream
horizontalAlign attribute
PI: blockcellfmth
Returns the horizontal format of this individual block region.
horizontalAlign
Access
read-write
Returns
String
indentAbsolute attribute
PI: blockindentabs
Returns where the left edge of the block region indent is measured from.
indentAbsolute
Access
read-write
Returns
int
keepTogether attribute
PI: blockcellkeeptogether
Returns the priority that the contents of the block region is kept together, using the priorities in the same way other block keeps work
keepTogether
Access
read-write
Returns
int
minimumHeight attribute
PI: blockcellminh
Returns the length of the minimum height for this region.
minimumHeight
Access
read-write
Returns
fLength
paddingBottom attribute
PI: blockcellpadb
Returns the length of the padding at the bottom of this region
paddingBottom
Access
read-write
Returns
fLength
paddingLeft attribute
PI: blockcellpadl
Returns the length of the padding to the left of this region.
paddingLeft
Access
read-write
Returns
fLength
paddingRight attribute
PI: blockcellpadr
Returns the length of the padding to the right of this region
paddingRight
Access
read-write
Returns
fLength
paddingTop attribute
PI: blockcellpadt
Returns the length of the padding at the top of this region
paddingTop
Access
read-write
Returns
fLength
paraAttributes attribute
PI: blockcellattrib
Returns the attributes to the reference defined by paraReference.
paraAttributes
Access
read-write
Returns
String
paraAttributesCombine attribute
PI: blockcellattribc
Returns 1 if the paragraph attributes specified for the two defaults will be combined.
paraAttributesCombine
Access
read-write
Returns
boolean
paraReference attribute
PI: blockcellpararef
Returns the style reference tag to this individual block region.
paraReference
Access
read-write
Returns
fStream
rowNumber attribute
PI: tbcspan
Returns the row number the current cell is in.
rowNumber
Access
read-only
Returns
int
ruleLeftFrameGutter attribute
PI: blockcellrulelfcgut
Returns true if the region rules span left into frame gutter.
ruleLeftFrameGutter
Access
read-write
Returns
String
ruleLeftGutter attribute
PI: blockcellrulelgut
Returns true if the rule spans into the gutter to the left of the region.
ruleLeftGutter
Access
read-write
Returns
String
ruleRightFrameGutter attribute
PI: blockcellrulerfcgut
Returns true if the region rules span right into frame gutter.
ruleRightFrameGutter
Access
read-write
Returns
String
ruleRightGutter attribute
PI: blockcellrulergut
Returns true if the rule spans into the gutter to the right of the region.
ruleRightGutter
Access
read-write
Returns
String
rules attribute
PI: blockcellrules
Returns the set of rules around this block region.
rules
Access
read-only
Returns
fRules
spanColumnsNum attribute
>PI: blockcspan
Returns the number of rows the column is to span.
spanColumnsNum
Access
read-write
Returns
int
verticalAlign attribute
PI: blockcellfmtv
Returns the vertical alignment of text within this individual block region.
verticalAlign
Access
read-write
Returns
String
fBlockResolvedRegion method
Create a new fBlockResolvedRegion object.
fBlockResolvedRegion
Parameters
None
Returns
fBlockResolvedRegion. The newly created fBlockResolvedRegion.