PageLabelCollection
Overview
PageLabelCollection is a class in Aspose.PDF FOSS for .NET.
Inherits from: IEnumerable<PageLabel>.
Collection of page label ranges from the /PageLabels number tree.
This class provides 8 methods for working with PageLabelCollection objects in .NET programs.
Available methods include: At, FormatLabel, GetEnumerator, GetLabel, GetLabelForPage, GetPages, RemoveLabel, UpdateLabel.
All public members are accessible to any .NET application after installing the Aspose.PDF FOSS for .NET package.
Properties: Count, Labels.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
Labels | IReadOnlyList<PageLabel> | Read | All label ranges. |
Count | int | Read | Number of label ranges. |
Methods
| Signature | Description |
|---|---|
At(index: int) | Get a label range by 0-based index. |
GetLabelForPage(pageIndex: int) | Get the formatted display label for a 0-based page index. |
GetEnumerator() | Calls GetEnumerator on this PageLabelCollection instance. |
GetLabel(pageIndex: int) | Find the label range that contains pageIndex (0-based). |
GetPages() | The 0-based page indices at which a label range begins. |
RemoveLabel(pageIndex: int) | Remove the label range starting at pageIndex (0-based). |
UpdateLabel(pageIndex: int, pageLabel: PageLabel) | Replace the label range at pageIndex with pageLabel. |
FormatLabel(pageIndex: int) | Format the page label for a 0-based page index. |