Aspose::Words::Fields::FieldIndex class
Contents
[
Hide
]FieldIndex class
Implements the INDEX field. To learn more, visit the Working with Fields documentation article.
class FieldIndex : public Aspose::Words::Fields::Field,
public Aspose::Words::Fields::IFieldCodeTokenInfoProvider
Methods
| Method | Description |
|---|---|
| get_BookmarkName() | Gets the name of the bookmark that marks the portion of the document used to build the index. |
| get_CrossReferenceSeparator() | Gets the character sequence that is used to separate cross references and other entries. |
| get_DisplayResult() | Gets the text that represents the displayed field result. |
| get_End() const | Gets the node that represents the field end. |
| get_EntryType() | Gets an index entry type used to build the index. |
| get_FieldEnd() const | Gets the node that represents the field end. |
| get_FieldStart() const | Gets the node that represents the start of the field. |
| get_Format() | Gets a FieldFormat object that provides typed access to field’s formatting. |
| get_HasPageNumberSeparator() | Gets a value indicating whether a page number separator is overridden through the field’s code. |
| get_HasSequenceName() | Gets a value indicating whether a sequence should be used while the field’s result building. |
| get_Heading() | Gets a heading that appears at the start of each set of entries for any given letter. |
| get_IsDirty() | Gets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
| get_IsLocked() | Gets or sets whether the field is locked (should not recalculate its result). |
| get_LanguageId() | Gets the language ID used to generate the index. |
| get_LetterRange() | Gets a range of letters to which limit the index. |
| get_LocaleId() | Gets or sets the LCID of the field. |
| get_NumberOfColumns() | Gets the number of columns per page used when building the index. |
| get_PageNumberListSeparator() | Gets the character sequence that is used to separate two page numbers in a page number list. |
| get_PageNumberSeparator() | Gets the character sequence that is used to separate an index entry and its page number. |
| get_PageRangeSeparator() | Gets the character sequence that is used to separate the start and end of a page range. |
| get_Result() | Gets or sets text that is between the field separator and field end. |
| get_RunSubentriesOnSameLine() | Gets whether run subentries into the same line as the main entry. |
| get_Separator() | Gets the node that represents the field separator. Can be null. |
| get_SequenceName() | Gets the name of a sequence whose number is included with the page number. |
| get_SequenceSeparator() | Gets the character sequence that is used to separate sequence numbers and page numbers. |
| get_Start() const | Gets the node that represents the start of the field. |
| virtual get_Type() const | Gets the Microsoft Word field type. |
| get_UseYomi() | Gets whether to enable the use of yomi text for index entries. |
| 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(bool) | Returns text between field start and field separator (or field end if there is no separator). |
| GetType() const override | |
| Is(const System::TypeInfo&) const override | |
| 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(const System::String&) | Sets the name of the bookmark that marks the portion of the document used to build the index. |
| set_CrossReferenceSeparator(const System::String&) | Sets the character sequence that is used to separate cross references and other entries. |
| set_EntryType(const System::String&) | Sets an index entry type used to build the index. |
| set_Heading(const System::String&) | Sets a heading that appears at the start of each set of entries for any given letter. |
| set_IsDirty(bool) | Sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
| set_IsLocked(bool) | Setter for Aspose::Words::Fields::Field::get_IsLocked. |
| set_LanguageId(const System::String&) | Sets the language ID used to generate the index. |
| set_LetterRange(const System::String&) | Sets a range of letters to which limit the index. |
| set_LocaleId(int32_t) | Setter for Aspose::Words::Fields::Field::get_LocaleId. |
| set_NumberOfColumns(const System::String&) | Sets the number of columns per page used when building the index. |
| set_PageNumberListSeparator(const System::String&) | Sets the character sequence that is used to separate two page numbers in a page number list. |
| set_PageNumberSeparator(const System::String&) | Sets the character sequence that is used to separate an index entry and its page number. |
| set_PageRangeSeparator(const System::String&) | Sets the character sequence that is used to separate the start and end of a page range. |
| set_Result(const System::String&) | Setter for Aspose::Words::Fields::Field::get_Result. |
| set_RunSubentriesOnSameLine(bool) | Sets whether run subentries into the same line as the main entry. |
| set_SequenceName(const System::String&) | Sets the name of a sequence whose number is included with the page number. |
| set_SequenceSeparator(const System::String&) | Sets the character sequence that is used to separate sequence numbers and page numbers. |
| set_UseYomi(bool) | Sets whether to enable the use of yomi text for index entries. |
| static Type() | |
| Unlink() | Performs the field unlink. |
| Update() | Performs the field update. Throws if the field is being updated already. |
| Update(bool) | Performs a field update. Throws if the field is being updated already. |
See Also
- Class Field
- Namespace Aspose::Words::Fields
- Library Aspose.Words for C++