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:

IRunAttrSource, IDocumentObject, IParagraphBase

public class Footnote
extends ParagraphBase

Constructor Summary

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

Method Summary

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

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

applyCharacterFormat, applyStyle, getAncestor, getCharacterFormat, 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.IDocumentObject

deepClone, getDocument, getNextSibling, getOwner, getPreviousSibling, isComposite

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

clearRunAttrs, fetchInheritedRunAttr, getDirectRunAttr, getDirectRunAttrByIndex, getDirectRunAttrsCount, setRunAttr

Constructor Detail

Footnote

public Footnote(IDocument doc)

Initializes a new instance of the Footnote 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 footnote type: footnote or endnote

Returns:

The type of the footnote

setFootnoteType

public void setFootnoteType(FootnoteType value)

Sets footnote type: footnote or endnote

Parameters:

value - The type of the footnote

isAutoNumbered

public boolean isAutoNumbered()

Gets the value indicating if the footnote is auto numbered

Returns:

The footnote is auto numbered or NOT

isAutoNumbered

public void isAutoNumbered(boolean value)

Sets the value indicating if the footnote is auto numbered

Parameters:

value - The footnote is auto numbered or NOT

getTextBody

public Body getTextBody()

Gets the text body of the footnote.

Returns:

The text body.

getMarkerCharacterFormat

public CharacterFormat getMarkerCharacterFormat()

Gets the marker character format.

Returns:

The format of the marker character

getSymbolCode

public byte getSymbolCode()

Gets the marker symbol code.

Returns:

The symbol code.

setSymbolCode

public void setSymbolCode(byte value)

Sets the marker symbol code.

Parameters:

value - The symbol code.

getCustomMarker

public java.lang.String getCustomMarker()

Gets the custom footnote marker.

Returns:

The custom marker.

setCustomMarker

public void setCustomMarker(java.lang.String value)

Sets the custom footnote marker.

Parameters:

value - The custom marker.