FieldIndex
Overview
FieldIndex is a class in Aspose.Words FOSS for .NET.
Inherits from: Field, IFieldCodeTokenInfoProvider.
Implements the INDEX field.
This class provides 4 methods for working with FieldIndex objects in .NET programs.
Available methods include: GetFieldCode, Remove, Unlink, Update.
All public members are accessible to any .NET application after installing the Aspose.Words FOSS for .NET package.
Properties: BookmarkName, CrossReferenceSeparator, DisplayResult, End, EntryType, Format, and 20 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
BookmarkName | string | Read/Write | Gets or sets the name of the bookmark that marks the portion of the document used to build the index. |
NumberOfColumns | string | Read/Write | Gets or sets the number of columns per page used when building the index. |
SequenceSeparator | string | Read/Write | Gets or sets the character sequence that is used to separate sequence numbers and page numbers. |
PageNumberSeparator | string | Read/Write | Gets or sets the character sequence that is used to separate an index entry and its page number. |
HasPageNumberSeparator | bool | Read | Gets a value indicating whether a page number separator is overridden through the field’s code. |
EntryType | string | Read/Write | Gets or sets an index entry type used to build the index. |
PageRangeSeparator | string | Read/Write | Gets or sets the character sequence that is used to separate the start and end of a page range. |
Heading | string | Read/Write | Gets or sets a heading that appears at the start of each set of entries for any given letter. |
CrossReferenceSeparator | string | Read/Write | Gets or sets the character sequence that is used to separate cross references and other entries. |
PageNumberListSeparator | string | Read/Write | Gets or sets the character sequence that is used to separate two page numbers in a page number list. |
LetterRange | string | Read/Write | Gets or sets a range of letters to which limit the index. |
RunSubentriesOnSameLine | bool | Read/Write | Gets or sets whether run subentries into the same line as the main entry. |
SequenceName | string | Read/Write | Gets or sets the name of a sequence whose number is included with the page number. |
HasSequenceName | bool | Read | Gets a value indicating whether a sequence should be used while the field’s result building. |
UseYomi | bool | Read/Write | Gets or sets whether to enable the use of yomi text for index entries. |
LanguageId | string | Read/Write | Gets or sets the language ID used to generate the index. |
Start | FieldStart | Read | Gets the node that represents the start of the field. |
Separator | FieldSeparator | Read | Gets the node that represents the field separator. |
End | FieldEnd | Read | Gets the node that represents the field end. |
Type | FieldType | Read | Gets the Microsoft Word field type. |
Result | string | Read/Write | Gets or sets text that is between the field separator and field end. |
DisplayResult | string | Read | Gets the text that represents the displayed field result. |
IsLocked | bool | Read/Write | Gets or sets whether the field is locked (should not recalculate its result). |
IsDirty | bool | Read/Write | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
Format | FieldFormat | Read | Gets a FieldFormat object that provides typed access to field’s formatting. |
LocaleId | int | Read/Write | Gets or sets the LCID of the field. |
Methods
| Signature | Description |
|---|---|
GetFieldCode() | Returns text between field start and field separator (or field end if there is no separator). |
Remove() | Removes the field from the document. |
Update() | Performs the field update. |
Unlink() | Performs the field unlink. |