FOM Reference > Content > Format Controls > fIndexAdvancedItem interface
  
fIndexAdvancedItem interface
Macro: tindmkxml
This is the index item to control the generation of the Advanced XML index structure.
This object inherits from fIndexItem.
GroupControlNames enumeration
A set of default group control stream names, as contained in the "sidxgrp.3ad" system file. Any other custom or user-defined group controls are still available to be used, but should be accessed directly by name.
The GroupControlNames enumeration has the following constants of type DOMString.
GROUP_DEFAULT = "_grp_default"
The default grouping control.
GROUP_AR = "_grp_ar"
Arabic grouping control.
GROUP_BG = "_grp_bg"
Bulgarian grouping control.
GROUP_CS = "_grp_cs"
Czech grouping control.
GROUP_DA = "_grp_da"
Danish grouping control.
GROUP_DE = "_grp_de"
German grouping control.
GROUP_en = "_grp_en"
English grouping control.
GROUP_EL = "_grp_el"
Greek grouping control.
GROUP_ES = "_grp_es"
spanish grouping control.
GROUP_ET = "_grp_et"
Estonian grouping control.
GROUP_FI = "_grp_fi"
Finnish grouping control.
GROUP_FR = "_grp_fr"
French grouping control.
GROUP_HE = "_grp_he"
Hebrew grouping control.
GROUP_HR = "_grp_hr"
Croatian grouping control.
GROUP_HU = "_grp_hu"
Hungarian grouping control.
GROUP_IS = "_grp_is"
Icelandic grouping control.
GROUP_IT = "_grp_it"
Italian grouping control.
GROUP_JA_HIRA = "_grp_ja_hira"
Japanese Hiragana grouping control.
GROUP_JA_KATA = "_grp_ja_kata"
Japanese Katakana grouping control.
GROUP_KO = "_grp_ko"
Korean grouping control.
GROUP_LT = "_grp_lt"
Lithuanian grouping control.
GROUP_LV = "_grp_lv"
Latvian grouping control.
GROUP_MT = "_grp_mt"
Maltese grouping control.
GROUP_NL = "_grp_nl"
Dutch grouping control.
GROUP_NO = "_grp_no"
Norwegian grouping control.
GROUP_PL = "_grp_pl"
Polish grouping control.
GROUP_PT = "_grp_pt"
Portuguese grouping control.
GROUP_RO = "_grp_ro"
Romanian grouping control.
GROUP_RU = "_grp_ru"
Russian grouping control.
GROUP_SK = "_grp_sk"
Slovakian grouping control.
GROUP_SL = "_grp_sl"
Slovenian grouping control.
GROUP_SV = "_grp_sv"
Swedish grouping control.
GROUP_TH = "_grp_th"
Thai grouping control.
GROUP_TR = "_grp_tr"
Turkish grouping control.
GROUP_ZH = "_grp_zh"
Simplified Chinese grouping control.
GROUP_ZH_TW = "_grp_zh_TW"
Traditional Chinese grouping control.
alphaElement attribute
This is the name of the XML element used by groups marked as alpha.
alphaElement
Access
read-write
Returns
String
entryFreeFormElement attribute
This is the name of the XML element to wrap a free format entry, as set by fIndexReference.FORMAT_CUSTOM.
entryFreeFormElement
Access
read-write
Returns
String
entryHeadingElement attribute
This is the name of the XML element to wrap the text for the level. If not specified, the text will be added to the the level element.
entryHeadingElement
Access
read-write
Returns
String
entryLocationElement attribute
This is the name of the XML element to wrap the page and toPage elements. If not specified, pageElement and toPageElements will be added to the level element. This element is related to fIndexSimpleItem.firstNumberCallout.
entryLocationElement
Access
read-write
Returns
String
entryPageAttribute attribute
This is the name of the attribute to store the page number in on the entryPageElement. If this is empty, the page number will be added as a child text node.
entryPageAttribute
Access
read-write
Returns
String
entryPageBookmark attribute
This is the name of the attribute to store the name of the bookmark link on the entryPageElement if entryPageAttribute is set and the index reference has a bookmark specified. This value defaults to "link". If entryPageAttribute is not set, the bookmark will be inserted as a PI surrounding the text content.
entryPageBookmark
Access
read-write
Returns
String
entryPageElement attribute
This is the name of the XML element to wrap the output of a single page number, it will be added to the entryLocationElement if present. This element is related to fIndexSimpleItem.numberSeparator.
entryPageElement
Access
read-write
Returns
String
entrySeeAlsoElement attribute
This is the name of the XML element to wrap a 'See Also' entry using the 'See' text specified in the reference which is added to the level element. This element is related to fIndexSimpleItem.seeAlsoText.
entrySeeAlsoElement
Access
read-write
Returns
String
entrySeeElement attribute
This is the name of the XML element to wrap a 'See' entry using the 'See' text specified in the reference which is added to the level element. This element is related to fIndexSimpleItem.seeText.
entrySeeElement
Access
read-write
Returns
String
entryToPageElement attribute
This is the name of the XML element to wrap the output of the page number signifying the end of a contiguous range, it will be added to the entryLocationElement if present. This element is related to fIndexSimpleItem.rangeSeparator.
entryToPageElement
Access
read-write
Returns
String
groupHeadingElement attribute
This is the name of the XML element used to contain the group's heading.
groupHeadingElement
Access
read-write
Returns
String
groupingControl attribute
This is the name of the 'Grouping Control Stream'. This is used to determine which group index entries appear. see fIndexAdvancedItem.GroupControlNames for predefined streams.
groupingControl
Access
read-write
Returns
String
levelElements attribute
These (up to 5) level elements names are used to create elements which contain the information for each level of an index entry.
levelElements
Access
read-write
Returns
fStringArray
nestLevels attribute
When true, the elements specifying each level will be nested.
nestLevels
Access
read-write
Returns
boolean
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. The output is used with the pageElement or toPageElement as apporpriate.
numberFormats
Access
read-write
Returns
fStringArray
postAlphaElement attribute
This is the name of the XML element used by groups marked as postalpha.
postAlphaElement
Access
read-write
Returns
String
preAlphaElement attribute
This is the name of the XML element used by groups marked as prealpha.
preAlphaElement
Access
read-write
Returns
String
rootNode attribute
This is the name of the XML root node.
rootNode
Access
read-write
Returns
String
useGroupHeadings attribute
When true, add the group heading element to the group.
useGroupHeadings
Access
read-write
Returns
boolean
useGrouping attribute
If sortIndex is true, and useGrouping is true, the generated index will group the index entries as specified.
useGrouping
Access
read-write
Returns
boolean
useRawText attribute
When false, all text strings are written to the output stream are encoded as necessary to preserve the XML structure. i.e. & becomes &amp;, < becomes &lt;, etc..
When true all text strings generated will be written unencoded. This allows additional structure to be embeded within the text fields, it is the users responsibility to ensure the serialized XML is valid.
useRawText
Access
read-write
Returns
boolean
xmlScope attribute
Only include index references that were found at the specified location path. This property works in combination with fIndexItem.groups. If not specified, isn't a valid location path, or the document isn't valid xml, then this property will be ignored.
xmlScope
Access
read-write
Returns
String
xsltControl attribute
If present, the stream will be used to transform the generated XML index, the results will be written to the output stream. If not present the generated XML will be serialized as is.
xsltControl
Access
read-write
Returns
fStream
xsltParameters attribute
If present, this stream will be used to pass additional parameters with the transform process.
xsltParameters
Access
read-write
Returns
fStream
fIndexAdvancedItem method
Create a new fIndexAdvancedItem object.
fIndexAdvancedItem
Parameters
None
Returns
fIndexAdvancedItem. The newly created object.
readResolve method
Return the object corresponding to the given serialized representation.
readResolveobj
Parameters
Objectobj
The serialized representation.
Returns
fIndexAdvancedItem. The object corresponding to the serialized representation.