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

NameTypeAccessDescription
characterCodeStringRead/WriteGets or sets the character’s code point value in decimal or hexadecimal.
fontNameStringRead/WriteGets or sets the name of the font of the character retrieved by the field.
fontSizeStringRead/WriteGets or sets the size in points of the font of the character retrieved by the field.
ansibooleanRead/WriteGets or sets whether the character code is interpreted as the value of an ANSI character.
unicodebooleanRead/WriteGets or sets whether the character code is interpreted as the value of a Unicode character.
shiftJisbooleanRead/WriteGets or sets whether the character code is interpreted as the value of a SHIFT-JIS character.
dontAffectsLineSpacingbooleanRead/WriteGets or sets whether the character retrieved by the field affects the line spacing of the 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
getCharacterCode() → StringGets or sets the character’s code point value in decimal or hexadecimal.
setCharacterCode(value: String)Sets the character code value.
getFontName() → StringGets or sets the name of the font of the character retrieved by the field.
setFontName(value: String)Sets the font name value.
getFontSize() → StringGets 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() → booleanGets 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() → booleanGets 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() → booleanGets 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() → booleanGets 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() → 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 FieldSymbol 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 FieldSymbol 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