FieldRef

Overview

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

Implements the REF field.

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

This class declares 38 methods for FieldRef objects in Java programs. Available methods include: getBookmarkName, getDisplayResult, getEnd, getFieldCode, getFormat, getIncludeNoteOrComment, getInsertHyperlink, getInsertParagraphNumber, getInsertParagraphNumberInFullContext, getInsertParagraphNumberInRelativeContext, getInsertRelativePosition, getLocaleId, and 22 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 14 more.

Properties

NameTypeAccessDescription
bookmarkNameStringRead/WriteGets or sets the referenced bookmark’s name.
numberSeparatorStringRead/WriteGets or sets the character sequence that is used to separate sequence numbers and page numbers.
includeNoteOrCommentbooleanRead/WriteGets or sets whether to increment footnote, endnote, and annotation numbers that are marked by the bookmark, and insert the corresponding footnote, endnote, and comment text.
insertHyperlinkbooleanRead/WriteGets or sets whether to create a hyperlink to the bookmarked paragraph.
insertParagraphNumberbooleanRead/WriteGets or sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.
insertRelativePositionbooleanRead/WriteGets or sets whether to insert the relative position of the referenced paragraph.
insertParagraphNumberInRelativeContextbooleanRead/WriteGets or sets whether to insert the paragraph number of the referenced paragraph in relative context.
suppressNonDelimitersbooleanRead/WriteGets or sets whether to suppress non-delimiter characters.
insertParagraphNumberInFullContextbooleanRead/WriteGets or sets whether to insert the paragraph number of the referenced paragraph in full context.
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 referenced bookmark’s name.
setBookmarkName(value: String)Sets the bookmark name value.
getNumberSeparator() → StringGets or sets the character sequence that is used to separate sequence numbers and page numbers.
setNumberSeparator(value: String)Sets the number separator value.
getIncludeNoteOrComment() → booleanGets or sets whether to increment footnote, endnote, and annotation numbers that are marked by the bookmark, and insert the corresponding footnote, endnote, and comment text.
setIncludeNoteOrComment(value: boolean)Sets the include note or comment value.
getInsertHyperlink() → booleanGets or sets whether to create a hyperlink to the bookmarked paragraph.
setInsertHyperlink(value: boolean)Sets the insert hyperlink value.
getInsertParagraphNumber() → booleanGets or sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.
setInsertParagraphNumber(value: boolean)Sets the insert paragraph number value.
getInsertRelativePosition() → booleanGets or sets whether to insert the relative position of the referenced paragraph.
setInsertRelativePosition(value: boolean)Sets the insert relative position value.
getInsertParagraphNumberInRelativeContext() → booleanGets or sets whether to insert the paragraph number of the referenced paragraph in relative context.
setInsertParagraphNumberInRelativeContext(value: boolean)Sets the insert paragraph number in relative context value.
getSuppressNonDelimiters() → booleanGets or sets whether to suppress non-delimiter characters.
setSuppressNonDelimiters(value: boolean)Sets the suppress non delimiters value.
getInsertParagraphNumberInFullContext() → booleanGets or sets whether to insert the paragraph number of the referenced paragraph in full context.
setInsertParagraphNumberInFullContext(value: boolean)Sets the insert paragraph number in full context 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 FieldRef 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 FieldRef 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