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
| 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 table. |
entryCategory | String | Read/Write | Gets or sets the integral category for entries included in the table. |
sequenceSeparator | String | Read/Write | Gets or sets the character sequence that is used to separate sequence numbers and page numbers. |
entrySeparator | String | Read/Write | Gets or sets the character sequence that is used to separate a table of authorities entry and its page number. |
removeEntryFormatting | boolean | Read/Write | Gets or sets whether to remove the formatting of the entry text in the document from the entry in the table of authorities. |
pageRangeSeparator | String | Read/Write | Gets or sets the character sequence that is used to separate the start and end of a page range. |
useHeading | boolean | Read/Write | Gets or sets whether to include the category heading for the entries in a table of authorities. |
pageNumberListSeparator | String | Read/Write | Gets or sets the character sequence that is used to separate two page numbers in a page number list. |
usePassim | boolean | Read/Write | Gets 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. |
sequenceName | String | Read/Write | Gets or sets the name of a sequence whose number is included with the page number. |
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 table. |
setBookmarkName(value: String) | Sets the bookmark name value. |
getEntryCategory() → String | Gets or sets the integral category for entries included in the table. |
setEntryCategory(value: String) | Sets the entry category 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. |
getEntrySeparator() → String | Gets 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() → boolean | Gets 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() → 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. |
getUseHeading() → boolean | Gets 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() → 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. |
getUsePassim() → boolean | Gets 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() → 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. |
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 FieldToa 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 FieldToa 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. |