Get Started

API Reference

Class

PdfFooterBuilder

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:10
Modifiers sealed

Footer builder (alignment, text, page number tokens).

Inheritance

  • Object
  • PdfFooterBuilder

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Methods

public PdfFooterBuilder AlignCenter() #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:12
Returns: PdfFooterBuilder

Sets footer alignment to the center.

public PdfFooterBuilder AlignLeft() #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:10
Returns: PdfFooterBuilder

Sets footer alignment to the left.

public PdfFooterBuilder AlignRight() #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:14
Returns: PdfFooterBuilder

Sets footer alignment to the right.

public PdfFooterBuilder Color(PdfColor color) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:16
Returns: PdfFooterBuilder

Sets footer text color.

Parameters

color OfficeIMO.Pdf.PdfColor requiredposition: 0
EvenPagesImage 3 overloads
public PdfFooterBuilder EvenPagesImage(Byte[] data, Double width, Double height, PdfAlign align = Left, OfficeImageFit fit = Stretch) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:75
Returns: PdfFooterBuilder

Adds an image to the even-page-only footer.

Parameters

data System.Byte[] requiredposition: 0
width System.Double requiredposition: 1
height System.Double requiredposition: 2
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 3
fit OfficeIMO.Drawing.OfficeImageFit = Stretch optionalposition: 4
public PdfFooterBuilder EvenPagesImage(Byte[] data, Double width, Double height, String alternativeText) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:79
Returns: PdfFooterBuilder

Adds a meaningful image to the even-page-only footer with alternate text.

Parameters

data System.Byte[] requiredposition: 0
width System.Double requiredposition: 1
height System.Double requiredposition: 2
alternativeText System.String requiredposition: 3
public PdfFooterBuilder EvenPagesImage(Byte[] data, Double width, Double height, PdfAlign align, OfficeImageFit fit, String alternativeText) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:83
Returns: PdfFooterBuilder

Adds an image to the even-page-only footer.

Parameters

data System.Byte[] requiredposition: 0
width System.Double requiredposition: 1
height System.Double requiredposition: 2
align OfficeIMO.Pdf.PdfAlign requiredposition: 3
fit OfficeIMO.Drawing.OfficeImageFit requiredposition: 4
alternativeText System.String requiredposition: 5
public PdfFooterBuilder EvenPagesShape(OfficeShape shape, PdfAlign align = Left) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:101
Returns: PdfFooterBuilder

Adds a shape to the even-page-only footer.

Parameters

shape OfficeIMO.Drawing.OfficeShape requiredposition: 0
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 1
EvenPagesText 2 overloads
public PdfFooterBuilder EvenPagesText(String format) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:150
Returns: PdfFooterBuilder

Renders an even-page-only footer text format. Supports {page} and {pages}.

Parameters

format System.String requiredposition: 0
public PdfFooterBuilder EvenPagesText(Action<FooterTextBuilder> build) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:161
Returns: PdfFooterBuilder

Builds an even-page-only footer from text and tokens.

Parameters

build System.Action{OfficeIMO.Pdf.FooterTextBuilder} requiredposition: 0
Delegate to compose even-page footer segments.
public PdfFooterBuilder EvenPagesZones(String left, String center, String right) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:41
Returns: PdfFooterBuilder

Renders even-page-only left, center, and right footer zones. Supports {page} and {pages}.

Parameters

left System.String requiredposition: 0
center System.String requiredposition: 1
right System.String requiredposition: 2
FirstPageImage 3 overloads
public PdfFooterBuilder FirstPageImage(Byte[] data, Double width, Double height, PdfAlign align = Left, OfficeImageFit fit = Stretch) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:61
Returns: PdfFooterBuilder

Adds an image to the page-1-only footer.

Parameters

data System.Byte[] requiredposition: 0
width System.Double requiredposition: 1
height System.Double requiredposition: 2
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 3
fit OfficeIMO.Drawing.OfficeImageFit = Stretch optionalposition: 4
public PdfFooterBuilder FirstPageImage(Byte[] data, Double width, Double height, String alternativeText) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:65
Returns: PdfFooterBuilder

Adds a meaningful image to the page-1-only footer with alternate text.

Parameters

data System.Byte[] requiredposition: 0
width System.Double requiredposition: 1
height System.Double requiredposition: 2
alternativeText System.String requiredposition: 3
public PdfFooterBuilder FirstPageImage(Byte[] data, Double width, Double height, PdfAlign align, OfficeImageFit fit, String alternativeText) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:69
Returns: PdfFooterBuilder

Adds an image to the page-1-only footer.

Parameters

data System.Byte[] requiredposition: 0
width System.Double requiredposition: 1
height System.Double requiredposition: 2
align OfficeIMO.Pdf.PdfAlign requiredposition: 3
fit OfficeIMO.Drawing.OfficeImageFit requiredposition: 4
alternativeText System.String requiredposition: 5
public PdfFooterBuilder FirstPageShape(OfficeShape shape, PdfAlign align = Left) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:95
Returns: PdfFooterBuilder

