Class PdfPageNumberField

Namespace

Syncfusion.Pdf

Assembly

Syncfusion.Pdf.Portable.dll

Represents PDF document page number field.

public class PdfPageNumberField : PdfMultipleNumberValueField

Inheritance

object

PdfGraphicsElement

PdfAutomaticField

PdfDynamicField

PdfMultipleValueField

PdfMultipleNumberValueField

PdfPageNumberField

Derived

PdfDestinationPageNumberField

Inherited Members

PdfMultipleNumberValueField.NumberStyle

PdfMultipleValueField.PerformDraw(PdfGraphics, PointF, float, float)

PdfMultipleValueField.PdfTag

PdfAutomaticField.Draw(PdfGraphics, float, float)

PdfAutomaticField.ObtainSize()

PdfAutomaticField.DrawInternal(PdfGraphics)

PdfAutomaticField.ObtainBrush()

PdfAutomaticField.ObtainFont()

PdfAutomaticField.Bounds

PdfAutomaticField.Size

PdfAutomaticField.Location

PdfAutomaticField.Font

PdfAutomaticField.Brush

PdfAutomaticField.Pen

PdfAutomaticField.StringFormat

PdfGraphicsElement.Draw(PdfGraphics)

PdfGraphicsElement.Draw(PdfGraphics, PointF)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

//Create a new document
PdfDocument doc = new PdfDocument();         
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 12f);            
//Creates page number field
PdfPageNumberField pageNumber = new PdfPageNumberField(font);
pageNumber.NumberStyle = PdfNumberStyle.UpperLatin;
for (int i = 0; i != 2; i++)
{
PdfPage page = doc.Pages.Add();
pageNumber.Draw(page.Graphics);
}
doc.Save("PageNumberField.pdf");
doc.Close(true);

'Create a new document
Dim doc As PdfDocument = New PdfDocument()
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Helvetica, 12f)
'Creates page number field
Dim pageNumber As PdfPageNumberField = New PdfPageNumberField(font)
pageNumber.NumberStyle = PdfNumberStyle.UpperLatin
For i As Integer = 0 To 1
  Dim page As PdfPage = doc.Pages.Add()
  pageNumber.Draw(page.Graphics)
Next i
doc.Save("PageNumberField.pdf")
doc.Close(True)

Constructors

PdfPageNumberField()

Initializes a new instance of the PdfPageNumberField class.

public PdfPageNumberField()

Examples

// Create a new document
PdfDocument doc = new PdfDocument();                  
// Creates page number field
PdfPageNumberField pageNumber = new PdfPageNumberField();
pageNumber.NumberStyle = PdfNumberStyle.UpperLatin;
for (int i = 0; i != 2; i++)
{
PdfPage page = doc.Pages.Add();
pageNumber.Draw(page.Graphics);
}
doc.Save("PageNumberField.pdf");
doc.Close(true);

' Create a new document
Dim doc As PdfDocument = New PdfDocument()
' Creates page number field
Dim pageNumber As PdfPageNumberField = New PdfPageNumberField()
pageNumber.NumberStyle = PdfNumberStyle.UpperLatin
For i As Integer = 0 To 1
  Dim page As PdfPage = doc.Pages.Add()
  pageNumber.Draw(page.Graphics)
Next i
doc.Save("PageNumberField.pdf")
doc.Close(True)

See Also

PdfMultipleNumberValueField

PdfPageNumberField(PdfFont)

Initializes a new instance of the PdfPageNumberField class with PdfFont

public PdfPageNumberField(PdfFont font)

Parameters

font PdfFont

A PdfFont object that specifies the font attributes (the family name, the size, and the style of the font) to use.

Examples

// Creates a new document
PdfDocument doc = new PdfDocument();         
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 12f);            
// Creates page number field
PdfPageNumberField pageNumber = new PdfPageNumberField(font);
pageNumber.NumberStyle = PdfNumberStyle.UpperLatin;
for (int i = 0; i != 2; i++)
{
PdfPage page = doc.Pages.Add();
pageNumber.Draw(page.Graphics);
}
doc.Save("PageNumberField.pdf");
doc.Close(true);

