FOM Reference > Content > Format Controls > fIndexItem interface
  
fIndexItem interface
This is the base object for the fIndexSimpleItem and fIndexAdvancedItem.
LocaleSortOrder enumeration
These constants define the case sensitivty when determining sort order using 'Locale Sorting'
The LocaleSortOrder enumeration has the following constants of type int.
LOCALE_NO_CASE = 0
The case of the sort key will be ignored.
LOCALE_UPPERCASE = 1
Upper case characters will be sorted ahead of lower case characters.
LOCALE_LOWERCASE = 2
Lower case characters will be sorted ahead of upper case characters.
SortMethods enumeration
These constants determine which sort method to use when sorting the generated index entries.
The SortMethods enumeration has the following constants of type int.
SORT_3B2 = 0
Sort index entries using the '3B2 Sorting' options.
SORT_LOCALE = 1
Sort index entries using the 'Locale Sorting' options
SORT_BOTH = 2
Sort index entries using the '3B2 Sorting' and 'Locale Sorting' options in combination.
GroupMask enumeration
These constants define the available groups to use for the index.
The GroupMask enumeration has the following constants of type int.
GROUP_1 = 1
The index will contain references using group 1.
GROUP_2 = 2
The index will contain references using group 2.
GROUP_3 = 4
The index will contain references using group 3.
GROUP_4 = 8
The index will contain references using group 4.
GROUP_5 = 16
The index will contain references using group 5.
IndexGenerationMode enumeration
These constants define the behaviour of index generation.
The IndexGenerationMode enumeration has the following constants of type int.
AFTER_FORMAT = 0
The index will be generated after the format pass is complete only.
ON_REFERENCE = 1
The index will be generated during the format process if it is referenced. If additional index references are added the stream will be (re)generated after the format process is complete.
ON_COMMAND = 2
The index will be generated during the format process when instructed by the buildindex macro. The index will not be (re)generated after the format is complete.
IgnoreCharacterModes enumeration
These constants define when special characters such as punctuation or symbols should be ignored.
The IgnoreCharacterModes enumeration has the following constants of type int.
IGNORE_CHAR_NONE = 0
Don't ignore characters of this type.
IGNORE_CHAR_ALL = 1
Ignore all characters of this type.
IGNORE_CHAR_START = 2
Only ignore characters of this type at the start, before any alpha-numeric characters.
IgnoreMarkupModes enumeration
These constants define when XML markup is ignored during index generation.
The IgnoreMarkupModes enumeration has the following constants of type int.
IGNORE_NONE = 0
Treat any XML markup as significant when processing the index reference.
IGNORE_SORT = 1
Only ignore XML markup in the index reference when sorting the index.
IGNORE_ALL = 2
Ignore XML markup in the index reference during sorting and grouping when generating the index.
generationMode attribute
This specifies the desired generation mode for the index. See fIndexItem.IndexGenerationMode.
generationMode
Access
read-write
Returns
int
groups attribute
The group(s) to determine which index references appear in this index.
groups
Access
read-write
Returns
int
ignoreExceptions attribute
A list of characters that should not be ignored if either fIndexItem.ignorePunctuation or fIndexItem.ignoreSymbols is set.
ignoreExceptions
Access
read-write
Returns
String
ignoreMarkup attribute
When sorting, should XML markup be ignored. Value is one of fIndexItem.IgnoreMarkupModes.
ignoreMarkup
Access
read-write
Returns
int
ignorePunctuation attribute
When sorting, should punctuation characters be ignored. Value is one of fIndexItem-IgnorePunctuationMode.
ignorePunctuation
Access
read-write
Returns
int
ignoreRefs attribute
When sorting, should references be ignored (e.g. &)
ignoreRefs
Access
read-write
Returns
boolean
ignoreSymbols attribute
When sorting, should symbol characters be ignored. Value is one of fIndexItem-IgnoreCharacterMode.
ignoreSymbols
Access
read-write
Returns
int
localeCaseOrder attribute
When sorting using the fIndexItem.SORT_LOCALE or fIndexIterm.SORT_BOTH, this value determine the behaviour of upper and lower case characters when sorting. See fIndexItem.LocaleSortOrder.
localeCaseOrder
Access
read-write
Returns
int
output attribute
This is the name of the output stream the generated index will be written to. If this is null, the stream will not be written. See fIndexTerm.GroupMask.
output
Access
read-write
Returns
String
saveFilename attribute
If specified, the index data used to generated the index will be saved to the specified file. Files generated in this manner can be used in the fIndex.includePaths.
saveFilename
Access
read-write
Returns
fPath
saveSorted attribute
If saving the index data, should it be sorted prior to saving.
saveSorted
Access
read-write
Returns
boolean
sortAsNumbers attribute
If false entries are sorted without consideration for contained numbers. i.e entry10 is sorted before entry2.
If true entries containing numbers will be sorted using the decimal representation of the number. i.e entry2 is sorted before entry10.
sortAsNumbers
Access
read-write
Returns
boolean
sortIndex attribute
If true the index will be sorted accoring to the specified sortMethod.
sortIndex
Access
read-write
Returns
boolean
sortMethod attribute
The sort method to use when sorting the index entries. See fIndexItem.SortMethods.
sortMethod
Access
read-write
Returns
int
sortingLocale attribute
When sorting using the fIndexItem.SORT_LOCALE or fIndexIterm.SORT_BOTH, this string determines the Locale rules to use when sorting.
sortingLocale
Access
read-write
Returns
String