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
| Name | Type | Access | Description |
|---|---|---|---|
text | String | Read/Write | Gets or sets the text of the entry. |
bold | boolean | Read/Write | Gets or sets whether to apply bold formatting to the entry’s page number. |
entryType | String | Read/Write | Gets or sets an index entry type. |
italic | boolean | Read/Write | Gets or sets whether to apply italic formatting to the entry’s page number. |
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. |
pageNumberReplacement | String | Read/Write | Gets or sets text used in place of a page number. |
yomi | String | Read/Write | Gets or sets the yomi (first phonetic character for sorting indexes) for the index 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 |
|---|---|
getText() → String | Gets or sets the text of the entry. |
setText(value: String) | Sets the text value. |
isBold() → boolean | Gets or sets whether to apply bold formatting to the entry’s page number. |
isBold(value: boolean) | Calls isBold(value) on this FieldXE instance. |
getEntryType() → String | Gets or sets an index entry type. |
setEntryType(value: String) | Sets the entry type value. |
isItalic() → boolean | Gets or sets whether to apply italic formatting to the entry’s page number. |
isItalic(value: boolean) | Calls isItalic(value) on this FieldXE instance. |
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. |
getPageNumberReplacement() → String | Gets or sets text used in place of a page number. |
setPageNumberReplacement(value: String) | Sets the page number replacement value. |
getYomi() → String | Gets or sets the yomi (first phonetic character for sorting indexes) for the index entry |
setYomi(value: String) | Sets the yomi 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 FieldXE 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 FieldXE 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. |