Adds a shape to the page-1-only footer.

Parameters

shape OfficeIMO.Drawing.OfficeShape requiredposition: 0
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 1
FirstPageText 2 overloads
public PdfFooterBuilder FirstPageText(String format) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:129
Returns: PdfFooterBuilder

Renders a page-1-only footer text format. Supports {page} and {pages}.

Parameters

format System.String requiredposition: 0
public PdfFooterBuilder FirstPageText(Action<FooterTextBuilder> build) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:140
Returns: PdfFooterBuilder

Builds a page-1-only footer from text and tokens.

Parameters

build System.Action{OfficeIMO.Pdf.FooterTextBuilder} requiredposition: 0
Delegate to compose first-page footer segments.
public PdfFooterBuilder FirstPageZones(String left, String center, String right) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:36
Returns: PdfFooterBuilder

Renders page-1-only left, center, and right footer zones. Supports {page} and {pages}.

Parameters

left System.String requiredposition: 0
center System.String requiredposition: 1
right System.String requiredposition: 2
public PdfFooterBuilder Font(PdfStandardFont font) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:18
Returns: PdfFooterBuilder

Sets footer font.

Parameters

font OfficeIMO.Pdf.PdfStandardFont requiredposition: 0
public PdfFooterBuilder FontFamily(String familyName) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:20
Returns: PdfFooterBuilder

Uses a registered named font family for footer text.

Parameters

familyName System.String requiredposition: 0
public PdfFooterBuilder FontSize(Double size) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:22
Returns: PdfFooterBuilder

Sets footer font size in points.

Parameters

size System.Double requiredposition: 0
Image 3 overloads
public PdfFooterBuilder Image(Byte[] data, Double width, Double height, PdfAlign align = Left, OfficeImageFit fit = Stretch) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:47
Returns: PdfFooterBuilder

Adds an image to the running footer.

Parameters

data System.Byte[] requiredposition: 0
width System.Double requiredposition: 1
height System.Double requiredposition: 2
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 3
fit OfficeIMO.Drawing.OfficeImageFit = Stretch optionalposition: 4
public PdfFooterBuilder Image(Byte[] data, Double width, Double height, String alternativeText) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:51
Returns: PdfFooterBuilder

Adds a meaningful image to the running footer with alternate text.

Parameters

data System.Byte[] requiredposition: 0
width System.Double requiredposition: 1
height System.Double requiredposition: 2
alternativeText System.String requiredposition: 3
public PdfFooterBuilder Image(Byte[] data, Double width, Double height, PdfAlign align, OfficeImageFit fit, String alternativeText) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:55
Returns: PdfFooterBuilder

Adds an image to the running footer.

Parameters

data System.Byte[] requiredposition: 0
width System.Double requiredposition: 1
height System.Double requiredposition: 2
align OfficeIMO.Pdf.PdfAlign requiredposition: 3
fit OfficeIMO.Drawing.OfficeImageFit requiredposition: 4
alternativeText System.String requiredposition: 5
public PdfFooterBuilder Offset(Double points) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:24
Returns: PdfFooterBuilder

Sets footer baseline offset below the bottom margin in points.

Parameters

points System.Double requiredposition: 0
public PdfFooterBuilder PageNumber() #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:26
Returns: PdfFooterBuilder

Renders the current page number in the footer.

public PdfFooterBuilder PageNumberWithTotal() #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:28
Returns: PdfFooterBuilder

Renders the current page number and total pages in the footer.

public PdfFooterBuilder Shape(OfficeShape shape, PdfAlign align = Left) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:89
Returns: PdfFooterBuilder

Adds a shape to the running footer.

Parameters

shape OfficeIMO.Drawing.OfficeShape requiredposition: 0
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 1
Text 2 overloads
public PdfFooterBuilder Text(String format) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:107
Returns: PdfFooterBuilder

Renders a literal footer text format. Supports {page} and {pages}.

Parameters

format System.String requiredposition: 0
public PdfFooterBuilder Text(Action<FooterTextBuilder> build) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:118
Returns: PdfFooterBuilder

Builds a custom footer from text and tokens.

Parameters

build System.Action{OfficeIMO.Pdf.FooterTextBuilder} requiredposition: 0
Delegate to compose footer segments.
public PdfFooterBuilder Zones(String left, String center, String right) #
OfficeIMO.Pdf/Compose/PdfFooterBuilder.cs:31
Returns: PdfFooterBuilder

Renders left, center, and right footer zones on one line. Supports {page} and {pages}.

Parameters

left System.String requiredposition: 0
center System.String requiredposition: 1
right System.String requiredposition: 2