com.spire.doc.fields
Class Footnote

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.Footnote

All Implemented Interfaces:

ICompositeObject, IDocumentObject, IDocumentSerializable, IParagraphBase

public class Footnote
extends ParagraphBase
implements ICompositeObject

Constructor Summary

Footnote(IDocument doc)
Initializes a new instance of the class.

Method Summary

void	ensureMinimum()
DocumentObjectCollection	getChildObjects() Gets the child entities.
java.lang.String	getCustomMarker() Gets or sets the custom footnote marker.
DocumentObjectType	getDocumentObjectType() Gets the type of the document object.
FootnoteType	getFootnoteType() Gets or sets footnote type: footnote or endnote
CharacterFormat	getMarkerCharacterFormat() Gets the marker character format
byte	getSymbolCode() Gets or sets the marker symbol code.
Body	getTextBody() Gets the text body of the footnote.
boolean	getUseAbsolutePos()
boolean	isAutoNumbered() Gets or sets the value indicating if the footnote is auto numbered
void	isAutoNumbered(boolean value) Gets or sets the value indicating if the footnote is auto numbered
void	setCustomMarker(java.lang.String value) Gets or sets the custom footnote marker.
void	setFootnoteType(FootnoteType value) Gets or sets footnote type: footnote or endnote
void	setSymbolCode(byte value) Gets or sets the marker symbol code.
void	setUseAbsolutePos(boolean value)

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

applyCharacterFormat, applyStyle, getCharacterFormat, getDeleteRevision, getInsertRevision, getNextWidgetSibling, getOwnerParagraph, getPreviousWidgetSibling, getStyleName, isDeleteRevision, isInsertRevision

Methods inherited from class com.spire.doc.DocumentObject

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

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

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

deepClone, getDocument, getNextSibling, getOwner, getPreviousSibling, isComposite

Constructor Detail

Footnote

public Footnote(IDocument doc)

Initializes a new instance of the class.

Parameters:

doc - The doc.

Method Detail

getUseAbsolutePos

public boolean getUseAbsolutePos()

setUseAbsolutePos

public void setUseAbsolutePos(boolean value)

getDocumentObjectType

public DocumentObjectType getDocumentObjectType()

Gets the type of the document object.

Specified by:

getDocumentObjectType in interface IDocumentObject

Specified by:

getDocumentObjectType in class DocumentObject

Returns:

The type of the document object.

getFootnoteType

public FootnoteType getFootnoteType()

Gets or sets footnote type: footnote or endnote

setFootnoteType

public void setFootnoteType(FootnoteType value)

Gets or sets footnote type: footnote or endnote

isAutoNumbered

public boolean isAutoNumbered()

Gets or sets the value indicating if the footnote is auto numbered

isAutoNumbered

public void isAutoNumbered(boolean value)

Gets or sets the value indicating if the footnote is auto numbered

getTextBody

public Body getTextBody()

Gets the text body of the footnote.

Returns:

The text body.

getMarkerCharacterFormat

public CharacterFormat getMarkerCharacterFormat()

Gets the marker character format

getSymbolCode

public byte getSymbolCode()

Gets or sets the marker symbol code.

Returns:

The symbol code.

setSymbolCode

public void setSymbolCode(byte value)

Gets or sets the marker symbol code.

getCustomMarker

public java.lang.String getCustomMarker()

Gets or sets the custom footnote marker.

Returns:

The custom marker.

setCustomMarker

public void setCustomMarker(java.lang.String value)

Gets or sets the custom footnote marker.

getChildObjects

public DocumentObjectCollection getChildObjects()

Gets the child entities.

Specified by:

getChildObjects in interface ICompositeObject

Overrides:

getChildObjects in class ParagraphBase

Returns:

The child entities.

ensureMinimum

public void ensureMinimum()