FOM 参照 > Formatting > References > fRunningHeaderReference interface
fRunningHeaderReference interface
Macro: trefhead
This object sets up a running header reference.
RunningHeaderReferenceGroups enumeration
The different groups available to store running headers in.
The RunningHeaderReferenceGroups enumeration has the following constants of type int.
GROUP_1 = 1
Group 1
GROUP_2 = 2
Group 2
GROUP_3 = 4
Group 3
GROUP_4 = 8
Group 4
GROUP_5 = 16
Group 5
GROUP_6 = 32
Group 6
GROUP_7 = 64
Group 7
GROUP_8 = 128
Group 8
GROUP_9 = 256
Group 9
GROUP_10 = 512
Group 10
RunningHeaderReferenceAllow enumeration
The different options available for allowing non-text content when generating the text for the running header.
The RunningHeaderReferenceAllow 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.
RunningHeaderReferenceHierarchy enumeration
Which stream in the formatting hierarchy to extract the text from.
The RunningHeaderReferenceHierarchy 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.
RunningHeaderReferenceItems enumeration
Specifies which items to extract.
The RunningHeaderReferenceItems enumeration has the following constants of type int.
EXTRACT_WORDS = 0
Extract words.
EXTRACT_CHARACTERS = 1
Extract single characters.
EXTRACT_YANK = 2
Extract text using the specified regular expression.
RunningHeaderText enumeration
Which header reference to access when displaying the running header.
The RunningHeaderText enumeration has the following constants of type int.
BROUGHT_FORWARD = 0
THe running header from the previous page.
FIRST_ON_PAGE = 1
The first reference on the page.
LAST_ON_PAGE = 2
The last reference on the page.
RunningHeaderBlank enumeration
What to do when the requested reference is blank.
The RunningHeaderBlank enumeration has the following constants of type int.
USE_PREVIOUS = 0
Use the previous reference.
LEAVE_BLANK = 1
Leave the running header blank.
RunningHeaderFirstOnPageRef enumeration
Where to find the "first on page" reference.
The RunningHeaderFirstOnPageRef enumeration has the following constants of type int.
ON_ANY_LINE = 0
The first reference can be on any line.
ON_FIRST_LINE = 1
The first reference can be on the first line only.
allow attribute
When extracting text, this value specifies what non-text content to allow. Possible values are in fRunningHeaderReference.RunningHeaderReferenceAllow.
allow
Access
read-write
Returns
int
characters attribute
If true and characters are being extracted, only alphanumeric characters are used.
characters
Access
read-write
Returns
boolean
extractText attribute
If true, the text used in the running header will be extracted from the content. Otherwise, the text will be taken from the value of the text property.
extractText
Access
read-write
Returns
boolean
groups attribute
The groups to store the running header text in. To specify multiple groups, it is possible to add together the values from fRunningHeaderReference.RunningHeaderReferenceGroups.
groups
Access
read-write
Returns
int
items attribute
When extracting text, this value specifies which items to extract. Possible values are in fRunningHeaderReference.RunningHeaderReferenceItems.
items
Access
read-write
Returns
int
name attribute
The name of the running header reference.
name
Access
read-write
Returns
String
numItems attribute
The number of items to extract.
numItems
Access
read-write
Returns
int
showText attribute
If true, the text used in the running header will be output at the current position. Otherwise, the text will be hidden.
showText
Access
read-write
Returns
boolean
streamHierarchy attribute
When extracting text, this value specifies which stream to extract content 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
text attribute
If the extractText property is false, this text value will be stored with the running header. If extractText is true and the Yank extraction is selected, this property should contain the regular expression to use.
text
Access
read-write
Returns
String
fRunningHeaderReference method
Creates a new running header reference.
fRunningHeaderReference name groups extractText showText text items numItems characters allow streamHierarchy
Parameters
String name
[optional] The name of the running header reference.
int groups
[optional] The groups to store the running header text in. To specify multiple groups, it is possible to add together the values from fRunningHeaderReference.RunningHeaderReferenceGroups.
boolean extractText
[optional] If true, the text used in the running header will be extracted from the content. Otherwise, the text will be taken from the value of the text property.
boolean showText
[optional] If true, the text used in the running header will be output at the current position. Otherwise, the text will be hidden.
String text
[optional] If the extractText property is false, this text value will be stored with the running header. If extractText is true and the Yank extraction is selected, this property should contain the regular expression to use.
int items
[optional] When extracting text, this value specifies which items to extract. Possible values are in fRunningHeaderReference.RunningHeaderReferenceItems.
int numItems
[optional] The number of items to extract.
boolean characters
[optional] If true and characters are being extracted, only alphanumeric characters are used.
int allow
[optional] When extracting text, this value specifies what non-text content to allow. Possible values are in fRunningHeaderReference.RunningHeaderReferenceAllow.
int streamHierarchy
[optional] When extracting text, this value specifies which stream to extract content 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.
Returns
fRunningHeaderReference. A new object of class fRunningHeaderReference.
readResolve method
Return the object corresponding to the given serialized representation.
readResolve obj
Parameters
Object obj
The serialized representation.
Returns
fRunningHeaderReference. The object corresponding to the serialized representation.
toString method
Return the PI compatible string for the running header reference.
toString
Parameters
None
Returns
String. A PI compatible representation of this running header reference as a string.
Parent topic 
References
これは役に立ちましたか?