PdfPageLabel Class

Namespace: Meziantou.Framework.Pdf
Assembly: Meziantou.Framework.Pdf.dll
Package: Meziantou.Framework.Pdf 1.0.7
Source: PdfPageLabel.cs
Available in package assets: net10.0net11.0

The labelling of a range of pages (ISO 32000-2, 12.4.2): a numbering style, a prefix and the number of its first page.

public sealed class PdfPageLabel : IEquatable<PdfPageLabel>

Implements

IEquatable<PdfPageLabel>

Constructors

Name	Description
PdfPageLabel(PdfPageLabelStyle, string?, int)	Initializes a new instance of the `PdfPageLabel` class.

PdfPageLabel(PdfPageLabelStyle, string?, int)

PdfPageLabel.cs

Initializes a new instance of the PdfPageLabel class.

public PdfPageLabel(PdfPageLabelStyle style, string? prefix = null, int startNumber = 1)

Parameters

style PdfPageLabelStyle: The numbering style.
prefix string?: The text before the number, or null.
startNumber int: The number of the first page of the range, 1 or more.

Exceptions

ArgumentOutOfRangeException: startNumber is less than 1.

Properties

Name	Description
Prefix	Gets the text before the number, or `null`.
StartNumber	Gets the number of the first page of the range.
Style	Gets the numbering style.

Prefix

PdfPageLabel.cs

Gets the text before the number, or null.

public string? Prefix { get; }

Property value

string?

StartNumber

PdfPageLabel.cs

Gets the number of the first page of the range.

public int StartNumber { get; }

Property value

int

Style

PdfPageLabel.cs

Gets the numbering style.

public PdfPageLabelStyle Style { get; }

Property value

PdfPageLabelStyle

Methods

Name	Description
Equals(PdfPageLabel?)
Equals(object?)
GetHashCode()
GetLabel(int)	Gets the label of a page of the range.
ToString()

Equals overloads

Equals(PdfPageLabel?)

public bool Equals(PdfPageLabel? other)

Parameters

other PdfPageLabel?

Returns

bool

No documentation is available.

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

No documentation is available.

GetHashCode()

public override int GetHashCode()

Returns

int

No documentation is available.

GetLabel(int)

PdfPageLabel.cs

Gets the label of a page of the range.

public string GetLabel(int offset)

Parameters

offset int: The index of the page in the range, from 0.

Returns

string The label: the prefix followed by the number of the page in the style.

ToString()

public override string ToString()

Returns

string

No documentation is available.

Operators

Name	Description
operator ==(PdfPageLabel?, PdfPageLabel?)
operator !=(PdfPageLabel?, PdfPageLabel?)

operator ==(PdfPageLabel?, PdfPageLabel?)

public static bool operator ==(PdfPageLabel? left, PdfPageLabel? right)

Parameters

left PdfPageLabel?
right PdfPageLabel?

Returns

bool

No documentation is available.

operator !=(PdfPageLabel?, PdfPageLabel?)

public static bool operator !=(PdfPageLabel? left, PdfPageLabel? right)

Parameters

left PdfPageLabel?
right PdfPageLabel?

Returns

bool

No documentation is available.