FOM Reference > Content > Pages > fFrameCopyFit interface
  
fFrameCopyFit interface
This object defines which properties should be adjusted to ensure that the text content fits entirely inside the frame.
FitProperties enumeration
Which text property should be modified.
The FitProperties enumeration has the following constants of type DOMString.
FIT_NONE = ""
None.
FIT_HEIGHT = "th"
fStyle.height
FIT_WIDTH = "tw"
fStyle.width
FIT_LEADING = "tlb"
fParagraph.leading
FIT_WORDSPACE = "twb"
fStyle.wordSpace
FIT_WORDSPACEEXTRA = "twe"
fStyle.wordSpaceExtra
FIT_WORDSPACESQUASH = "tws"
fStyle.wordSpaceSquash
FIT_LETTERSPACE = "tlsb"
fStyle.letterSpace
FIT_LETTERSPACEEXTRA = "tlse"
fStyle.letterSpaceExtra
FIT_LETTERSPACESQUASH = "tlss"
fStyle.letterSpaceSquash
FIT_MARGINCOLUMNTOP = "tpct"
fParagraph.marginColumnTop
FIT_MARGINTOP = "tpt"
fParagraph.marginTop
FIT_MARGINBOTTOM = "tpb"
fParagraph.marginBottom
FIT_MARGINLEFT = "tpl"
fParagraph.marginLeft
FIT_MARGINRIGHT = "tpr"
fParagraph.marginRight
ScaleEdges enumeration
Which frame edge should be scaled.
The ScaleEdges enumeration has the following constants of type DOMString.
SCALE_NONE = ""
None.
SCALE_TOP = "/t"
Top Frame Edge
SCALE_BOTTOM = "/b"
Bottom Frame Edge
SCALE_LEFT = "/l"
Left Frame Edge
SCALE_RIGHT = "/r"
Right Frame Edge
SCALE_TOPBOTTOM = "/tb"
Top and Bottom Frame Edges
SCALE_LEFTRIGHT = "/lr"
Left and Right Frame Edges
SCALE_ALL = "/tblr"
All Frame Edges
SCALE_QUICKBOTTOM = "/bqn"
Bottom Frame Edge, Quick No-back
SCALE_QUICKTOP = "/tqn"
Top Frame Edge, Quick No-back
ScaleModes enumeration
The available modes when calculating copy fit.
The ScaleModes enumeration has the following constants of type int.
MODE_AUTO = 0
Calculate copy fit automatically when the frame is re-formatted: if the amount of text within the frame has changed, its copyfitting factor will also be changed.
MODE_ONCE = 1
Calculate copy fit once on the basis of the text contained in the frame when the tffit macro is applied: even if the amount of text within the frame changes, the copyfitting factor will not be changed.
MODE_FIX = 2
Fix copy fit to the value given in actual.
actualScale attribute
If scaleMode is set to MODE_ACTUAL, multiply the property's real value by this amount, overriding the min and max percents.
actualScale
Access
read-write
Returns
float
fitProperty attribute
The name of the text property or frame edges that can be changed when copyfitting. Possible values are in fFrameCopyFit.FitProperties or fFrameCopyFit.ScaleEdges.
fitProperty
Access
read-write
Returns
String
maxPercent attribute
The maximum acceptable scaling. This value defaults to 10000.
maxPercent
Access
read-write
Returns
float
minPercent attribute
The minimum acceptable scaling. This value defaults to 1.
minPercent
Access
read-write
Returns
float
scaleMode attribute
How often to apply this property when copyfitting. Value is one of fFrameCopyFit.ScaleModes
scaleMode
Access
read-write
Returns
int