FOM Reference > Content > Format Controls > fIndex interface
  
fIndex interface
This object represents the primary interface for the Index control stream in PTC ALD.
This object inherits from fControl.
includePaths attribute
The array of additional include paths for index data to be incorporated when generating new indexes. This data must have been saved from a previous index generation pass.
includePaths
Access
read-only
Returns
DOMString[]
indexes attribute
The array of indexes to generate.
indexes
Access
read-only
Returns
fArray
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. These values are only used if fIndex.optimize is true
numberFormats
Access
read-only
Returns
DOMString[]
optimize attribute
If true, PTC ALD will modify it's behaviour to optimise its speed any memory footprint. Use of this option will result in PTC ALD resolving the page number for index entries at the end of the page rather than at index creation (usually end of document).
optimize
Access
read-write
Returns
boolean
addItem method
Add a new fIndexItem to the indexes array.
addItemindexItem
Parameters
fIndexItemindexItem
The index item to add to the indexes array. If this value is null or undefined, a new fIndexSimpleItem object will be created.
Returns
fIndexItem. The newly created fIndexItem object contained in the indexes array.
clearItems method
Removes all index items from the indexes array.
clearItems
Parameters
None
Returns
void. None.
removeItem method
Removes the specified index item from the indexes array.
removeItemindexItem
Parameters
fIndexItemindexItem
The index item to remove from the indexes array.
Returns
void. None.