Formatting Object Model Reference > Formatting > Datatypes > fFormatState interface
  
fFormatState interface
This object provides access to the state of the content area currently being formatted.
areaBottom attribute
The bottom edge of the current area.
areaBottom
Access
read-only
Returns
fLength
areaLeft attribute
The left edge of the current area.
areaLeft
Access
read-only
Returns
fLength
areaRight attribute
The right edge of the current area.
areaRight
Access
read-only
Returns
fLength
areaRotation attribute
The rotation of the current area.
areaRotation
Access
read-only
Returns
float
areaTop attribute
The top edge of the current area.
areaTop
Access
read-only
Returns
fLength
consecutiveHyphens attribute
The number of consecutive hyphens formatted so far.
consecutiveHyphens
Access
read-only
Returns
int
contentAreaBottom attribute
The bottom edge of the current content area after margins have been applied.
contentAreaBottom
Access
read-only
Returns
fLength
contentAreaLeft attribute
The left edge of the current content area after margins have been applied.
contentAreaLeft
Access
read-only
Returns
fLength
contentAreaLeftEdge attribute
The left edge of the current content area before any margins or rules are applied.
contentAreaLeftEdge
Access
read-only
Returns
fLength
contentAreaLeftIndent attribute
The amount of left indent applied to this content area.
contentAreaLeftIndent
Access
read-only
Returns
fLength
contentAreaLeftRules attribute
The left edge of the current content area after rules have been applied.
contentAreaLeftRules
Access
read-only
Returns
fLength
contentAreaRight attribute
The right edge of the current content area after margins have been applied.
contentAreaRight
Access
read-only
Returns
fLength
contentAreaRightEdge attribute
The right edge of the current content area before any margins or rules are applied.
contentAreaRightEdge
Access
read-only
Returns
fLength
contentAreaRightRules attribute
The right edge of the current content area after rules have been applied.
contentAreaRightRules
Access
read-only
Returns
fLength
contentAreaText attribute
The text formatted so far on the current content area.
contentAreaText
Access
read-only
Returns
String
contentAreaTop attribute
The top edge of the current content area after margins have been applied.
contentAreaTop
Access
read-only
Returns
fLength
contentAreaTopRules attribute
The top edge of the current content area after rules have been applied.
contentAreaTopRules
Access
read-only
Returns
fLength
formatting attribute
Whether the current page is being formatted or not.
formatting
Access
read-only
Returns
int
frameColumnCount attribute
The number of frame columns this content area spans across.
frameColumnCount
Access
read-only
Returns
int
frameColumnEnd attribute
The number of the frame column this content area ends in.
frameColumnEnd
Access
read-only
Returns
int
frameColumnStart attribute
The number of the frame column this content area starts in.
frameColumnStart
Access
read-only
Returns
int
horizontalPosition attribute
The horizontal position of the last character formatted, relative to fFormatState-contentAreaLeftEdge.
horizontalPosition
Access
read-only
Returns
fLength
horizontalPositionSpaces attribute
The current horizontal position including any final spaces, relative to fFormatState-contentAreaLeftEdge.
horizontalPositionSpaces
Access
read-only
Returns
fLength
lineWithinColumn attribute
The number of the line in the current column.
lineWithinColumn
Access
read-only
Returns
int
lineWithinPage attribute
The number of the line in the current page.
lineWithinPage
Access
read-only
Returns
int
lineWithinParagraph attribute
The number of the line in the current paragraph.
lineWithinParagraph
Access
read-only
Returns
int
lineWithinTable attribute
The number of the line in the current table.
lineWithinTable
Access
read-only
Returns
int
paragraphWithinPage attribute
The number of the paragraph in the current page.
paragraphWithinPage
Access
read-only
Returns
int
printing attribute
Whether the current page is being printed or not.
printing
Access
read-only
Returns
int
tableColumn attribute
The number of the column in the current table.
tableColumn
Access
read-only
Returns
int
tableColumnGutterWidth attribute
The width of the current table column gutter.
tableColumnGutterWidth
Access
read-only
Returns
fLength
tableColumnLeft attribute
The left edge of the current table column.
tableColumnLeft
Access
read-only
Returns
fLength
tableColumnRight attribute
The right edge of the current table column.
tableColumnRight
Access
read-only
Returns
fLength
tableColumnSpan attribute
The number of table columns that are spanned by the current cell.
tableColumnSpan
Access
read-only
Returns
int
tableColumnWidth attribute
The width of the current table column.
tableColumnWidth
Access
read-only
Returns
fLength
tableRow attribute
The number of the row in the current table.
tableRow
Access
read-only
Returns
int
tableRowSpan attribute
The number of table rows that are spanned by the current cell.
tableRowSpan
Access
read-only
Returns
int
ybase attribute
The baseline for the current line in the paragraph.
ybase
Access
read-only
Returns
fLength
ybaseFirst attribute
The baseline for the first line in the paragraph.
ybaseFirst
Access
read-only
Returns
fLength
ybasePrevious attribute
The baseline for the previous line in the paragraph.
ybasePrevious
Access
read-only
Returns
fLength