com.aspose.words

Class FootnoteOptions

java.lang.Object

com.aspose.words.FootnoteOptions

public final class FootnoteOptions
extends java.lang.Object

Represents the footnote numbering options for a document or section.

See Also:

Document.getFootnoteOptions(), PageSetup.getFootnoteOptions()

Method Summary

Modifier and Type	Method and Description
int	getColumns() Specifies the number of columns with which the footnotes area is formatted.
int	getLocation()
int	getNumberStyle() Specifies the number format for automatically numbered footnotes.
int	getPosition() Specifies the footnotes position.
int	getRestartRule() Determines when automatic numbering restarts.
int	getStartNumber() Specifies the starting number or character for the first automatically numbered footnotes.
void	setColumns(int value) Specifies the number of columns with which the footnotes area is formatted.
void	setLocation(int value)
void	setNumberStyle(int value) Specifies the number format for automatically numbered footnotes.
void	setPosition(int value) Specifies the footnotes position.
void	setRestartRule(int value) Determines when automatic numbering restarts.
void	setStartNumber(int value) Specifies the starting number or character for the first automatically numbered footnotes.

Methods inherited from class java.lang.Object

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

Method Detail

getPosition

public final int getPosition()

Specifies the footnotes position.

Returns:

The corresponding int value. The returned value is one of FootnotePosition constants.

setPosition

public final void setPosition(int value)

Specifies the footnotes position.

Parameters:

value - The corresponding int value. The value must be one of FootnotePosition constants.

getNumberStyle

public final int getNumberStyle()

Specifies the number format for automatically numbered footnotes.

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.

Returns:

The corresponding int value. The returned value is one of NumberStyle constants.

setNumberStyle

public final void setNumberStyle(int value)

Specifies the number format for automatically numbered footnotes.

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.

Parameters:

value - The corresponding int value. The value must be one of NumberStyle constants.

getStartNumber

public final int getStartNumber()

Specifies the starting number or character for the first automatically numbered footnotes.

This property has effect only when getRestartRule() / setRestartRule(int) is set to FootnoteNumberingRule.CONTINUOUS.

Returns:

The corresponding int value.

setStartNumber

public final void setStartNumber(int value)

Specifies the starting number or character for the first automatically numbered footnotes.

This property has effect only when getRestartRule() / setRestartRule(int) is set to FootnoteNumberingRule.CONTINUOUS.

Parameters:

value - The corresponding int value.

getRestartRule

public final int getRestartRule()

Determines when automatic numbering restarts.

Returns:

The corresponding int value. The returned value is one of FootnoteNumberingRule constants.

setRestartRule

public final void setRestartRule(int value)

Determines when automatic numbering restarts.

Parameters:

value - The corresponding int value. The value must be one of FootnoteNumberingRule constants.

getColumns

public final int getColumns()

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.

Returns:

The corresponding int value.

setColumns

public final 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.

Parameters:

value - The corresponding int value.

getLocation

public final int getLocation()

setLocation

public final void setLocation(int value)