FOM Reference > Content > Pages > fPage interface
  
fPage interface
This object describes the structure of a page.
AutocopyMode enumeration
Describes whether or not Autocopy is responsible for this page or not.
The AutocopyMode enumeration has the following constants of type int.
MODE_NONE = 0
This is a manually created, normal page.
MODE_MASTER = 1
This is an Autocopy master page.
MODE_COPY = 2
This is an Autocopy copy page.
AutocopyType enumeration
Describes which type of Autocopy was used to create this page.
The AutocopyType enumeration has the following constants of type int.
TYPE_NORMAL = 0
This page uses normal Autocopy.
TYPE_TPA = 1
This page uses Document Sequences.
TYPE_COPY = 2
This page uses the Preformat Document Sequence.
acMode attribute
The actual autocopy mode used on the page, based on the properties specified on the layers.
acMode
Access
read-only
Returns
int
acPages attribute
Macro: tpacopy
The maximum number of copied pages that can be created without formatting making any progress.
acPages
Access
read-only
Returns
int
acStream attribute
The actual autocopy content stream, based on the properties specified on the layers.
acStream
Access
read-only
Returns
fStream
acType attribute
The actual autocopy type that applies to this page, based on the properties specified on the layers.
acType
Access
read-only
Returns
int
docseqName attribute
getvar: 11734
Name of the document sequence that generated this page.
docseqName
Access
read-only
Returns
String
height attribute
The actual height of the page, including the sizes of any layers of the page.
height
Access
read-only
Returns
fLength
layerGroup attribute
The group of layers on the page.
layerGroup
Access
read-write
Returns
fLayerGroup
mainLayer attribute
The main layer for the page.
mainLayer
Access
read-only
Returns
fLayer
pageNumber attribute
The full page number for this page.
pageNumber
Access
read-only
Returns
String
pageString attribute
A user-definable formatted page number. Note that this is limited to 32 characters.
pageString
Access
read-write
Returns
String
pageseqID attribute
getvar: 21736
The ID number associated with this instance of the page sequence.
pageseqID
Access
read-only
Returns
int
pageseqIsBlank attribute
If true, this page was created as a result of a blank page condition.
pageseqIsBlank
Access
read-only
Returns
boolean
pageseqLanguage attribute
The language specified when this page sequence was started.
pageseqLanguage
Access
read-only
Returns
String
pageseqName attribute
getvar: 11735
Name of the page sequence that generated this page.
pageseqName
Access
read-only
Returns
String
pageseqPageNumber attribute
getvar: 21738
The current page sequence page number.
pageseqPageNumber
Access
read-only
Returns
int
pageseqPageNumberString attribute
getvar: 11741
The current page sequence page number, formatted as text using the rules specified when the page sequence was started.
pageseqPageNumberString
Access
read-only
Returns
String
pageseqPosition attribute
getvar: 21737
The line number in the page sequence containing the rule that generated this page.
pageseqPosition
Access
read-only
Returns
int
pageseqSequenceNumber attribute
getvar: 21739
The number of pages created in this instance of the page sequence.
pageseqSequenceNumber
Access
read-only
Returns
int
pageseqSequenceNumberString attribute
getvar: 11742
The number of pages created in this instance of the page sequence, formatted as text using the rules specified when the page sequence was started
pageseqSequenceNumberString
Access
read-only
Returns
String
pdfPageNumber attribute
A user-definable formatted page number that will be used as the page number when published to PDF. If this property is not set, the normal page number will be used instead. Note that this is limited to 32 characters.
pdfPageNumber
Access
read-write
Returns
String
pos attribute
The position of this page in the document.
pos
Access
read-only
Returns
int
width attribute
The actual width of the page, including the sizes of any layers of the page.
width
Access
read-only
Returns
fLength