FieldIndex
Overview
FieldIndex is a class in Aspose.Words FOSS for Java.
Inherits from: Field, IFieldCodeTokenInfoProvider.
Implements the INDEX field.
Edition status of its 71 listed members (a property and its accessor methods are listed separately, overloads once): 71 not yet exercised by a verified example.
This class declares 50 methods for FieldIndex objects in Java programs.
Available methods include: getBookmarkName, getCrossReferenceSeparator, getDisplayResult, getEnd, getEntryType, getFieldCode, getFormat, getHeading, getLanguageId, getLetterRange, getLocaleId, getNumberOfColumns, and 34 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: bookmarkName, crossReferenceSeparator, dirty, displayResult, end, entryType, and 19 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. |
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 | boolean | 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. |
useYomi | boolean | 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. |
fieldCode | String | Read | Returns text between field start and field separator (or field end if there is no separator). |
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 | int | Read | Gets the 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. |
locked | boolean | Read/Write | Gets or sets whether the field is locked (should not recalculate its result). |
dirty | boolean | 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 |
|---|---|
getBookmarkName() → String | Gets or sets the name of the bookmark that marks the portion of the document used to build the index. |
setBookmarkName(value: String) | Sets the bookmark name value. |
getNumberOfColumns() → String | Gets or sets the number of columns per page used when building the index. |
setNumberOfColumns(value: String) | Sets the number of columns value. |
getSequenceSeparator() → String | Gets or sets the character sequence that is used to separate sequence numbers and page numbers. |
setSequenceSeparator(value: String) | Sets the sequence separator value. |
getPageNumberSeparator() → String | Gets or sets the character sequence that is used to separate an index entry and its page number. |
setPageNumberSeparator(value: String) | Sets the page number separator value. |
hasPageNumberSeparator() → boolean | Gets a value indicating whether a page number separator is overridden through the field’s code. |
getEntryType() → String | Gets or sets an index entry type used to build the index. |
setEntryType(value: String) | Sets the entry type value. |
getPageRangeSeparator() → String | Gets or sets the character sequence that is used to separate the start and end of a page range. |
setPageRangeSeparator(value: String) | Sets the page range separator value. |
getHeading() → String | Gets or sets a heading that appears at the start of each set of entries for any given letter. |
setHeading(value: String) | Sets the heading value. |
getCrossReferenceSeparator() → String | Gets or sets the character sequence that is used to separate cross references and other entries. |
setCrossReferenceSeparator(value: String) | Sets the cross reference separator value. |
getPageNumberListSeparator() → String | Gets or sets the character sequence that is used to separate two page numbers in a page number list. |
setPageNumberListSeparator(value: String) | Sets the page number list separator value. |
getLetterRange() → String | Gets or sets a range of letters to which limit the index. |
setLetterRange(value: String) | Sets the letter range value. |
getRunSubentriesOnSameLine() → boolean | Gets or sets whether run subentries into the same line as the main entry. |
setRunSubentriesOnSameLine(value: boolean) | Sets the run subentries on same line value. |
getSequenceName() → String | Gets or sets the name of a sequence whose number is included with the page number. |
setSequenceName(value: String) | Sets the sequence name value. |
hasSequenceName() → boolean | Gets a value indicating whether a sequence should be used while the field’s result building. |
getUseYomi() → boolean | Gets or sets whether to enable the use of yomi text for index entries. |
setUseYomi(value: boolean) | Sets the use yomi value. |
getLanguageId() → String | Gets or sets the language ID used to generate the index. |
setLanguageId(value: String) | Sets the language id value. |
getFieldCode() → String | Returns text between field start and field separator (or field end if there is no separator). |
getFieldCode(includeChildFieldCodes: boolean) → String | Returns text between field start and field separator (or field end if there is no separator). |
remove() → Node | Removes the field from the document. |
update() | Performs the field update. |
update(ignoreMergeFormat: boolean) | Performs a field update. |
unlink() → boolean | Performs the field unlink. |
getStart() → FieldStart | Gets the node that represents the start of the field. |
getSeparator() → FieldSeparator | Gets the node that represents the field separator. |
getEnd() → FieldEnd | Gets the node that represents the field end. |
getType() → int | Returns the type. |
getResult() → String | Gets or sets text that is between the field separator and field end. |
setResult(value: String) | Sets the result value. |
getDisplayResult() → String | Gets the text that represents the displayed field result. |
isLocked() → boolean | Gets or sets whether the field is locked (should not recalculate its result). |
isLocked(value: boolean) | Calls isLocked(value) on this FieldIndex instance. |
isDirty() → boolean | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
isDirty(value: boolean) | Calls isDirty(value) on this FieldIndex instance. |
getFormat() → FieldFormat | Gets a FieldFormat object that provides typed access to field’s formatting. |
getLocaleId() → int | Gets or sets the LCID of the field. |
setLocaleId(value: int) | Sets the locale id value. |