PageLabelCollection

Inheritance: java.lang.Object, com.aspose.pdf.PageLabelCollection

public class PageLabelCollection extends Object

Class represeingting page label collection.

Methods

MethodDescription
getLabelGets page label by page index (page index is started from 0).
getPagesGets page indexes in collection.
removeLabelRemove label by page index (page index is started from 0).
updateLabelUpdate label for given page index (page index is started from 0).

getLabel

public PageLabel getLabel(int pageIndex)

Gets page label by page index (page index is started from 0).

Parameters:

ParameterTypeDescription
pageIndexIndex of the page.

Returns: Page label for specified page index or null if page label does not exist.

getPages

public int[] getPages()

Gets page indexes in collection.

Returns: Array of integers which contains indexes of the pages.

removeLabel

public boolean removeLabel(int pageIndex)

Remove label by page index (page index is started from 0).

Parameters:

ParameterTypeDescription
pageIndexIndex of page where label must be deleted.

Returns: true if operation was executed successfully.

updateLabel

Update label for given page index (page index is started from 0).