com.aspose.words
Class FootnoteOptions

java.lang.Object
    extended by com.aspose.words.FootnoteOptions

public class FootnoteOptions 
extends java.lang.Object

Represents the footnote numbering options for a document or section.

Example:

Shows how to set the number of columns with which the footnotes area is formatted.
Document doc = new Document(getMyDir() + "Document.FootnoteEndnote.docx");


// Lets change number of columns for footnotes on page. If columns value is 0 than footnotes area
// is formatted with a number of columns based on the number of columns on the displayed page
doc.getFootnoteOptions().setColumns(2);
doc.save(getArtifactsDir() + "Document.FootnoteOptions.docx");
See Also:
Document.FootnoteOptions, PageSetup.FootnoteOptions

Property Getters/Setters Summary
intgetColumns()
voidsetColumns(int value)
           Specifies the number of columns with which the footnotes area is formatted.
intgetNumberStyle()
voidsetNumberStyle(int value)
           Specifies the number format for automatically numbered footnotes. The value of the property is NumberStyle integer constant.
intgetPosition()
voidsetPosition(int value)
           Specifies the footnotes position. The value of the property is FootnotePosition integer constant.
intgetRestartRule()
voidsetRestartRule(int value)
           Determines when automatic numbering restarts. The value of the property is FootnoteNumberingRule integer constant.
intgetStartNumber()
voidsetStartNumber(int value)
           Specifies the starting number or character for the first automatically numbered footnotes.
 

Property Getters/Setters Detail

getColumns/setColumns

public int getColumns() / public void setColumns(int value)
Specifies the number of columns with which the footnotes area is formatted. If this property has the value of 0, the footnotes area is formatted with a number of columns based on the number of columns on the displayed page. The default value is 0.

Example:

Shows how to set the number of columns with which the footnotes area is formatted.
Document doc = new Document(getMyDir() + "Document.FootnoteEndnote.docx");


// Lets change number of columns for footnotes on page. If columns value is 0 than footnotes area
// is formatted with a number of columns based on the number of columns on the displayed page
doc.getFootnoteOptions().setColumns(2);
doc.save(getArtifactsDir() + "Document.FootnoteOptions.docx");

getNumberStyle/setNumberStyle

public int getNumberStyle() / public void setNumberStyle(int value)
Specifies the number format for automatically numbered footnotes. The value of the property is NumberStyle integer constant.

Not all number styles are applicable for this property. For the list of applicable number styles see the Insert Footnote or Endnote dialog box in Microsoft Word. If you select a number style that is not applicable, Microsoft Word will revert to a default value.

Example:

Shows how to define numbering format for footnotes in the document.
Document doc = new Document(getMyDir() + "Document.FootnoteEndnote.docx");

doc.getFootnoteOptions().setNumberStyle(NumberStyle.ARABIC_1);

getPosition/setPosition

public int getPosition() / public void setPosition(int value)
Specifies the footnotes position. The value of the property is FootnotePosition integer constant.

Example:

Shows how to define footnote position in the document.
Document doc = new Document(getMyDir() + "Document.FootnoteEndnote.docx");

doc.getFootnoteOptions().setPosition(FootnotePosition.BENEATH_TEXT);

getRestartRule/setRestartRule

public int getRestartRule() / public void setRestartRule(int value)
Determines when automatic numbering restarts. The value of the property is FootnoteNumberingRule integer constant.

Example:

Shows how to define when automatic numbering for footnotes restarts in the document.
Document doc = new Document(getMyDir() + "Document.FootnoteEndnote.docx");

doc.getFootnoteOptions().setRestartRule(FootnoteNumberingRule.RESTART_PAGE);

getStartNumber/setStartNumber

public int getStartNumber() / public void setStartNumber(int value)
Specifies the starting number or character for the first automatically numbered footnotes.

This property has effect only when RestartRule is set to FootnoteNumberingRule.CONTINUOUS.

Example:

Shows how to define the starting number or character for the first automatically numbered footnotes.
Document doc = new Document(getMyDir() + "Document.FootnoteEndnote.docx");

doc.getFootnoteOptions().setStartNumber(1);

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.