FieldXE

Overview

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

Implements the XE field.

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

This class declares 34 methods for FieldXE objects in Java programs. Available methods include: getDisplayResult, getEnd, getEntryType, getFieldCode, getFormat, getLocaleId, getPageNumberReplacement, getPageRangeBookmarkName, getResult, getSeparator, getStart, getText, and 16 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: bold, dirty, displayResult, end, entryType, fieldCode, and 12 more.

Properties

NameTypeAccessDescription
textStringRead/WriteGets or sets the text of the entry.
boldbooleanRead/WriteGets or sets whether to apply bold formatting to the entry’s page number.
entryTypeStringRead/WriteGets or sets an index entry type.
italicbooleanRead/WriteGets or sets whether to apply italic formatting to the entry’s page number.
pageRangeBookmarkNameStringRead/WriteGets or sets the name of the bookmark that marks a range of pages that is inserted as the entry’s page number.
pageNumberReplacementStringRead/WriteGets or sets text used in place of a page number.
yomiStringRead/WriteGets or sets the yomi (first phonetic character for sorting indexes) for the index 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
getText() → StringGets or sets the text of the entry.
setText(value: String)Sets the text value.
isBold() → booleanGets or sets whether to apply bold formatting to the entry’s page number.
isBold(value: boolean)Calls isBold(value) on this FieldXE instance.
getEntryType() → StringGets or sets an index entry type.
setEntryType(value: String)Sets the entry type value.
isItalic() → booleanGets or sets whether to apply italic formatting to the entry’s page number.
isItalic(value: boolean)Calls isItalic(value) on this FieldXE instance.
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.
getPageNumberReplacement() → StringGets or sets text used in place of a page number.
setPageNumberReplacement(value: String)Sets the page number replacement value.
getYomi() → StringGets or sets the yomi (first phonetic character for sorting indexes) for the index entry
setYomi(value: String)Sets the yomi 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 FieldXE 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 FieldXE 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