FieldSymbol
Overview
FieldSymbol is a class in Aspose.Words FOSS for Java.
Inherits from: Field, IFieldCodeTokenInfoProvider.
Implements a SYMBOL field.
Edition status of its 45 listed members (a property and its accessor methods are listed separately, overloads once): 45 not yet exercised by a verified example.
This class declares 34 methods for FieldSymbol objects in Java programs.
Available methods include: getCharacterCode, getDisplayResult, getDontAffectsLineSpacing, getEnd, getFieldCode, getFontName, getFontSize, getFormat, getLocaleId, getResult, getSeparator, getStart, and 15 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: ansi, characterCode, dirty, displayResult, dontAffectsLineSpacing, end, and 12 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
characterCode | String | Read/Write | Gets or sets the character’s code point value in decimal or hexadecimal. |
fontName | String | Read/Write | Gets or sets the name of the font of the character retrieved by the field. |
fontSize | String | Read/Write | Gets or sets the size in points of the font of the character retrieved by the field. |
ansi | boolean | Read/Write | Gets or sets whether the character code is interpreted as the value of an ANSI character. |
unicode | boolean | Read/Write | Gets or sets whether the character code is interpreted as the value of a Unicode character. |
shiftJis | boolean | Read/Write | Gets or sets whether the character code is interpreted as the value of a SHIFT-JIS character. |
dontAffectsLineSpacing | boolean | Read/Write | Gets or sets whether the character retrieved by the field affects the line spacing of the 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 |
|---|---|
getCharacterCode() → String | Gets or sets the character’s code point value in decimal or hexadecimal. |
setCharacterCode(value: String) | Sets the character code value. |
getFontName() → String | Gets or sets the name of the font of the character retrieved by the field. |
setFontName(value: String) | Sets the font name value. |
getFontSize() → String | Gets or sets the size in points of the font of the character retrieved by the field. |
setFontSize(value: String) | Sets the font size value. |
isAnsi() → boolean | Gets or sets whether the character code is interpreted as the value of an ANSI character. |
isAnsi(value: boolean) | Calls isAnsi(value) on this FieldSymbol instance. |
isUnicode() → boolean | Gets or sets whether the character code is interpreted as the value of a Unicode character. |
isUnicode(value: boolean) | Indicates whether the SYMBOL field uses a Unicode character code |
isShiftJis() → boolean | Gets or sets whether the character code is interpreted as the value of a SHIFT-JIS character. |
isShiftJis(value: boolean) | Calls isShiftJis(value) on this FieldSymbol instance. |
getDontAffectsLineSpacing() → boolean | Gets or sets whether the character retrieved by the field affects the line spacing of the paragraph. |
setDontAffectsLineSpacing(value: boolean) | Sets the dont affects line spacing 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 FieldSymbol 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 FieldSymbol 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. |