FOM Reference > Content > Publish Controls > fPrint interface
  
fPrint interface
Macro: tprint, sprint
This object controls the parameters used to print the document.
PrintPageRange enumeration
Specifies how much of the document to print.
The PrintPageRange enumeration has the following constants of type int.
RANGE_PAGES = 0
Select the print range from the pageStart and pageEnd properties.
RANGE_STRING = 1
Select the print range from the pageRange property.
RANGE_ALL = 2
Ignore all page range properties and print the entire document.
PrintSide enumeration
Specifies which sides of the document to print.
The PrintSide enumeration has the following constants of type int.
SIDE_BOTH = 0
Print both the entire document.
SIDE_LEFT = 1
Print only the left pages in the document.
SIDE_RIGHT = 2
Print only the right pages in the document.
copies attribute
How many copies of the document to print. This value defaults to 1.
copies
Access
read-write
Returns
int
cuttingGuides attribute
If true, cutting guides will be printed around each page.
cuttingGuides
Access
read-write
Returns
boolean
pageEnd attribute
The end of the print range, if rangeType is set to RANGE_PAGES.
pageEnd
Access
read-write
Returns
int
pageNumberPadding attribute
If the fPrinter fileFrequency property is set to fPrinter.FILE_NEW_PER_PAGE or fPrinter.FILE_NEW_PER_RANGE, specifies the minimum number of digits to output in the page number, padding with '0' as required.
pageNumberPadding
Access
read-write
Returns
int
pageRange attribute
A string containing the print range, if rangeType is set to RANGE_ALL. The syntax of the string can contain either single or multiple numbers and ranges of numbers (a-b), separated by either commas or spaces.
pageRange
Access
read-write
Returns
String
pageStart attribute
The start of the print range, if rangeType is set to RANGE_PAGES.
pageStart
Access
read-write
Returns
int
printControl attribute
The name of the printer control stream to use, if any.
printControl
Access
read-write
Returns
fStream
printer attribute
The fPrinter object containing the printer and related settings to use.
printer
Access
read-write
Returns
fPrinter
rangeType attribute
Which page ranges properties to follow. Value is one of fPrint.PrintPageRange
rangeType
Access
read-write
Returns
int
registrationMarks attribute
If true, registration marks will be printed around each page.
registrationMarks
Access
read-write
Returns
boolean
revisionMarks attribute
If true, any revision marks present in the document will be printed.
revisionMarks
Access
read-write
Returns
boolean
sides attribute
Which sides of the document to print. Value is one of fPrint.PrintSide
sides
Access
read-write
Returns
int
singlePage attribute
If true, each page will be printed separately.
singlePage
Access
read-write
Returns
boolean
sizePercent attribute
The percentage size to print.
sizePercent
Access
read-write
Returns
float
sizeRatio attribute
The scale of page height compared to page width. This value defaults to 1.
sizeRatio
Access
read-write
Returns
int
fPrint method
Create a new fPrint object, for use in fTemplate.publish()
fPrint
Parameters
None
Returns
fPrint. The newly created fPrint object.
readResolve method
Return the object corresponding to the given serialized representation.
readResolveobj
Parameters
Objectobj
The serialized representation.
Returns
fPrint. The object corresponding to the serialized representation.