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

NameTypeAccessDescription
bookmarkNameStringRead/WriteGets or sets the name of the bookmark that marks the portion of the document used to build the index.
numberOfColumnsStringRead/WriteGets or sets the number of columns per page used when building the index.
sequenceSeparatorStringRead/WriteGets or sets the character sequence that is used to separate sequence numbers and page numbers.
pageNumberSeparatorStringRead/WriteGets or sets the character sequence that is used to separate an index entry and its page number.
entryTypeStringRead/WriteGets or sets an index entry type used to build the index.
pageRangeSeparatorStringRead/WriteGets or sets the character sequence that is used to separate the start and end of a page range.
headingStringRead/WriteGets or sets a heading that appears at the start of each set of entries for any given letter.
crossReferenceSeparatorStringRead/WriteGets or sets the character sequence that is used to separate cross references and other entries.
pageNumberListSeparatorStringRead/WriteGets or sets the character sequence that is used to separate two page numbers in a page number list.
letterRangeStringRead/WriteGets or sets a range of letters to which limit the index.
runSubentriesOnSameLinebooleanRead/WriteGets or sets whether run subentries into the same line as the main entry.
sequenceNameStringRead/WriteGets or sets the name of a sequence whose number is included with the page number.
useYomibooleanRead/WriteGets or sets whether to enable the use of yomi text for index entries.
languageIdStringRead/WriteGets or sets the language ID used to generate the index.
fieldCodeStringReadReturns text between field start and field separator (or field end if there is no separator).
startFieldStartReadGets the node that represents the start of the field.
separatorFieldSeparatorReadGets the node that represents the field separator.
endFieldEndReadGets the node that represents the field end.
typeintReadGets the type.
resultStringRead/WriteGets or sets text that is between the field separator and field end.
displayResultStringReadGets the text that represents the displayed field result.
lockedbooleanRead/WriteGets or sets whether the field is locked (should not recalculate its result).
dirtybooleanRead/WriteGets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
formatFieldFormatReadGets a FieldFormat object that provides typed access to field’s formatting.
localeIdintRead/WriteGets or sets the LCID of the field.

Methods

SignatureDescription
getBookmarkName() → StringGets 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() → StringGets or sets the number of columns per page used when building the index.
setNumberOfColumns(value: String)Sets the number of columns value.
getSequenceSeparator() → StringGets or sets the character sequence that is used to separate sequence numbers and page numbers.
setSequenceSeparator(value: String)Sets the sequence separator value.
getPageNumberSeparator() → StringGets 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() → booleanGets a value indicating whether a page number separator is overridden through the field’s code.
getEntryType() → StringGets or sets an index entry type used to build the index.
setEntryType(value: String)Sets the entry type value.
getPageRangeSeparator() → StringGets 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() → StringGets 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() → StringGets 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() → StringGets 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() → StringGets or sets a range of letters to which limit the index.
setLetterRange(value: String)Sets the letter range value.
getRunSubentriesOnSameLine() → booleanGets 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() → StringGets or sets the name of a sequence whose number is included with the page number.
setSequenceName(value: String)Sets the sequence name value.
hasSequenceName() → booleanGets a value indicating whether a sequence should be used while the field’s result building.
getUseYomi() → booleanGets or sets whether to enable the use of yomi text for index entries.
setUseYomi(value: boolean)Sets the use yomi value.
getLanguageId() → StringGets or sets the language ID used to generate the index.
setLanguageId(value: String)Sets the language id value.
getFieldCode() → StringReturns text between field start and field separator (or field end if there is no separator).
getFieldCode(includeChildFieldCodes: boolean) → StringReturns text between field start and field separator (or field end if there is no separator).
remove() → NodeRemoves the field from the document.
update()Performs the field update.
update(ignoreMergeFormat: boolean)Performs a field update.
unlink() → booleanPerforms the field unlink.
getStart() → FieldStartGets the node that represents the start of the field.
getSeparator() → FieldSeparatorGets the node that represents the field separator.
getEnd() → FieldEndGets the node that represents the field end.
getType() → intReturns the type.
getResult() → StringGets or sets text that is between the field separator and field end.
setResult(value: String)Sets the result value.
getDisplayResult() → StringGets the text that represents the displayed field result.
isLocked() → booleanGets or sets whether the field is locked (should not recalculate its result).
isLocked(value: boolean)Calls isLocked(value) on this FieldIndex instance.
isDirty() → booleanGets 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() → FieldFormatGets a FieldFormat object that provides typed access to field’s formatting.
getLocaleId() → intGets or sets the LCID of the field.
setLocaleId(value: int)Sets the locale id value.

See Also