com.groupdocs.viewer.options

Enum WordsPageNumberLocation

java.lang.Object

java.lang.Enum<WordsPageNumberLocation>

com.groupdocs.viewer.options.WordsPageNumberLocation

All Implemented Interfaces:

Serializable, Comparable<WordsPageNumberLocation>

public enum WordsPageNumberLocation
extends Enum<WordsPageNumberLocation>

Controls whether to forcibly apply page numbering to the loaded WordProcessing document and, if yes, where to place page numbers.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM_CENTER Put the page number in the bottom center of the page.
BOTTOM_LEFT Put the page number in the bottom left corner of the page.
BOTTOM_RIGHT Put the page number in the bottom right corner of the page.
NOT_APPLY Leave the loaded WordProcessing document intact.
TOP_CENTER Put the page number in the top center of the page.
TOP_LEFT Put the page number in the top left corner of the page.
TOP_RIGHT Put the page number in the top right corner of the page.

Method Summary

Modifier and Type	Method and Description
static WordsPageNumberLocation	valueOf(String name) Returns the enum constant of this type with the specified name.
static WordsPageNumberLocation[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BOTTOM_CENTER

public static final WordsPageNumberLocation BOTTOM_CENTER

Put the page number in the bottom center of the page.

BOTTOM_LEFT

public static final WordsPageNumberLocation BOTTOM_LEFT

Put the page number in the bottom left corner of the page.

BOTTOM_RIGHT

public static final WordsPageNumberLocation BOTTOM_RIGHT

Put the page number in the bottom right corner of the page.

NOT_APPLY

public static final WordsPageNumberLocation NOT_APPLY

Leave the loaded WordProcessing document intact. Default value.

TOP_CENTER

public static final WordsPageNumberLocation TOP_CENTER

Put the page number in the top center of the page.

TOP_LEFT

public static final WordsPageNumberLocation TOP_LEFT

Put the page number in the top left corner of the page.

TOP_RIGHT

public static final WordsPageNumberLocation TOP_RIGHT

Put the page number in the top right corner of the page.

Method Detail

valueOf

public static WordsPageNumberLocation valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

values

public static WordsPageNumberLocation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WordsPageNumberLocation c : WordsPageNumberLocation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared