Click or drag to resize
Pdftools logo

PagePageLabel Property

Page label

The label for this page. A page does not have to have a label and if it doesn't this property will be an empty string.

If it exists, a page label is designed to replace the page number in visual presentations and consists of an optional prefix and a number. Number can be in one of several styles (arabic, Roman, alphabetic) and starts at an arbitrary number for a range of pages.

Page labels are used to set distinct names or numbers, most often for preface, appendices and similar sections of the document.


Namespace: PdfTools.Toolbox.Pdf
Assembly: PdfTools.Toolbox (in PdfTools.Toolbox.dll) Version: 1.4.0+02318d3e3f9645a1305b87026fb971a660079e54
Syntax
C#
public string PageLabel { get; }

Property Value

String
Exceptions
ExceptionCondition
InvalidOperationExceptionIf the document has already been closed.
See Also