FOM 参考 > Formatting > References > fFootnoteReference interface
fFootnoteReference interface
Macro: trefnote
This object sets up a footnote reference.
FootnoteType enumeration
What type of footnote to create.
The FootnoteType enumeration has the following constants of type int.
TYPE_NORMAL = 0
Creates a new footnote.
TYPE_INLINE_NAME = 1
Inline to the named stream.
TYPE_INLINE_AUTO = 2
Inline to an automatically created stream.
TYPE_LIST_NAME = 3
Extract from the list to a named stream.
TYPE_LIST_AUTO = 4
Extract from the list to automatically created stream.
TYPE_MANUAL = 5
Manually include outstanding footnotes.
XMLState enumeration
 
The XMLState enumeration has the following constants of type int.
XML_NONE = 0
Take no action.
XML_AUTO = 1
The XML status should be automatically determined from the content.
XML_FORCE_ON = 4
The XML status should be forced on regardless of the content.
XML_FORCE_OFF = 7
The XML status forced be forced off regardless of the content.
FootnoteReferenceHierarchy enumeration
Which stream in the formatting hierarchy to extract the text from.
The FootnoteReferenceHierarchy enumeration has the following constants of type int.
EXTRACT_MAIN = 0
Extract from the main stream.
EXTRACT_PARENT = -1
Extract from the parent stream.
EXTRACT_CURRENT = 999
Extract from the current stream.
AllowFlags enumeration
The different options available for allowing non-text content when generating the text for the footnote.
The AllowFlags enumeration has the following constants of type int.
ALLOW_REFERENCES = 1
Allow entity references.
ALLOW_TAGS = 2
Allow tags and elements.
ALLOW_PIS = 4
Allow processing instructions.
ALLOW_END_OF_PARAS = 8
Allow carriage returns and paragraph breaks.
ALLOW_MATHS = 16
Allow maths.
ALLOW_COMMENTS = 32
Allow comments.
ALLOW_BLACKLINE = 64
Allow blacklining markers.
allow attribute
When extracting text, this value specifies what non-text content to allow. Possible values are in fFootnoteReference.AllowFlags.
allow
Access
read-write
Returns
int
firstShowString attribute
If the footnote reference is one of the list types, this LD show string will be used to generate the sequence number of the first paragraph to extract.
firstShowString
Access
read-write
Returns
String
group attribute
Which one of the 5 groups the footnote belongs. This value should be between 1 and 5.
group
Access
read-write
Returns
int
lastShowString attribute
If the footnote reference is one of the list types, this LD show string will be used to generate the sequence number of the last paragraph to extract.
lastShowString
Access
read-write
Returns
String
listStreamName attribute
If the footnote reference is one of the list types, this stream contains the paragraphs to be extracted.
listStreamName
Access
read-write
Returns
String
preferEarlyPlacement attribute
If true, the footnotes are placed as the rest of the page gets formatted.
preferEarlyPlacement
Access
read-write
Returns
boolean
setXML attribute
Sets the XML status of the footnote stream. Value is one of fFootnoteReference.XMLState
setXML
Access
read-write
Returns
int
showString attribute
The LD show string to create the text for the footnote reference.
showString
Access
read-write
Returns
String
streamHierarchy attribute
If the footnote reference is one of the inline types, this specifies which stream the footnote should be extracted from. 0 represents the main stream being formatted, positive values represent the number of child streams of the main stream, negative values represent the number of parents from the current stream.
streamHierarchy
Access
read-write
Returns
int
streamName attribute
The name of the stream to use for the new footnote, if required by the footnote type.
streamName
Access
read-write
Returns
String
terminatorString attribute
If the footnote reference is one of the inline types, this specifies the string that terminates the footnote text. If no teminator string is provided, the footnote will end when a footnote reference with type set to fFootnoteReference.TYPE_END is found.
terminatorString
Access
read-write
Returns
String
type attribute
The type of footnote to create. Value is one of fFootnoteReference.FootnoteType.
type
Access
read-write
Returns
int
fFootnoteReference method
Creates a new footnote reference.
fFootnoteReference group preferEarlyPlacement type streamName setXML showString terminatorString streamHierarchy listStreamName firstShowString lastShowString allow
Parameters
int group
[optional] Which one of the 10 groups the footnote belongs.
boolean preferEarlyPlacement
[optional] If true, the footnotes are placed as the rest of the page gets formatted.
int type
[optional] The type of footnote to create. Value is one of fFootnoteReference.FootnoteType.
fStream streamName
[optional] The name of the stream to use for the footnote, if required by the footnote type.
int setXML
[optional] Sets the XML status of the footnote stream. Value is one of fFootnoteReference.XMLState
String showString
[optional] The LD show string to create the text for the footnote reference.
String terminatorString
[optional] If the footnote reference is one of the inline types, this specifies the string that terminates the footnote text.
int streamHierarchy
[optional] If the footnote reference is one of the inline types, this specifies which stream the footnote should be extracted from. 0 represents the main stream being formatted, positive values represent the number of child streams of the main stream, negative values represent the number of parents from the current stream.
String listStreamName
[optional] If the footnote reference is one of the list types, this stream contains the paragraphs to be extracted.
String firstShowString
[optional] If the footnote reference is one of the list types, this LD show string will be used to generate the sequence number of the first paragraph to extract.
String lastShowString
[optional] If the footnote reference is one of the list types, this LD show string will be used to generate the sequence number of the last paragraph to extract.
int allow
[optional] When extracting text, this value specifies what non-text content to allow. Possible values are in fFootnoteReference.AllowFlags.
Returns
fFootnoteReference. A new object of class fFootnoteReference.
readResolve method
Return the object corresponding to the given serialized representation.
readResolve obj
Parameters
Object obj
The serialized representation.
Returns
fFootnoteReference. The object corresponding to the serialized representation.
toString method
Return the PI compatible string for the footnote reference.
toString
Parameters
None
Returns
String. A PI compatible representation of this footnote reference as a string.
Parent topic 
References
这对您有帮助吗?