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
| Name | Type | Access | Description |
|---|---|---|---|
styleName | String | Read/Write | Gets or sets the name of the style by which the text to search for is formatted. |
searchFromBottom | boolean | Read/Write | Gets or sets whether to search from the bottom of the current page, rather from the top. |
insertParagraphNumber | boolean | Read/Write | Gets or sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document. |
insertRelativePosition | boolean | Read/Write | Gets or sets whether to insert the relative position of the referenced paragraph. |
insertParagraphNumberInRelativeContext | boolean | Read/Write | Gets or sets whether to insert the paragraph number of the referenced paragraph in relative context. |
suppressNonDelimiters | boolean | Read/Write | Gets or sets whether to suppress non-delimiter characters. |
insertParagraphNumberInFullContext | boolean | Read/Write | Gets or sets whether to insert the paragraph number of the referenced paragraph in full context. |
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 |
|---|---|
getStyleName() → String | Gets 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() → boolean | Gets 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() → boolean | Gets 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() → boolean | Gets or sets whether to insert the relative position of the referenced paragraph. |
setInsertRelativePosition(value: boolean) | Sets the insert relative position value. |
getInsertParagraphNumberInRelativeContext() → boolean | Gets 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() → boolean | Gets or sets whether to suppress non-delimiter characters. |
setSuppressNonDelimiters(value: boolean) | Sets the suppress non delimiters value. |
getInsertParagraphNumberInFullContext() → boolean | Gets 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() → 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 FieldStyleRef 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 FieldStyleRef 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. |