# PageLabel Class

> Describes numbering labels for a range of pages.

- Product: Adobe PDF Library 18
- Language: Java
- Version: APDFL18.0.5PlusP2e
- HTML page: https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/PageLabel
- Version index: https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/llms.txt

```java
class PageLabel
```

**Namespace:** `com::datalogics::PDFL`

## Description

Describes numbering labels for a range of pages. PageLabel describes how to construct a label string for a range of pages. It contains information on number style, any prefixes, and a starting position within the document.

Note that a single PageLabel describes the label string for several pages all pages up until the first page covered by the next PageLabel, or the end of the document.

Also note that if a Document has any PageLabels, there must be one that starts at page index 0. This will be automatically created if the user does not supply one.

**Referenced by:** [`Document`](https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/Document.md), [`PageLabelVector`](https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/PageLabelVector.md)

## Constructors

### PageLabel

```java
com.datalogics.PDFL.PageLabel.PageLabel(int start, NumberStyle ns)
```

*constructor*

**Parameters**

- `start` (`int`): Starting page index in the Document for this range
- `ns` (`NumberStyle`): Numbering style for this range

Convenience constructor creates a range with no prefix starting with number 1.

### PageLabel

```java
com.datalogics.PDFL.PageLabel.PageLabel(int start, NumberStyle ns, String p, int first)
```

*constructor*

**Parameters**

- `start` (`int`): Starting page index in the Document for this range
- `ns` (`NumberStyle`): Numbering style for this range
- `p` (`String`): Prefix string for this range
- `first` (`int`): First number appearing on a page in this range

Public constructor

## Methods

### delete

```java
synchronized void com.datalogics.PDFL.PageLabel.delete(Boolean disposing)
```

*protected*

**Parameters**

- `disposing` (`Boolean`)

**Returns:** `synchronized void`

### delete

```java
synchronized void com.datalogics.PDFL.PageLabel.delete()
```

**Returns:** `synchronized void`

### finalize

```java
void com.datalogics.PDFL.PageLabel.finalize()
```

*protected*

**Returns:** `void`

### getEndPageIndex

```java
int com.datalogics.PDFL.PageLabel.getEndPageIndex()
```

**Returns:** `int`

The zero-based ending page index for this page label range. You cannot set the end index for a range; you must change the start index for the following range. A value of -1 means the end index for this PageLabel is unknown (e.g. when the label has not yet been added to a Document).

### getFirstNumberInRange

```java
int com.datalogics.PDFL.PageLabel.getFirstNumberInRange()
```

**Returns:** `int`

The first numeric value used for page labels in this range. Must be greater than or equal to 1.

### getNumberStyle

```java
NumberStyle com.datalogics.PDFL.PageLabel.getNumberStyle()
```

**Returns:** `NumberStyle`

The NumberStyle used for generating page labels in this range.

### getPrefix

```java
String com.datalogics.PDFL.PageLabel.getPrefix()
```

**Returns:** `String`

The prefix string prepended to page labels in this range. For example, a prefix of "A-" with decimal numbering starting at 1 would produce labels "A-1", "A-2", "A-3", etc.

### getStartPageIndex

```java
int com.datalogics.PDFL.PageLabel.getStartPageIndex()
```

**Returns:** `int`

The zero-based starting page index for this page label range in the Document.

### setFirstNumberInRange

```java
void com.datalogics.PDFL.PageLabel.setFirstNumberInRange(int arg0)
```

**Parameters**

- `arg0` (`int`)

**Returns:** `void`

The first numeric value used for page labels in this range.

### setNumberStyle

```java
void com.datalogics.PDFL.PageLabel.setNumberStyle(NumberStyle arg0)
```

**Parameters**

- `arg0` (`NumberStyle`)

**Returns:** `void`

The NumberStyle used for generating page labels in this range.

### setPrefix

```java
void com.datalogics.PDFL.PageLabel.setPrefix(String arg0)
```

**Parameters**

- `arg0` (`String`)

**Returns:** `void`

The prefix string prepended to page labels in this range.

### setStartPageIndex

```java
void com.datalogics.PDFL.PageLabel.setStartPageIndex(int ndx)
```

**Parameters**

- `ndx` (`int`)

**Returns:** `void`

The zero-based starting page index for this page label range in the Document.

### toString

```java
String com.datalogics.PDFL.PageLabel.toString()
```

**Returns:** `String`

A string describing this PageLabel.

Returns a string representation of this PageLabel. The string includes the start page, end page, number style, prefix, and first page number of this label range.