com.aspose.words

Class EndnoteOptions

java.lang.Object

com.aspose.words.EndnoteOptions

public final class EndnoteOptions
extends java.lang.Object

Represents the endnote numbering options for a document or section.

See Also:

Document.getEndnoteOptions(), PageSetup.getEndnoteOptions()

Method Summary

Modifier and Type	Method and Description
int	getLocation()
int	getNumberStyle() Specifies the number format for automatically numbered endnotes.
int	getPosition() Specifies the endnotes position.
int	getRestartRule() Determines when automatic numbering restarts.
int	getStartNumber() Specifies the starting number or character for the first automatically numbered endnotes.
void	setLocation(int value)
void	setNumberStyle(int value) Specifies the number format for automatically numbered endnotes.
void	setPosition(int value) Specifies the endnotes 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 endnotes.

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 endnotes position.

Returns:

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

setPosition

public final void setPosition(int value)

Specifies the endnotes position.

Parameters:

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

getNumberStyle

public final int getNumberStyle()

Specifies the number format for automatically numbered endnotes.

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

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

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

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.

Not all values are applicable to endnotes. To ascertain which values are applicable see FootnoteNumberingRule.

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.

Not all values are applicable to endnotes. To ascertain which values are applicable see FootnoteNumberingRule.

Parameters:

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

getLocation

public final int getLocation()

setLocation

public final void setLocation(int value)