com.groupdocs.redaction.redactions

Enum PageSeekOrigin

java.lang.Object

java.lang.Enum<PageSeekOrigin>

com.groupdocs.redaction.redactions.PageSeekOrigin

All Implemented Interfaces:

Serializable, Comparable<PageSeekOrigin>

public enum PageSeekOrigin
extends Enum<PageSeekOrigin>

Provides the fields that represent reference points in a document for seeking.

Learn more

• More details about removing pages: Remove page redaction

Enum Constant Summary

Enum Constants

Enum Constant and Description
Begin Specifies the beginning of a document.
End Specifies the end of a document.

Method Summary

Modifier and Type	Method and Description
static PageSeekOrigin	valueOf(String name) Returns the enum constant of this type with the specified name.
static PageSeekOrigin[]	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

Begin

public static final PageSeekOrigin Begin

Specifies the beginning of a document.

End

public static final PageSeekOrigin End

Specifies the end of a document.

Method Detail

valueOf

public static PageSeekOrigin 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 PageSeekOrigin[] 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 (PageSeekOrigin c : PageSeekOrigin.values())
    System.out.println(c);

Returns:

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