com.spire.doc.fields
Class SequenceField

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.DocumentObject
              com.spire.doc.DocumentBase
                  com.spire.doc.fields.ParagraphBase
                      com.spire.doc.fields.TextRange
                          com.spire.doc.fields.Field
                              com.spire.doc.fields.SequenceField

All Implemented Interfaces:

IRunAttrSource, IDocumentObject, IField, IParagraphBase, ITextRange

public class SequenceField
extends Field

Constructor Summary

protected	SequenceField(Field field) Initializes a new instance of the SequenceField class.
	SequenceField(IDocument doc) Initializes a new instance of the SequenceField class.

Method Summary

java.lang.String	getCaptionName() Returns the caption name
DocumentObjectType	getDocumentObjectType() Gets the type of the document object.
java.lang.String	getFormattingString() Gets the formatting string
CaptionNumberingFormat	getNumberFormat() Returns the type of caption numbering
void	setCaptionName(java.lang.String value) Sets caption name
void	setNumberFormat(CaptionNumberingFormat value) Sets the type of caption numbering

Methods inherited from class com.spire.doc.fields.Field

downloadImage, getCode, getEnd, getFieldText, getPattern, getSeparator, getTextFormat, getType, getValue, isLocked, isLocked, setCode, setEnd, setFieldText, setPattern, setTextFormat, setType

Methods inherited from class com.spire.doc.fields.TextRange

getCharacterFormat, getText, setText

Methods inherited from class com.spire.doc.fields.ParagraphBase

applyCharacterFormat, applyStyle, getAncestor, getChildObjects, getOwnerParagraph, getStyleName, isDeleteRevision, isInsertRevision

Methods inherited from class com.spire.doc.DocumentObject

deepClone, getFirstChild, getLastChild, getNextSibling, getOwner, getPreviousSibling, isComposite, toString

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Methods inherited from interface com.spire.doc.interfaces.ITextRange

applyCharacterFormat, getCharacterFormat, getText, setText

Methods inherited from interface com.spire.doc.interfaces.IParagraphBase

applyStyle, getOwnerParagraph, getStyleName

Methods inherited from interface com.spire.doc.interfaces.IDocumentObject

deepClone, getDocument, getNextSibling, getOwner, getPreviousSibling, isComposite

Methods inherited from interface com.spire.doc.documents.IRunAttrSource

clearRunAttrs, fetchInheritedRunAttr, getDirectRunAttr, getDirectRunAttrByIndex, getDirectRunAttrsCount, setRunAttr

Constructor Detail

SequenceField

public SequenceField(IDocument doc)

Initializes a new instance of the SequenceField class.

Parameters:

doc - doc

SequenceField

protected SequenceField(Field field)

Initializes a new instance of the SequenceField class.

Parameters:

field - The field.

Method Detail

getDocumentObjectType

public DocumentObjectType getDocumentObjectType()

Gets the type of the document object.

Specified by:

getDocumentObjectType in interface IDocumentObject

Overrides:

getDocumentObjectType in class Field

Returns:

The type of the document object.

getFormattingString

public java.lang.String getFormattingString()

Gets the formatting string

Overrides:

getFormattingString in class Field

Returns:

The formatting string

getNumberFormat

public CaptionNumberingFormat getNumberFormat()

Returns the type of caption numbering

Returns:

The type

setNumberFormat

public void setNumberFormat(CaptionNumberingFormat value)

Sets the type of caption numbering

Parameters:

value - The type

getCaptionName

public java.lang.String getCaptionName()

Returns the caption name

Returns:

The caption name

setCaptionName

public void setCaptionName(java.lang.String value)

Sets caption name

Parameters:

value - The caption name