FieldStyleRef

Overview

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

Implements the STYLEREF field.

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

This class declares 34 methods for FieldStyleRef objects in Java programs. Available methods include: getDisplayResult, getEnd, getFieldCode, getFormat, getInsertParagraphNumber, getInsertParagraphNumberInFullContext, getInsertParagraphNumberInRelativeContext, getInsertRelativePosition, getLocaleId, getResult, getSearchFromBottom, getSeparator, and 18 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: dirty, displayResult, end, fieldCode, format, insertParagraphNumber, and 12 more.

Properties

NameTypeAccessDescription
styleNameStringRead/WriteGets or sets the name of the style by which the text to search for is formatted.
searchFromBottombooleanRead/WriteGets or sets whether to search from the bottom of the current page, rather from the top.
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
getStyleName() → StringGets or sets the name of the style by which the text to search for is formatted.
setStyleName(value: String)Sets the style name value.
getSearchFromBottom() → booleanGets or sets whether to search from the bottom of the current page, rather from the top.
setSearchFromBottom(value: boolean)Sets the search from bottom 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 FieldStyleRef 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 FieldStyleRef 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