FieldListNum

Overview

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

Implements the LISTNUM field.

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

This class declares 27 methods for FieldListNum objects in Java programs. Available methods include: getDisplayResult, getEnd, getFieldCode, getFormat, getListLevel, getListName, getLocaleId, getResult, getSeparator, getStart, getStartingNumber, getType, and 11 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, listLevel, and 8 more.

Properties

NameTypeAccessDescription
listNameStringRead/WriteGets or sets the name of the abstract numbering definition used for the numbering.
listLevelStringRead/WriteGets or sets the level in the list, overriding the default behavior of the field.
startingNumberStringRead/WriteGets or sets the starting value for this field.
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
remove() → NodeCalls remove on this FieldListNum instance.
getListName() → StringGets or sets the name of the abstract numbering definition used for the numbering.
setListName(value: String)Sets the list name value.
hasListName() → booleanReturns a value indicating whether the name of an abstract numbering definition is provided by the field’s code.
getListLevel() → StringGets or sets the level in the list, overriding the default behavior of the field.
setListLevel(value: String)Sets the list level value.
getStartingNumber() → StringGets or sets the starting value for this field.
setStartingNumber(value: String)Sets the starting number 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).
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 FieldListNum 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 FieldListNum 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