FOM Reference > Content > Pages > fLayer interface
  
fLayer interface
This object describes the contents of a layer.
This object inherits from fControl.
LayerTypes enumeration
The type of layer.
The LayerTypes enumeration has the following constants of type int.
TYPE_MAIN = -1
This is a main layer.
TYPE_OVERLAY = 0
This is an overlay.
TYPE_UNDERLAY = 1
This is an underlay.
TYPE_PASTEBOARD = 2
This is an underlay.
TiePositions enumeration
The type of layer.
The TiePositions enumeration has the following constants of type int.
TIE_NONE = 0
The next page should not be tied.
TIE_RIGHT = 1
Tie to the right.
TIE_BOTTOMRIGHT = 2
Tie to the bottom right.
TIE_BOTTOM = 3
Tie to the bottom.
TIE_BOTTOMLEFT = 4
Tie to the bottom left.
TIE_LEFT = 5
Tie to the left.
TIE_TOPLEFT = 6
Tie to the top left.
TIE_TOP = 7
Tie to the top.
TIE_TOPRIGHT = 8
Tie to the top right.
acMode attribute
Macro: tpacopy
The autocopy mode for the page, i.e. if it is a normal, master or copy page.
acMode
Access
read-write
Returns
int
acPages attribute
Macro: tpacopy
The maximum number of copied pages that can be created without formatting making any progress.
acPages
Access
read-write
Returns
int
acStream attribute
Macro: tpacopy
The name of the content stream or Document Sequence to use to control Autocopy.
acStream
Access
read-write
Returns
fStream
acType attribute
Macro: tpacopy
The type of autocopy responsible for this page.
acType
Access
read-write
Returns
int
frames attribute
The frames on the layer.
frames
Access
read-only
Returns
fFrame[]
height attribute
Macro: tpsize
The height of the layer.
height
Access
read-write
Returns
fLength
layerType attribute
The type of layer, one of the fLayer.LayerTypes values. It is an error to set this property to fLayer.TYPE_MAIN.
layerType
Access
read-write
Returns
int
tieAutocopy attribute
Macro: tptie
If true, the tie expression will continue to be applied if the layer is copied in autocopy mode.
tieAutocopy
Access
read-write
Returns
boolean
tieExpression attribute
Macro: tptie
The tie condition that applies to this layer. This expression should evaluate to a number between 0 and 8, representing the side the next page should be tied to, as listed in fLayer.TiePositions.
tieExpression
Access
read-write
Returns
String
width attribute
Macro: tpsize
The width of the layer.
width
Access
read-write
Returns
fLength
addFrame method
Macro: tfmk
Adds a frame to this layer. If no frame is specified, a new anonymous frame will be created.
addFrameframeuseTemplate
Parameters
fFrameframe
The frame to add to the layer.
booleanuseTemplate
If true, the specified frame will be used as a template.
Returns
fFrame. The new frame object.
clearFrames method
Removes all frames from this layer.
clearFrames
Parameters
None
Returns
void. None.
removeFrame method
Removes the specified frame from this layer.
removeFrameframe
Parameters
fFrameframe
The layer to remove.
Returns
void. None.