' Creates a new document
Dim doc As PdfDocument = New PdfDocument()
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Helvetica, 12f)
' Creates page number field
Dim pageNumber As PdfPageNumberField = New PdfPageNumberField(font)
pageNumber.NumberStyle = PdfNumberStyle.UpperLatin
For i As Integer = 0 To 1
  Dim page As PdfPage = doc.Pages.Add()
  pageNumber.Draw(page.Graphics)
Next i
doc.Save("PageNumberField.pdf")
doc.Close(True)

See Also

PdfMultipleNumberValueField

PdfPageNumberField(PdfFont, RectangleF)

Initializes a new instance of the PdfPageNumberField class with PdfFont and rectangle bounds.

public PdfPageNumberField(PdfFont font, RectangleF bounds)

Parameters

font PdfFont

A PdfFont object that specifies the font attributes (the family name, the size, and the style of the font) to use.s

bounds RectangleF

The bounds.

Examples

// Creates a new document
PdfDocument doc = new PdfDocument();         
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 12f);            
// Creates page number field
PdfPageNumberField pageNumber = new PdfPageNumberField(font, new RectangleF(10, 10, 100, 200));
pageNumber.NumberStyle = PdfNumberStyle.UpperLatin;
for (int i = 0; i != 2; i++)
{
PdfPage page = doc.Pages.Add();
pageNumber.Draw(page.Graphics);
}
doc.Save("PageNumberField.pdf");
doc.Close(true);

' Creates a new document
Dim doc As PdfDocument = New PdfDocument()
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Helvetica, 12f)
' Creates page number field
PdfPageNumberField pageNumber = new PdfPageNumberField(font, new RectangleF(10, 10, 100, 200));
pageNumber.NumberStyle = PdfNumberStyle.UpperLatin
For i As Integer = 0 To 1
  Dim page As PdfPage = doc.Pages.Add()
  pageNumber.Draw(page.Graphics)
Next i
doc.Save("PageNumberField.pdf")
doc.Close(True)

See Also

PdfMultipleNumberValueField

PdfPageNumberField(PdfFont, PdfBrush)

Initializes a new instance of the PdfPageNumberField class with PdfFont and PdfBrush.

public PdfPageNumberField(PdfFont font, PdfBrush brush)

Parameters

font PdfFont

A PdfFont object that specifies the font attributes (the family name, the size, and the style of the font) to use.

brush PdfBrush

A PdfBrush object that is used to fill the string.

Examples

// Creates a new document
PdfDocument doc = new PdfDocument();         
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 12f);            
// Creates page number field
PdfPageNumberField pageNumber = new PdfPageNumberField(font, PdfBrushes.Beige);
pageNumber.NumberStyle = PdfNumberStyle.UpperLatin;
for (int i = 0; i!=2; i++)
{
PdfPage page = doc.Pages.Add();
pageNumber.Draw(page.Graphics);
}
doc.Save("PageNumberField.pdf");
doc.Close(true);

' Creates a new document
Dim doc As PdfDocument = New PdfDocument()
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Helvetica, 12f)
' Creates page number field
Dim pageNumber As PdfPageNumberField = New PdfPageNumberField(font, PdfBrushes.Beige)
pageNumber.NumberStyle = PdfNumberStyle.UpperLatin
For i As Integer = 0 To 1
  Dim page As PdfPage = doc.Pages.Add()
  pageNumber.Draw(page.Graphics)
Next i
doc.Save("PageNumberField.pdf")
doc.Close(True)

See Also

PdfMultipleNumberValueField

Methods

GetValue(PdfGraphics)

Gets the value of the field at the specified graphics.

protected override string GetValue(PdfGraphics graphics)

Parameters

graphics PdfGraphics

The graphics.

Returns

string

result

See Also

PdfMultipleNumberValueField

InternalGetValue(PdfPage)

Internal method to get value of the field.

protected string InternalGetValue(PdfPage page)

Parameters

page PdfPage

The page.

Returns

string

See Also

PdfMultipleNumberValueField

InternalLoadedGetValue(PdfLoadedPage)

Internal method to get value of the field.

protected string InternalLoadedGetValue(PdfLoadedPage page)

Parameters

page PdfLoadedPage

The page

Returns

string

See Also

PdfMultipleNumberValueField

See Also

PdfMultipleNumberValueField