com.aspose.words

Class FieldSeq

java.lang.Object

com.aspose.words.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.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBookmarkName() Gets a bookmark name that refers to an item elsewhere in the document rather than in the current location.
boolean	getInsertNextNumber() Gets whether to insert the next sequence number for the specified item.
java.lang.String	getResetHeadingLevel() Gets an integer number representing a heading level to reset the sequence number to.
java.lang.String	getResetNumber() Gets an integer number to reset the sequence number to.
java.lang.String	getSequenceIdentifier() Gets the name assigned to the series of items that are to be numbered.
int	getSwitchType(java.lang.String switchName)
void	setBookmarkName(java.lang.String value) Sets a bookmark name that refers to an item elsewhere in the document rather than in the current location.
void	setInsertNextNumber(boolean value) Sets whether to insert the next sequence number for the specified item.
void	setResetHeadingLevel(java.lang.String value) Sets an integer number representing a heading level to reset the sequence number to.
void	setResetNumber(java.lang.String value) Sets an integer number to reset the sequence number to.
void	setSequenceIdentifier(java.lang.String value) Sets the name assigned to the series of items that are to be numbered.

Methods inherited from class com.aspose.words.Field

getDisplayResult, getEnd, getFieldCode, getFieldCode, getFormat, getLocaleId, getResult, getSeparator, getStart, getType, isDirty, isDirty, isLocked, isLocked, needStoreOldResultNodes, remove, setLocaleId, setResult, unlink, update, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSequenceIdentifier

public java.lang.String getSequenceIdentifier()

Gets the name assigned to the series of items that are to be numbered.

Returns:

The name assigned to the series of items that are to be numbered.

setSequenceIdentifier

public void setSequenceIdentifier(java.lang.String value)
                           throws java.lang.Exception

Sets the name assigned to the series of items that are to be numbered.

Parameters:

value - The name assigned to the series of items that are to be numbered.

Throws:

java.lang.Exception

getBookmarkName

public java.lang.String getBookmarkName()

Gets a bookmark name that refers to an item elsewhere in the document rather than in the current location.

Returns:

A bookmark name that refers to an item elsewhere in the document rather than in the current location.

setBookmarkName

public void setBookmarkName(java.lang.String value)
                     throws java.lang.Exception

Sets a bookmark name that refers to an item elsewhere in the document rather than in the current location.

Parameters:

value - A bookmark name that refers to an item elsewhere in the document rather than in the current location.

Throws:

java.lang.Exception

getInsertNextNumber

public boolean getInsertNextNumber()

Gets whether to insert the next sequence number for the specified item.

Returns:

Whether to insert the next sequence number for the specified item.

setInsertNextNumber

public void setInsertNextNumber(boolean value)
                         throws java.lang.Exception

Sets whether to insert the next sequence number for the specified item.

Parameters:

value - Whether to insert the next sequence number for the specified item.

Throws:

java.lang.Exception

getResetNumber

public java.lang.String getResetNumber()

Gets an integer number to reset the sequence number to. Returns -1 if the number is absent.

Returns:

An integer number to reset the sequence number to.

setResetNumber

public void setResetNumber(java.lang.String value)
                    throws java.lang.Exception

Sets an integer number to reset the sequence number to. Returns -1 if the number is absent.

Parameters:

value - An integer number to reset the sequence number to.

Throws:

java.lang.Exception

getResetHeadingLevel

public java.lang.String getResetHeadingLevel()

Gets an integer number representing a heading level to reset the sequence number to. Returns -1 if the number is absent.

Returns:

An integer number representing a heading level to reset the sequence number to.

setResetHeadingLevel

public void setResetHeadingLevel(java.lang.String value)
                          throws java.lang.Exception

Sets an integer number representing a heading level to reset the sequence number to. Returns -1 if the number is absent.

Parameters:

value - An integer number representing a heading level to reset the sequence number to.

Throws:

java.lang.Exception

getSwitchType

public int getSwitchType(java.lang.String switchName)