FieldNoteRef
Overview
FieldNoteRef is a class in Aspose.Words FOSS for Java.
Inherits from: Field, IFieldCodeTokenInfoProvider.
Implements the NOTEREF field.
Edition status of its 39 listed members (a property and its accessor methods are listed separately, overloads once): 39 not yet exercised by a verified example.
Limited in the FOSS edition: updating a NOTEREF field does not work. In a test on Java 8, 17 and 21 the result was always Error! Bookmark not defined., even when the bookmark wrapped a real footnote reference, because the code that finds the footnote reference mark is an empty stub in this edition. The field code and its switches can still be read and set.
This class declares 28 methods for FieldNoteRef objects in Java programs.
Available methods include: getBookmarkName, getDisplayResult, getEnd, getFieldCode, getFormat, getInsertHyperlink, getInsertReferenceMark, getInsertRelativePosition, getLocaleId, getResult, getSeparator, getStart, and 12 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: bookmarkName, dirty, displayResult, end, fieldCode, format, and 9 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
bookmarkName | String | Read/Write | Gets or sets the name of the bookmark. |
insertReferenceMark | boolean | Read/Write | Inserts the reference mark with the same character formatting as the Footnote Reference or Endnote Reference style. |
insertHyperlink | boolean | Read/Write | Gets or sets whether to insert a hyperlink to the bookmarked paragraph. |
insertRelativePosition | boolean | Read/Write | Gets or sets whether to insert a relative position of the bookmarked paragraph. |
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. |
setBookmarkName(value: String) | Sets the bookmark name value. |
getInsertReferenceMark() → boolean | Inserts the reference mark with the same character formatting as the Footnote Reference or Endnote Reference style. |
setInsertReferenceMark(value: boolean) | Sets the insert reference mark value. |
getInsertHyperlink() → boolean | Gets or sets whether to insert a hyperlink to the bookmarked paragraph. |
setInsertHyperlink(value: boolean) | Sets the insert hyperlink value. |
getInsertRelativePosition() → boolean | Gets or sets whether to insert a relative position of the bookmarked paragraph. |
setInsertRelativePosition(value: boolean) | Sets the insert relative position 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 FieldNoteRef 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 FieldNoteRef 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. |