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

NameTypeAccessDescription
bookmarkNameStringRead/WriteGets or sets the name of the bookmark.
insertReferenceMarkbooleanRead/WriteInserts the reference mark with the same character formatting as the Footnote Reference or Endnote Reference style.
insertHyperlinkbooleanRead/WriteGets or sets whether to insert a hyperlink to the bookmarked paragraph.
insertRelativePositionbooleanRead/WriteGets or sets whether to insert a relative position of the bookmarked paragraph.
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
getBookmarkName() → StringGets or sets the name of the bookmark.
setBookmarkName(value: String)Sets the bookmark name value.
getInsertReferenceMark() → booleanInserts 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() → booleanGets or sets whether to insert a hyperlink to the bookmarked paragraph.
setInsertHyperlink(value: boolean)Sets the insert hyperlink value.
getInsertRelativePosition() → booleanGets or sets whether to insert a relative position of the bookmarked paragraph.
setInsertRelativePosition(value: boolean)Sets the insert relative position 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 FieldNoteRef 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 FieldNoteRef 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