PDFBatesNumberProvider¶

Namespace: O2S.Components.PDF4NET.Content

Defines a Bates number provider.

public class PDFBatesNumberProvider

Inheritance Object → PDFBatesNumberProvider

Remarks

The Bates number provider will generate an actual Bates number for each page based on its properties.

Constructors¶

PDFBatesNumberProvider()¶

Initializes a new PDFBatesNumberProvider object.

public PDFBatesNumberProvider()

Properties¶

NumberOfDigits¶

Gets or sets the number of digits.

public int NumberOfDigits { get; set; }

Property Value

Int32
The number of digits, including the leading zeros, for representing the Bates number.

Prefix¶

Gets or sets the prefix.

public string Prefix { get; set; }

Property Value

String
An optional prefix to be displayed in front of the Bates number.

StartNumber¶

Gets or sets the start number.

public int StartNumber { get; set; }

Property Value

Int32
The start number to be used on first stamped page.

Suffix¶

Gets or sets the suffix.

public string Suffix { get; set; }

Property Value

String
An optional suffix to be displayed at the end of the Bates number.

Methods¶

GetBatesNumber(Int32)¶

Gets the Bates number for the specified page.

public string GetBatesNumber(int pageIndex)

Parameters

pageIndex Int32
The page number for which the Bates stamp text is generated.

Returns

String
The Bates number stamp text.