FieldToa

Overview

FieldToa is a class in Aspose.Words FOSS for Java. Inherits from: Field, IFieldCodeTokenInfoProvider.

Implements the TOA field.

Edition status of its 57 listed members (a property and its accessor methods are listed separately, overloads once): 57 not yet exercised by a verified example.

This class declares 40 methods for FieldToa objects in Java programs. Available methods include: getBookmarkName, getDisplayResult, getEnd, getEntryCategory, getEntrySeparator, getFieldCode, getFormat, getLocaleId, getPageNumberListSeparator, getPageRangeSeparator, getRemoveEntryFormatting, getResult, and 24 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: bookmarkName, dirty, displayResult, end, entryCategory, entrySeparator, and 15 more.

Properties

NameTypeAccessDescription
bookmarkNameStringRead/WriteGets or sets the name of the bookmark that marks the portion of the document used to build the table.
entryCategoryStringRead/WriteGets or sets the integral category for entries included in the table.
sequenceSeparatorStringRead/WriteGets or sets the character sequence that is used to separate sequence numbers and page numbers.
entrySeparatorStringRead/WriteGets or sets the character sequence that is used to separate a table of authorities entry and its page number.
removeEntryFormattingbooleanRead/WriteGets or sets whether to remove the formatting of the entry text in the document from the entry in the table of authorities.
pageRangeSeparatorStringRead/WriteGets or sets the character sequence that is used to separate the start and end of a page range.
useHeadingbooleanRead/WriteGets or sets whether to include the category heading for the entries in a table of authorities.
pageNumberListSeparatorStringRead/WriteGets or sets the character sequence that is used to separate two page numbers in a page number list.
usePassimbooleanRead/WriteGets or sets whether to replace five or more different page references to the same authority with “passim”, which is used to indicate that a word or passage occurs frequently in the work cited.
sequenceNameStringRead/WriteGets or sets the name of a sequence whose number is included with the page number.
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 table.
setBookmarkName(value: String)Sets the bookmark name value.
getEntryCategory() → StringGets or sets the integral category for entries included in the table.
setEntryCategory(value: String)Sets the entry category 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.
getEntrySeparator() → StringGets or sets the character sequence that is used to separate a table of authorities entry and its page number.
setEntrySeparator(value: String)Sets the entry separator value.
getRemoveEntryFormatting() → booleanGets or sets whether to remove the formatting of the entry text in the document from the entry in the table of authorities.
setRemoveEntryFormatting(value: boolean)Sets the remove entry formatting 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.
getUseHeading() → booleanGets or sets whether to include the category heading for the entries in a table of authorities.
setUseHeading(value: boolean)Sets the use heading 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.
getUsePassim() → booleanGets or sets whether to replace five or more different page references to the same authority with “passim”, which is used to indicate that a word or passage occurs frequently in the work cited.
setUsePassim(value: boolean)Sets the use passim 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.
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 FieldToa 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 FieldToa 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