FOM Reference > Content > Format Controls > fIndexSimpleItem interface
  
fIndexSimpleItem interface
Macro: tindmk.
This is the index item to control the generation of the simple index structure.
This object inherits from fIndexItem.
firstNumberCallout attribute
This is the desired text to be output between the index entries text and the first page number.
firstNumberCallout
Access
read-write
Returns
String
joinSeparator attribute
This is the string to use when index entry can have its levels combined. e.g. entry, secondary
joinSeparator
Access
read-write
Returns
String
letterHeadingStyle attribute
If present and useLetterHeading is true, this name will be added to the output before the heading letter.
letterHeadingStyle
Access
read-write
Returns
String
levelStyles attribute
These (up to 5) level styles are used before the appropriate text for each level of the index entry generated index.
levelStyles
Access
read-write
Returns
fStringArray
numberFormats attribute
These (up to 10) format strings are used to generate the appropriate output for the index entry as defined by the index reference.
numberFormats
Access
read-write
Returns
fStringArray
numberSeparator attribute
This is the desired string to use between non-contiguous page numbers.
numberSeparator
Access
read-write
Returns
String
rangeSeparator attribute
This is the desired string to use between page numbers when the index entry is present on each page in the range (i.e. they're contiguous).
rangeSeparator
Access
read-write
Returns
String
seeAlsoText attribute
This is the string to use when a 'See Also' entry is created, this is used before the 'See' text specified in the reference.
seeAlsoText
Access
read-write
Returns
String
seeText attribute
This is the string to use between the index term and the 'See' text specified in the reference.
seeText
Access
read-write
Returns
String
suppressUpDown attribute
When generating the page number output, should the <?up> and <?down> PIs be suppressed. If false, the PIs will be present.
suppressUpDown
Access
read-write
Returns
boolean
useLetterHeadings attribute
When generating the index, should a letter heading be added for each initial character.
useLetterHeadings
Access
read-write
Returns
boolean
useXML attribute
When generating the index, should a letter heading be added for each initial character.
useXML
Access
read-write
Returns
boolean
fIndexSimpleItem method
Create a new fIndexSimpleItem object.
fIndexSimpleItem
Parameters
None
Returns
fIndexSimpleItem. The newly created object.
readResolve method
Return the object corresponding to the given serialized representation.
readResolveobj
Parameters
Objectobj
The serialized representation.
Returns
fIndexSimpleItem. The object corresponding to the serialized representation.