PdfBatesNumbering Class

Bates numbering: a number stamped on every page, in sequence across the documents of a production, with a prefix and a suffix, such as ABC000123. The number of a page is PdfBatesNumbering.StartNumber plus the index of the page.

public sealed class PdfBatesNumbering

Constructors

NameDescription
PdfBatesNumbering()

PdfBatesNumbering()

PdfBatesNumbering.cs
public PdfBatesNumbering()

No documentation is available.

Properties

NameDescription
DigitsGets the least number of digits of the number, padded with zeros. The default is 6.
PrefixGets the text before the number, such as the case code. The default is none.
StartNumberGets the number of the first page. The default is 1.
SuffixGets the text after the number. The default is none.

Gets the least number of digits of the number, padded with zeros. The default is 6.

public int Digits { get; init; }

Property value

int

Exceptions

ArgumentOutOfRangeException
The value is not between 1 and 18.

Gets the text before the number, such as the case code. The default is none.

public string Prefix { get; init; }

Property value

string

Gets the number of the first page. The default is 1.

public long StartNumber { get; init; }

Property value

long

Exceptions

ArgumentOutOfRangeException
The value is negative.

Gets the text after the number. The default is none.

public string Suffix { get; init; }

Property value

string

Methods

NameDescription
Format(long)Formats a Bates number: the prefix, the number padded to PdfBatesNumbering.Digits, the suffix.

Formats a Bates number: the prefix, the number padded to PdfBatesNumbering.Digits, the suffix.

public string Format(long number)

Parameters

number long
The number.

Returns

string The text.