## FieldIndex class Implements the INDEX field. To learn more, visit the [Working with Fields](https://docs.aspose.com/words/cpp/working-with-fields/) documentation article. ```cpp class FieldIndex : public Aspose::Words::Fields::Field, public IFieldCodeTokenInfoProvider ``` ## Methods | Method | Description | | --- | --- | | [get_BookmarkName](./get_bookmarkname/)() | Gets or sets the name of the bookmark that marks the portion of the document used to build the index. | | [get_CrossReferenceSeparator](./get_crossreferenceseparator/)() | Gets or sets the character sequence that is used to separate cross references and other entries. | | [get_DisplayResult](../field/get_displayresult/)() | Gets the text that represents the displayed field result. | | [get_End](../field/get_end/)() const | Gets the node that represents the field end. | | [get_EntryType](./get_entrytype/)() | Gets or sets an index entry type used to build the index. | | [get_FieldEnd](../field/get_fieldend/)() const | Gets the node that represents the field end. | | [get_FieldStart](../field/get_fieldstart/)() const | Gets the node that represents the start of the field. | | [get_Format](../field/get_format/)() | Gets a [FieldFormat](../fieldformat/) object that provides typed access to field's formatting. | | [get_HasPageNumberSeparator](./get_haspagenumberseparator/)() | Gets a value indicating whether a page number separator is overridden through the field's code. | | [get_HasSequenceName](./get_hassequencename/)() | Gets a value indicating whether a sequence should be used while the field's result building. | | [get_Heading](./get_heading/)() | Gets or sets a heading that appears at the start of each set of entries for any given letter. | | [get_IsDirty](../field/get_isdirty/)() | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. | | [get_IsLocked](../field/get_islocked/)() | Gets or sets whether the field is locked (should not recalculate its result). | | [get_LanguageId](./get_languageid/)() | Gets or sets the language ID used to generate the index. | | [get_LetterRange](./get_letterrange/)() | Gets or sets a range of letters to which limit the index. | | [get_LocaleId](../field/get_localeid/)() | Gets or sets the LCID of the field. | | [get_NumberOfColumns](./get_numberofcolumns/)() | Gets or sets the number of columns per page used when building the index. | | [get_PageNumberListSeparator](./get_pagenumberlistseparator/)() | Gets or sets the character sequence that is used to separate two page numbers in a page number list. | | [get_PageNumberSeparator](./get_pagenumberseparator/)() | Gets or sets the character sequence that is used to separate an index entry and its page number. | | [get_PageRangeSeparator](./get_pagerangeseparator/)() | Gets or sets the character sequence that is used to separate the start and end of a page range. | | [get_Result](../field/get_result/)() | Gets or sets text that is between the field separator and field end. | | [get_RunSubentriesOnSameLine](./get_runsubentriesonsameline/)() | Gets or sets whether run subentries into the same line as the main entry. | | [get_Separator](../field/get_separator/)() | Gets the node that represents the field separator. Can be **null**. | | [get_SequenceName](./get_sequencename/)() | Gets or sets the name of a sequence whose number is included with the page number. | | [get_SequenceSeparator](./get_sequenceseparator/)() | Gets or sets the character sequence that is used to separate sequence numbers and page numbers. | | [get_Start](../field/get_start/)() const | Gets the node that represents the start of the field. | | virtual [get_Type](../field/get_type/)() const | Gets the Microsoft Word field type. | | [get_UseYomi](./get_useyomi/)() | Gets whether to enable the use of yomi text for index entries. | | [GetFieldCode](../field/getfieldcode/)() | Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included. | | [GetFieldCode](../field/getfieldcode/)(bool) | Returns text between field start and field separator (or field end if there is no separator). | | [GetType](./gettype/)() const override | | | [Is](./is/)(const System::TypeInfo\&) const override | | | virtual [Remove](../field/remove/)() | Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns **null**. | | [set_BookmarkName](./set_bookmarkname/)(const System::String\&) | Setter for [Aspose::Words::Fields::FieldIndex::get_BookmarkName](./get_bookmarkname/). | | [set_CrossReferenceSeparator](./set_crossreferenceseparator/)(const System::String\&) | Setter for [Aspose::Words::Fields::FieldIndex::get_CrossReferenceSeparator](./get_crossreferenceseparator/). | | [set_EntryType](./set_entrytype/)(const System::String\&) | Setter for [Aspose::Words::Fields::FieldIndex::get_EntryType](./get_entrytype/). | | [set_Heading](./set_heading/)(const System::String\&) | Setter for [Aspose::Words::Fields::FieldIndex::get_Heading](./get_heading/). | | [set_IsDirty](../field/set_isdirty/)(bool) | Setter for [Aspose::Words::Fields::Field::get_IsDirty](../field/get_isdirty/). | | [set_IsLocked](../field/set_islocked/)(bool) | Setter for [Aspose::Words::Fields::Field::get_IsLocked](../field/get_islocked/). | | [set_LanguageId](./set_languageid/)(const System::String\&) | Setter for [Aspose::Words::Fields::FieldIndex::get_LanguageId](./get_languageid/). | | [set_LetterRange](./set_letterrange/)(const System::String\&) | Setter for [Aspose::Words::Fields::FieldIndex::get_LetterRange](./get_letterrange/). | | [set_LocaleId](../field/set_localeid/)(int32_t) | Setter for [Aspose::Words::Fields::Field::get_LocaleId](../field/get_localeid/). | | [set_NumberOfColumns](./set_numberofcolumns/)(const System::String\&) | Setter for [Aspose::Words::Fields::FieldIndex::get_NumberOfColumns](./get_numberofcolumns/). | | [set_PageNumberListSeparator](./set_pagenumberlistseparator/)(const System::String\&) | Setter for [Aspose::Words::Fields::FieldIndex::get_PageNumberListSeparator](./get_pagenumberlistseparator/). | | [set_PageNumberSeparator](./set_pagenumberseparator/)(const System::String\&) | Setter for [Aspose::Words::Fields::FieldIndex::get_PageNumberSeparator](./get_pagenumberseparator/). | | [set_PageRangeSeparator](./set_pagerangeseparator/)(const System::String\&) | Setter for [Aspose::Words::Fields::FieldIndex::get_PageRangeSeparator](./get_pagerangeseparator/). | | [set_Result](../field/set_result/)(const System::String\&) | Setter for [Aspose::Words::Fields::Field::get_Result](../field/get_result/). | | [set_RunSubentriesOnSameLine](./set_runsubentriesonsameline/)(bool) | Setter for [Aspose::Words::Fields::FieldIndex::get_RunSubentriesOnSameLine](./get_runsubentriesonsameline/). | | [set_SequenceName](./set_sequencename/)(const System::String\&) | Setter for [Aspose::Words::Fields::FieldIndex::get_SequenceName](./get_sequencename/). | | [set_SequenceSeparator](./set_sequenceseparator/)(const System::String\&) | Setter for [Aspose::Words::Fields::FieldIndex::get_SequenceSeparator](./get_sequenceseparator/). | | [set_UseYomi](./set_useyomi/)(bool) | Sets whether to enable the use of yomi text for index entries. | | static [Type](./type/)() | | | [Unlink](../field/unlink/)() | Performs the field unlink. | | [Update](../field/update/)() | Performs the field update. Throws if the field is being updated already. | | [Update](../field/update/)(bool) | Performs a field update. Throws if the field is being updated already. | ## Examples Shows how to create an INDEX field, and then use XE fields to populate it with entries. ```cpp auto doc = System::MakeObject(); auto builder = System::MakeObject(doc); // Create an INDEX field which will display an entry for each XE field found in the document. // Each entry will display the XE field's Text property value on the left side // and the page containing the XE field on the right. // If the XE fields have the same value in their "Text" property, // the INDEX field will group them into one entry. auto index = System::ExplicitCast(builder->InsertField(FieldType::FieldIndex, true)); // Configure the INDEX field only to display XE fields that are within the bounds // of a bookmark named "MainBookmark", and whose "EntryType" properties have a value of "A". // For both INDEX and XE fields, the "EntryType" property only uses the first character of its string value. index->set_BookmarkName(u"MainBookmark"); index->set_EntryType(u"A"); ASSERT_EQ(u" INDEX \\b MainBookmark \\f A", index->GetFieldCode()); // On a new page, start the bookmark with a name that matches the value // of the INDEX field's "BookmarkName" property. builder->InsertBreak(BreakType::PageBreak); builder->StartBookmark(u"MainBookmark"); // The INDEX field will pick up this entry because it is inside the bookmark, // and its entry type also matches the INDEX field's entry type. auto indexEntry = System::ExplicitCast(builder->InsertField(FieldType::FieldIndexEntry, true)); indexEntry->set_Text(u"Index entry 1"); indexEntry->set_EntryType(u"A"); ASSERT_EQ(u" XE \"Index entry 1\" \\f A", indexEntry->GetFieldCode()); // Insert an XE field that will not appear in the INDEX because the entry types do not match. builder->InsertBreak(BreakType::PageBreak); indexEntry = System::ExplicitCast(builder->InsertField(FieldType::FieldIndexEntry, true)); indexEntry->set_Text(u"Index entry 2"); indexEntry->set_EntryType(u"B"); // End the bookmark and insert an XE field afterwards. // It is of the same type as the INDEX field, but will not appear // since it is outside the bookmark's boundaries. builder->EndBookmark(u"MainBookmark"); builder->InsertBreak(BreakType::PageBreak); indexEntry = System::ExplicitCast(builder->InsertField(FieldType::FieldIndexEntry, true)); indexEntry->set_Text(u"Index entry 3"); indexEntry->set_EntryType(u"A"); doc->UpdatePageLayout(); doc->UpdateFields(); doc->Save(get_ArtifactsDir() + u"Field.INDEX.XE.Filtering.docx"); ``` Shows how to populate an INDEX field with entries using XE fields, and also modify its appearance. ```cpp auto doc = System::MakeObject(); auto builder = System::MakeObject(doc); // Create an INDEX field which will display an entry for each XE field found in the document. // Each entry will display the XE field's Text property value on the left side, // and the number of the page that contains the XE field on the right. // If the XE fields have the same value in their "Text" property, // the INDEX field will group them into one entry. auto index = System::ExplicitCast(builder->InsertField(FieldType::FieldIndex, true)); index->set_LanguageId(u"1033"); // Setting this property's value to "A" will group all the entries by their first letter, // and place that letter in uppercase above each group. index->set_Heading(u"A"); // Set the table created by the INDEX field to span over 2 columns. index->set_NumberOfColumns(u"2"); // Set any entries with starting letters outside the "a-c" character range to be omitted. index->set_LetterRange(u"a-c"); ASSERT_EQ(u" INDEX \\z 1033 \\h A \\c 2 \\p a-c", index->GetFieldCode()); // These next two XE fields will show up under the "A" heading, // with their respective text stylings also applied to their page numbers. builder->InsertBreak(BreakType::PageBreak); auto indexEntry = System::ExplicitCast(builder->InsertField(FieldType::FieldIndexEntry, true)); indexEntry->set_Text(u"Apple"); indexEntry->set_IsItalic(true); ASSERT_EQ(u" XE Apple \\i", indexEntry->GetFieldCode()); builder->InsertBreak(BreakType::PageBreak); indexEntry = System::ExplicitCast(builder->InsertField(FieldType::FieldIndexEntry, true)); indexEntry->set_Text(u"Apricot"); indexEntry->set_IsBold(true); ASSERT_EQ(u" XE Apricot \\b", indexEntry->GetFieldCode()); // Both the next two XE fields will be under a "B" and "C" heading in the INDEX fields table of contents. builder->InsertBreak(BreakType::PageBreak); indexEntry = System::ExplicitCast(builder->InsertField(FieldType::FieldIndexEntry, true)); indexEntry->set_Text(u"Banana"); builder->InsertBreak(BreakType::PageBreak); indexEntry = System::ExplicitCast(builder->InsertField(FieldType::FieldIndexEntry, true)); indexEntry->set_Text(u"Cherry"); // INDEX fields sort all entries alphabetically, so this entry will show up under "A" with the other two. builder->InsertBreak(BreakType::PageBreak); indexEntry = System::ExplicitCast(builder->InsertField(FieldType::FieldIndexEntry, true)); indexEntry->set_Text(u"Avocado"); // This entry will not appear because it starts with the letter "D", // which is outside the "a-c" character range that the INDEX field's LetterRange property defines. builder->InsertBreak(BreakType::PageBreak); indexEntry = System::ExplicitCast(builder->InsertField(FieldType::FieldIndexEntry, true)); indexEntry->set_Text(u"Durian"); doc->UpdatePageLayout(); doc->UpdateFields(); doc->Save(get_ArtifactsDir() + u"Field.INDEX.XE.Formatting.docx"); ``` ## See Also * Class [Field](../field/) * Namespace [Aspose::Words::Fields](../) * Library [Aspose.Words for C++](../../)