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

NameTypeAccessDescription
boldbooleanRead/WriteGets or sets whether to apply bold formatting to the page number for the entry.
entryCategoryStringRead/WriteGets or sets the integral entry category, which is a number that corresponds to the order of categories.
italicbooleanRead/WriteGets or sets whether to apply italic formatting to the page number for the entry.
longCitationStringRead/WriteGets or sets the long citation for the entry.
pageRangeBookmarkNameStringRead/WriteGets or sets the name of the bookmark that marks a range of pages that is inserted as the entry’s page number.
shortCitationStringRead/WriteGets or sets the short citation for the entry.
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
isBold() → booleanGets 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() → StringGets 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() → booleanGets 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() → StringGets or sets the long citation for the entry.
setLongCitation(value: String)Sets the long citation value.
getPageRangeBookmarkName() → StringGets 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() → StringGets or sets the short citation for the entry.
setShortCitation(value: String)Sets the short citation 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 FieldTA 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 FieldTA 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