FOM Reference > Content > Format Controls > fFootnote interface
  
fFootnote interface
Macro: tfnote
This object represents a footnote control object.
ProcessType enumeration
These options define when the footnote is processed.
The ProcessType enumeration has the following constants of type int.
PROCESS_WITHREF = 0
Process the footnote as the reference is processed.
PROCESS_AFTERPAGE = 1
Process the footnote after a page break.
PROCESS_AFTERCOLUMN = 2
Process the footnote after a column break.
PROCESS_MANUAL = 3
Wait for a manual command.
PlacementVertical enumeration
These options define where the footnote is processed.
The PlacementVertical enumeration has the following constants of type int.
VERTICAL_BOTTOMUP = 1
Place the footnotes from the bottom up.
VERTICAL_LOWESTLINE = 2
Place the footnotes below the lowest line.
VERTICAL_TOPDOWN = 3
Place the footnotes from the top down.
VERTICAL_SIDENOTE = 4
Place the footnote as a sidenote.
VERTICAL_BELOWREFERENCE = 5
Place the footnotes below the reference line.
VERTICAL_BELOWLOWEST = 6
Place the footnotes at the bottom, below the lowest footnote.
PlacementHorizontal enumeration
These options define where the footnote is processed.
The PlacementHorizontal enumeration has the following constants of type int.
HORIZONTAL_ACROSSALL = 0
Place the footnotes across all columns.
HORIZONTAL_SAMECOL = 2
Place the footnotes in the same column as the reference.
HORIZONTAL_NOMINATED = 3
Place the footnotes in nominated columns.
ResolveDisplaced enumeration
These options define how displaced footnote references are handled.
The ResolveDisplaced enumeration has the following constants of type int.
RESOLVE_REMOVETEXT = 0
Resolve references by removing the text and leaving the space.
RESOLVE_REDUCEHEIGHT = 1
Resolve references by reducing the height of the footnotes.
RESOLVE_REDUCESPACE = 2
Resolve references by reducing the space of the first footnote.
HandleSidenotes enumeration
These options define how to handle oversized sidenotes.
The HandleSidenotes enumeration has the following constants of type int.
SIDENOTE_SPLIT = 0
Split oversized sidenotes.
SIDENOTE_MOVE = 1
Move sidenotes up.
SIDENOTE_PUSH = 2
Push sidenotes up.
DisregardMode enumeration
These options define how to handle identical footnotes
The DisregardMode enumeration has the following constants of type int.
DISREGARD_NONE = 0
No footnotes are disregarded
DISREGARD_EXACT = 1
Footnotes are disregarded if their XML content matches exactly
DISREGARD_SELECTIVE = 2
Footnotes are disregarded if their XML content matches, but ignoring selective attributes
SideAlignFrame enumeration
These options define how to align sidenotes.
The SideAlignFrame enumeration has the following constants of type int.
SIDENOTE_FIRST = 0
Align sidenotes with the 1st baseline.
SIDENOTE_FRAMETOP = 1
Align sidenotes with the frame top.
SIDENOTE_FRAMEBOTTOM = 2
Align sidenotes with the frame bottom.
SIDENOTE_FRAMECENTER = 2
Align sidenotes with the frame center.
SideAlignRef enumeration
These options define how to align sidenotes with the references.
The SideAlignRef enumeration has the following constants of type int.
SIDENOTE_BASELINE = 0
Align sidenotes with the reference baseline.
SIDENOTE_REFTOP = 1
Align sidenotes with the reference top.
SIDENOTE_REFBOTTOM = 2
Align sidenotes with the reference bottom.
CombineModes enumeration
These options define how to footnotes are combined.
The CombineModes enumeration has the following constants of type int.
COMBINE_NONE = 0
Footnotes will not be combined, they will be placed in separate frames.
COMBINE_COPY = 1
Footnotes copied into a single stream to be displayed in a single frame.
The generated streams flags are copied from the first footnote, and if XML, the footnotes will be wrapped in the fFootnote.wrapperElement .
COMBINE_REFERENCE = 2
Footnotes combined, but the generated stream will reference the original stream to be displayed in a single frame.
The generated streams flags are copied from the first footnote, the footnote references will be wrapped in the fFootnote.wrapperElement. The generated stream will not be XML. XPath processing will be relative to the referenced stream.
alignSidenote attribute
Keyword: alignnote
Where to align sidenotes. Value is one of fFootnote.SideAlignFrame
alignSidenote
Access
read-write
Returns
int
alignWithReference attribute
Keyword: alignref
How to align sidenotes with their references. Value is one of fFootnote.SideAlignRef
alignWithReference
Access
read-write
Returns
int
balanceMode attribute
Keyword: balancemode
Enables special processing for balanced text.
balanceMode
Access
read-write
Returns
boolean
columnGutter attribute
Keyword: gutter
The size of the column gutters. If 0, the column gutter will be sized automatically.
columnGutter
Access
read-write
Returns
fLength
combineFootnotes attribute
Keyword: combine
The behaviour of footnote combining, see fFootnote.CombineModes.
combineFootnotes
Access
read-write
Returns
int
combineSeparator attribute
Keyword: showcomb
The show string to be evaluated between footnotes if they are being combined.
combineSeparator
Access
read-write
Returns
String
defaultShowString attribute
Keyword: showmain
The show string to use when formatting the footnote number in the main stream.
defaultShowString
Access
read-write
Returns
String
delayedFootnotes attribute
Keyword: delaytowait
If true, the footnotes will be delayed for a manual command.
delayedFootnotes
Access
read-write
Returns
boolean
displacedReferences attribute
Keyword: retry
How to resolve displaced references. Value is one of fFootnote.ResolveDisplaced.
displacedReferences
Access
read-write
Returns
int
disregardMultiples attribute
Keyword: multiplecalls
Value is one of fFootnote-DisregardMode
If the value is non zero (not DISREGARD_NONE), multiple calls to the same footnote will be disregarded and the same number will be used.
If the value is 1 (DISREGARD_EXACT), then the two footnotes' content must be an exact match to be counted as being the same footnote;
If the value is 2 (DISREGARD_SELECTIVE) then the text and tag names must still match, but the existence or value of any attributes will be ignored when making this decision. This can also be handled more selectively using disregardMultiplesAttributes, so that only selective tag attributes are ignored.
disregardMultiples
Access
read-write
Returns
int
disregardMultiplesAttributes attribute
Keyword: multiplecallsattributes
Used when disregardMultiples is set to DISREGARD_SELECTIVE which by default means that all attributes are ignored when comparing footnotes to see if they're identical.
But you can set this value to a regular expression so that attributes with matching names will be ignored during the comparison.
N.B. This is not a wildcard but a regular expression, and an attribute name will match if it 'contains' a match for the given expression, so you'll need to use ^ and $ to get exact matches.
e.g.:
"fred" will match attributes named "fred","freda","frederick" and "alfred"
"^fred" will match "fred","freda","frederick" and is the equivalent of "^fred.*"
"^fred$" will just match "fred" and
"^(fred|joe.*)$" will match attributes named either "fred" or starting with "joe"
disregardMultiplesAttributes
Access
read-write
Returns
String
emptyPosition attribute
Keyword: spaceposn
If true and displacedReferences is set to removing text, place the empty footnote on top.
emptyPosition
Access
read-write
Returns
boolean
graphicFirst attribute
Keyword: firstobj
The graphic object to use on the first footnote frame.
graphicFirst
Access
read-write
Returns
fGraphic
graphicOther attribute
Keyword: otherobj
The graphic object to use on the other footnote frames.
graphicOther
Access
read-write
Returns
fGraphic
graphicSurround attribute
Keyword: topobj
The graphic object to use on the surrounding footnote frame.
graphicSurround
Access
read-write
Returns
fGraphic
horizontalPlacement attribute
Keyword: colmode
Defines the horizontal placement of the footnotes. Value is one of fFootnote.PlacementHorizontal
horizontalPlacement
Access
read-write
Returns
int
ignoreRules attribute
Keyword: ignrules
If true, any rules on the main frame will be ignored when copying its properties for the footnote frame.
ignoreRules
Access
read-write
Returns
boolean
levelPages attribute
Keyword: subjob
If true, a new page will be created for the remaining footnotes.
levelPages
Access
read-write
Returns
boolean
limitSpace attribute
Keyword: maxstep
The maximum amount of space to reduce by when resolving displaced references.
limitSpace
Access
read-write
Returns
fLength
maxHeight attribute
Keyword: maxtotal
The maximum height to allow for footnotes.
maxHeight
Access
read-write
Returns
fLength
maxWidth attribute
Keyword: maxwidth
The maximum width to allow for footnotes.
maxWidth
Access
read-write
Returns
fLength
minSplitHeight attribute
Keyword: splitmin
The minimum split height for footnotes.
minSplitHeight
Access
read-write
Returns
fLength
nominatedColumns attribute
Keyword: nomcols
Specifies the columns to place the footnotes if horizontalPlacement is set to nominate.
nominatedColumns
Access
read-only
Returns
int[]
numColumns attribute
Keyword: numcols
The number of columns to create. If 0, the number of columns will be chosen automatically.
numColumns
Access
read-write
Returns
int
oversizedSidenotes attribute
Keyword: sidetype
How to handle oversized sidenotes. Value is one of fFootnote.HandleSidenotes
oversizedSidenotes
Access
read-write
Returns
int
process attribute
Keyword: eject
When the footnote gets processed. Value is one of fFootnote.ProcessType
process
Access
read-write
Returns
int
processInline attribute
Keyword: inline
If true, the footnote gets processed inline.
processInline
Access
read-write
Returns
boolean
reduceSpace attribute
Keyword: reducespace
If true and displacedReferences is set to removing text, the size of the space to leave.
reduceSpace
Access
read-write
Returns
fLength
referenceContinuation attribute
Keyword: contref
The stream to format if the footnotes continue into a new frame.
referenceContinuation
Access
read-write
Returns
fStream
referenceStart attribute
Keyword: startref
The stream to format at the start of the footnote.
referenceStart
Access
read-write
Returns
fStream
referenceSubsequent attribute
Keyword: startref
The stream to format on all subsequent footnotes.
referenceSubsequent
Access
read-write
Returns
fStream
restartNumbering attribute
Keyword: restart
If true, footnote numbers will restart on each page.
restartNumbering
Access
read-write
Returns
boolean
spaceAbove attribute
Keyword: topgap
The amount of space to leave above the first footnote.
spaceAbove
Access
read-write
Returns
fLength
spaceBelow attribute
Keyword: botextra
The amount of space to leave below all footnotes.
spaceBelow
Access
read-write
Returns
fLength
spaceBetween attribute
Keyword: gap
The amount of space to leave between footnotes.
spaceBetween
Access
read-write
Returns
fLength
startNumber attribute
Keyword: startnum
The number to use for the first footnote.
startNumber
Access
read-write
Returns
int
stepSpace attribute
Keyword: step
The amount of space to reduce by when resolving displaced references.
stepSpace
Access
read-write
Returns
fLength
verticalPlacement attribute
Keyword: pos
Defines the vertical placement of the footnotes. Value is one of fFootnote.PlacementVertical
verticalPlacement
Access
read-write
Returns
int
wrapperElement attribute
Keyword: combwrap
The name of the element to wrap the footnotes.
wrapperElement
Access
read-write
Returns
String