com.ironsoftware.ironpdf.render

Enum TableOfContentsTypes

java.lang.Object

java.lang.Enum<TableOfContentsTypes>

com.ironsoftware.ironpdf.render.TableOfContentsTypes

All Implemented Interfaces:

Serializable, Comparable<TableOfContentsTypes>

public enum TableOfContentsTypes
extends Enum<TableOfContentsTypes>

Table of contents layout type

Enum Constant Summary

Enum Constants

Enum Constant and Description
Basic Create a table of contents without page numbers More performance, but does not include page numbers
None Do not create a table of contents
WithPageNumbers Create a table of contents with page numbers

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

None

public static final TableOfContentsTypes None

Do not create a table of contents

Basic

public static final TableOfContentsTypes Basic

Create a table of contents without page numbers More performance, but does not include page numbers

WithPageNumbers

public static final TableOfContentsTypes WithPageNumbers

Create a table of contents with page numbers

Method Detail

values

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

Returns:

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

valueOf

public static TableOfContentsTypes 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

getValue

public int getValue()