FOM Reference > Content > Publish Controls > fFormat interface
  
fFormat interface
Macro: tformat ?, sprint
This object controls the parameters used to format the document.
FormatGotoPage enumeration
Specifies which page to go to once formatting has completed
The FormatGotoPage enumeration has the following constants of type int.
GOTO_FIRST = 0
Go to the first page in the document.
GOTO_LAST = 1
Go to the last page in the document.
GOTO_START = 2
Stay on the current page.
FormatZoomLevel enumeration
Specifies which zoom level to use once formatting has completed.
The FormatZoomLevel enumeration has the following constants of type int.
ZOOM_CURRENT = 0
Use the current zoom level.
ZOOM_FIT = -1
Fit the page inside the window.
ZOOM_FITHORIZONTAL = -2
Fit the page horizontally inside the window.
ZOOM_FITVERTICAL = -3
Fit the page vertically inside the window.
ErrorLogClassFlags enumeration
Specifies which classes of errors should be logged.
The ErrorLogClassFlags enumeration has the following constants of type int.
CLASS_NONE = 0
Log errors from no classes.
CLASS_ANCHORS = 1
Log errors related to anchors.
CLASS_FOOTNOTES = 2
Log errors related to footnotes.
CLASS_FORMATTING = 4
Log errors related to formatting.
CLASS_CLASH = 8
Log errors related to footnote or anchor clashes.
CLASS_RETRY = 16
Log errors related to retrying content.
CLASS_PAGE = 32
Log errors related to pages.
CLASS_TABLE = 64
Log errors related to tables.
CLASS_INTERNAL = 128
Log internal errors.
ErrorLogSeverityFlags enumeration
Specifies which severity of errors should be logged.
The ErrorLogSeverityFlags enumeration has the following constants of type int.
SEVERITY_NONE = 0
Log no errors.
SEVERITY_FATAL = 1
Log fatal error messages.
SEVERITY_NONFATAL = 2
Log non fatal error messages.
SEVERITY_WARNING = 4
Log warning messages.
SEVERITY_INFORMATION = 8
Log information messages.
ErrorLogSeverityOverride enumeration
Specifies what severity the error message should be changed to.
The ErrorLogSeverityOverride enumeration has the following constants of type int.
OVERRIDE_DEFAULT = 0
Use the defined severity level.
OVERRIDE_IGNORE = 1
Don't output this error message.
OVERRIDE_INFORMATION = 2
Treat this error message as an Information message.
OVERRIDE_WARNING = 3
Treat this error message as a Warning.
OVERRIDE_NONFATAL = 4
Treat this error message as a Non Fatal Error.
OVERRIDE_FATAL = 5
Treat this error message as a Fatal Error.
anchor attribute
The anchor control object to use during formatting.
anchor
Access
read-write
Returns
fAnchor
autocopyCreate attribute
If true, create new pages if any autocopy master pages are found.
autocopyCreate
Access
read-write
Returns
boolean
autocopyPurge attribute
If true, delete any pages previously created by autocopy.
autocopyPurge
Access
read-write
Returns
boolean
errorLogClasses attribute
A flag representing the type of formatting errors to log. Value should be one of fFormat.ErrorLogClassFlags.
errorLogClasses
Access
read-write
Returns
int
errorLogErrors attribute
If true, any errors raised during formatting will be written to the formatting error log.
errorLogErrors
Access
read-write
Returns
boolean
errorLogOutput attribute
The location to write all log messages during formatting.
errorLogOutput
Access
read-write
Returns
String
errorLogOverrides attribute
Override the severity of individual error messages. The property of the array is an underscore followed by the log message number (e.g. "_1101"), the value is one of fFormat.ErrorLogSeverityOverride to represent the severity the warning should be.
errorLogOverrides
Access
read-write
Returns
fStringArray
errorLogSeverity attribute
A flag representing what severity of formatting errors to log. Value should be one of fFormat.ErrorLogSeverityFlags.
errorLogSeverity
Access
read-write
Returns
int
formatGoto attribute
Which page to select once formatting has completed. This value should be one of fFormat.FormatGotoPage.
formatGoto
Access
read-write
Returns
int
formatZoom attribute
Which zoom level to select once formatting has completed. This value should either be a positive value to zoom to that level of magnification, or one of fFormat.FormatZoomLevel to select an automatic value to fit the page inside the window.
formatZoom
Access
read-write
Returns
int
frozenCreate attribute
If true, create new pages if the content on frozen pages overflows.
frozenCreate
Access
read-write
Returns
boolean
frozenPurge attribute
If true, delete any extra pages previously created from frozen pages.
frozenPurge
Access
read-write
Returns
boolean
index attribute
The index control object to use during formatting
index
Access
read-write
Returns
fIndex
indexReformat attribute
If true, the document will automatically be reformatted if it contains indexes with fIndexItem.ON_COMMAND set, and index references were found after the index was first generated.
indexReformat
Access
read-write
Returns
boolean
pageEnd attribute
The last page to format.
pageEnd
Access
read-write
Returns
int
pageStart attribute
The page to start formatting from.
pageStart
Access
read-write
Returns
int
repositionAnchors attribute
If true, any anchored frames will be removed before formatting starts.
repositionAnchors
Access
read-write
Returns
boolean
scanLimit attribute
How many pages to try creating when formatting a document using autocopy mode.
scanLimit
Access
read-write
Returns
int
fFormat method
Create a new fFormat object, for use in fTemplate.publish()
fFormat
Parameters
None
Returns
fFormat. The newly created fFormat object.
readResolve method
Return the object corresponding to the given serialized representation.
readResolveobj
Parameters
Objectobj
The serialized representation.
Returns
fFormat. The object corresponding to the serialized representation.