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
| Name | Type | Access | Description |
|---|---|---|---|
sequenceIdentifier | String | Read/Write | Gets or sets the name assigned to the series of items that are to be numbered. |
bookmarkName | String | Read/Write | Gets or sets a bookmark name that refers to an item elsewhere in the document rather than in the current location. |
insertNextNumber | boolean | Read/Write | Gets or sets whether to insert the next sequence number for the specified item. |
resetNumber | String | Read/Write | Gets or sets an integer number to reset the sequence number to. |
resetHeadingLevel | String | Read/Write | Gets or sets an integer number representing a heading level to reset the sequence number to. |
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 |
|---|---|
getSequenceIdentifier() → String | Gets or sets the name assigned to the series of items that are to be numbered. |
setSequenceIdentifier(value: String) | Sets the sequence identifier value. |
getBookmarkName() → String | Gets 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() → boolean | Gets or sets whether to insert the next sequence number for the specified item. |
setInsertNextNumber(value: boolean) | Sets the insert next number value. |
getResetNumber() → String | Gets or sets an integer number to reset the sequence number to. |
setResetNumber(value: String) | Sets the reset number value. |
getResetHeadingLevel() → String | Gets 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() → 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 FieldSeq 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 FieldSeq 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. |