java.lang.Object
Field
com.aspose.words.FieldSeq
public class FieldSeq
- extends Field
Implements the SEQ field.
Sequentially numbers chapters, tables, figures, and other user-defined lists of items in a document.
Property Getters/Setters Summary |
java.lang.String | getBookmarkName() | |
void | setBookmarkName(java.lang.String value) | |
|
Gets or sets a bookmark name that refers to an item elsewhere in the document rather than in the current location.
|
FieldEnd | getEnd() | → inherited from Field |
|
Gets the node that represents the field end.
|
FieldFormat | getFormat() | → inherited from Field |
|
Gets a FieldFormat object that provides typed access to field's formatting.
|
boolean | getInsertNextNumber() | |
void | setInsertNextNumber(boolean value) | |
|
Gets or sets whether to insert the next sequence number for the specified item.
|
boolean | isDirty() | → inherited from Field |
void | isDirty(boolean value) | |
|
Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
|
boolean | isLocked() | → inherited from Field |
void | isLocked(boolean value) | |
|
Gets or sets whether the field is locked (should not recalculate its result).
|
int | getLocaleId() | → inherited from Field |
void | setLocaleId(int value) | |
|
Gets or sets the LCID of the field.
|
java.lang.String | getResetHeadingLevel() | |
void | setResetHeadingLevel(java.lang.String value) | |
|
Gets or sets an integer number representing a heading level to reset the sequence number to.
Returns -1 if the number is absent.
|
java.lang.String | getResetNumber() | |
void | setResetNumber(java.lang.String value) | |
|
Gets or sets an integer number to reset the sequence number to. Returns -1 if the number is absent.
|
java.lang.String | getResult() | → inherited from Field |
void | setResult(java.lang.String value) | |
|
Gets or sets text that is between the field separator and field end.
|
FieldSeparator | getSeparator() | → inherited from Field |
|
Gets the node that represents the field separator. Can be null.
|
java.lang.String | getSequenceIdentifier() | |
void | setSequenceIdentifier(java.lang.String value) | |
|
Gets or sets the name assigned to the series of items that are to be numbered.
|
FieldStart | getStart() | → inherited from Field |
|
Gets the node that represents the start of the field.
|
int | getType() | → inherited from Field |
|
Gets the Microsoft Word field type.
The value of the property is FieldType integer constant. |
Method Summary |
java.lang.String | getFieldCode() | → inherited from Field |
Returns text between field start and field separator (or field end if there is no separator).
Both field code and field result of child fields are included.
|
java.lang.String | getFieldCode(boolean includeChildFieldCodes) | → inherited from Field |
Returns text between field start and field separator (or field end if there is no separator).
|
aspose.obfuscated.type | getSwitchType(java.lang.String switchName) | |
Reserved for internal use. |
Aspose.Words.Node | remove() | → inherited from Field |
Removes the field from the document. Returns a node right after the field. If the field's end is the last child
of its parent node, returns its parent paragraph. If the field is already removed, returns null.
|
boolean | unlink() | → inherited from Field |
Performs the field unlink.
|
void | update() | → inherited from Field |
Performs the field update. Throws if the field is being updated already.
|
void | update(boolean ignoreMergeFormat) | → inherited from Field |
Performs a field update. Throws if the field is being updated already.
|
FieldSeq
public FieldSeq()
-
Property Getters/Setters Detail |
getBookmarkName/setBookmarkName | |
public java.lang.String getBookmarkName() / public void setBookmarkName(java.lang.String value)
|
-
Gets or sets a bookmark name that refers to an item elsewhere in the document rather than in the current location.
-
Gets the node that represents the field end.
-
Gets a FieldFormat object that provides typed access to field's formatting.
getInsertNextNumber/setInsertNextNumber | |
public boolean getInsertNextNumber() / public void setInsertNextNumber(boolean value)
|
-
Gets or sets whether to insert the next sequence number for the specified item.
isDirty/isDirty | → inherited from Field |
public boolean isDirty() / public void isDirty(boolean value)
|
-
Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
isLocked/isLocked | → inherited from Field |
public boolean isLocked() / public void isLocked(boolean value)
|
-
Gets or sets whether the field is locked (should not recalculate its result).
getLocaleId/setLocaleId | → inherited from Field |
public int getLocaleId() / public void setLocaleId(int value)
|
-
Gets or sets the LCID of the field.
- See Also:
- FieldUpdateCultureSource.FIELD_CODE
getResetHeadingLevel/setResetHeadingLevel | |
public java.lang.String getResetHeadingLevel() / public void setResetHeadingLevel(java.lang.String value)
|
-
Gets or sets an integer number representing a heading level to reset the sequence number to.
Returns -1 if the number is absent.
getResetNumber/setResetNumber | |
public java.lang.String getResetNumber() / public void setResetNumber(java.lang.String value)
|
-
Gets or sets an integer number to reset the sequence number to. Returns -1 if the number is absent.
getResult/setResult | → inherited from Field |
public java.lang.String getResult() / public void setResult(java.lang.String value)
|
-
Gets or sets text that is between the field separator and field end.
-
Gets the node that represents the field separator. Can be null.
getSequenceIdentifier/setSequenceIdentifier | |
public java.lang.String getSequenceIdentifier() / public void setSequenceIdentifier(java.lang.String value)
|
-
Gets or sets the name assigned to the series of items that are to be numbered.
-
Gets the node that represents the start of the field.
getType | → inherited from Field |
public int getType()
|
-
Gets the Microsoft Word field type.
The value of the property is FieldType integer constant.
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode() |
-
Returns text between field start and field separator (or field end if there is no separator).
Both field code and field result of child fields are included.
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode(boolean includeChildFieldCodes) |
-
Returns text between field start and field separator (or field end if there is no separator).
- Parameters:
includeChildFieldCodes
- True
if child field codes should be included.
getSwitchType | |
public aspose.obfuscated.type getSwitchType(java.lang.String switchName) |
- Reserved for internal use.
remove | → inherited from Field |
public Aspose.Words.Node remove()
throws java.lang.Exception |
-
Removes the field from the document. Returns a node right after the field. If the field's end is the last child
of its parent node, returns its parent paragraph. If the field is already removed, returns null.
unlink | → inherited from Field |
public boolean unlink()
throws java.lang.Exception |
-
Performs the field unlink.
Replaces the field with its most recent result.
Some fields, such as XE (Index Entry) fields and SEQ (Sequence) fields, cannot be unlinked.
- Returns:
True
if the field has been unlinked, otherwise false
.
update | → inherited from Field |
public void update()
throws java.lang.Exception |
-
Performs the field update. Throws if the field is being updated already.
update | → inherited from Field |
public void update(boolean ignoreMergeFormat)
throws java.lang.Exception |
-
Performs a field update. Throws if the field is being updated already.
- Parameters:
ignoreMergeFormat
-
If true
then direct field result formatting is abandoned, regardless of the MERGEFORMAT switch, otherwise normal update is performed.
See Also:
Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
Aspose.Words Support Forum - our preferred method of support.