IndexEntry Element

Publish

Platform_KC
On Premises

Description

Index Entry Icon
An Index Entry object represents a single entry in an index. Each Index Entry object contains relationships to a number of other objects. These entries are then organized into a hierarchical outline in an Index object to represent the structure for that particular index.

The IndexEntry element represents an Author-it Index Entry object, and contains all of its properties.

Attributes

Attribute Name

Optional

Data Type

Values

wordcount

Yes

Integer

>= 0

Parent Element

Objects

Children

Element

Optional

Object

No

Targets

Yes

PrintEntryText

Yes

HelpEntryText

Yes

HelpMacro

Yes

WebEntryText

Yes

Sample XML

<IndexEntry>
+ <Object>
+ <Targets>
- <Relation>
<ID>594</ID>
</Relation>
- <Relation>
<ID>180</ID>
</Relation>
</Targets>
<PrintEntryText>Find</PrintEntryText>
<HelpEntryText>Find</HelpEntryText>
<HelpMacro inherited="true">0</HelpMacro>
<WebEntryText>Find</WebEntryText>
</IndexEntry>