FieldSeq

Overview

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

Implements the SEQ field.

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

This class declares 30 methods for FieldSeq objects in Java programs. Available methods include: getBookmarkName, getDisplayResult, getEnd, getFieldCode, getFormat, getInsertNextNumber, getLocaleId, getResetHeadingLevel, getResetNumber, getResult, getSeparator, getSequenceIdentifier, and 14 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: bookmarkName, dirty, displayResult, end, fieldCode, format, and 10 more.

Properties

NameTypeAccessDescription
sequenceIdentifierStringRead/WriteGets or sets the name assigned to the series of items that are to be numbered.
bookmarkNameStringRead/WriteGets or sets a bookmark name that refers to an item elsewhere in the document rather than in the current location.
insertNextNumberbooleanRead/WriteGets or sets whether to insert the next sequence number for the specified item.
resetNumberStringRead/WriteGets or sets an integer number to reset the sequence number to.
resetHeadingLevelStringRead/WriteGets or sets an integer number representing a heading level to reset the sequence number to.
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
getSequenceIdentifier() → StringGets or sets the name assigned to the series of items that are to be numbered.
setSequenceIdentifier(value: String)Sets the sequence identifier value.
getBookmarkName() → StringGets or sets a bookmark name that refers to an item elsewhere in the document rather than in the current location.
setBookmarkName(value: String)Sets the bookmark name value.
getInsertNextNumber() → booleanGets or sets whether to insert the next sequence number for the specified item.
setInsertNextNumber(value: boolean)Sets the insert next number value.
getResetNumber() → StringGets or sets an integer number to reset the sequence number to.
setResetNumber(value: String)Sets the reset number value.
getResetHeadingLevel() → StringGets or sets an integer number representing a heading level to reset the sequence number to.
setResetHeadingLevel(value: String)Sets the reset heading level 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 FieldSeq 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 FieldSeq 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