FieldTA
Overview
FieldTA is a class in Aspose.Words FOSS for Java.
Inherits from: Field, IFieldCodeTokenInfoProvider.
Implements the TA field.
Edition status of its 43 listed members (a property and its accessor methods are listed separately, overloads once): 43 not yet exercised by a verified example.
This class declares 32 methods for FieldTA objects in Java programs.
Available methods include: getDisplayResult, getEnd, getEntryCategory, getFieldCode, getFormat, getLocaleId, getLongCitation, getPageRangeBookmarkName, getResult, getSeparator, getShortCitation, getStart, and 14 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: bold, dirty, displayResult, end, entryCategory, fieldCode, and 11 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
bold | boolean | Read/Write | Gets or sets whether to apply bold formatting to the page number for the entry. |
entryCategory | String | Read/Write | Gets or sets the integral entry category, which is a number that corresponds to the order of categories. |
italic | boolean | Read/Write | Gets or sets whether to apply italic formatting to the page number for the entry. |
longCitation | String | Read/Write | Gets or sets the long citation for the entry. |
pageRangeBookmarkName | String | Read/Write | Gets or sets the name of the bookmark that marks a range of pages that is inserted as the entry’s page number. |
shortCitation | String | Read/Write | Gets or sets the short citation for the entry. |
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 |
|---|---|
isBold() → boolean | Gets or sets whether to apply bold formatting to the page number for the entry. |
isBold(value: boolean) | Calls isBold(value) on this FieldTA instance. |
getEntryCategory() → String | Gets or sets the integral entry category, which is a number that corresponds to the order of categories. |
setEntryCategory(value: String) | Sets the entry category value. |
isItalic() → boolean | Gets or sets whether to apply italic formatting to the page number for the entry. |
isItalic(value: boolean) | Calls isItalic(value) on this FieldTA instance. |
getLongCitation() → String | Gets or sets the long citation for the entry. |
setLongCitation(value: String) | Sets the long citation value. |
getPageRangeBookmarkName() → String | Gets or sets the name of the bookmark that marks a range of pages that is inserted as the entry’s page number. |
setPageRangeBookmarkName(value: String) | Sets the page range bookmark name value. |
getShortCitation() → String | Gets or sets the short citation for the entry. |
setShortCitation(value: String) | Sets the short citation 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 FieldTA 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 FieldTA 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. |