API Reference
PdfFooterBuilder
Footer builder (alignment, text, page number tokens).
Inheritance
- Object
- PdfFooterBuilder
Usage
Explore 29 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 28
- Method PdfFooterBuilder.AlignCenter
- Method PdfFooterBuilder.AlignLeft
- Method PdfFooterBuilder.AlignRight
- Method PdfFooterBuilder.Color
- Method PdfFooterBuilder.Content
- Method PdfFooterBuilder.EvenPagesContent
- Method PdfFooterBuilder.EvenPagesImage
- Method PdfFooterBuilder.EvenPagesShape
- Method PdfFooterBuilder.EvenPagesStyledZones
- Method PdfFooterBuilder.EvenPagesText
- Method PdfFooterBuilder.EvenPagesZones
- Method PdfFooterBuilder.FirstPageContent
- Method PdfFooterBuilder.FirstPageImage
- Method PdfFooterBuilder.FirstPageShape
- Method PdfFooterBuilder.FirstPageStyledZones
- Method PdfFooterBuilder.FirstPageText
- Method PdfFooterBuilder.FirstPageZones
- Method PdfFooterBuilder.Font
- Method PdfFooterBuilder.FontFamily
- Method PdfFooterBuilder.FontSize
- Method PdfFooterBuilder.Image
- Method PdfFooterBuilder.Offset
- Method PdfFooterBuilder.PageNumber
- Method PdfFooterBuilder.PageNumberWithTotal
- Method PdfFooterBuilder.Shape
- Method PdfFooterBuilder.StyledZones
- Method PdfFooterBuilder.Text
- Method PdfFooterBuilder.Zones
Accepted by parameters 1
- Method PdfPageBuilder.Footer
Methods
public PdfFooterBuilder AlignCenter() #PdfFooterBuilderSets footer alignment to the center.
public PdfFooterBuilder Color(PdfColor color) #PdfFooterBuilderSets footer text color.
Parameters
- color OfficeIMO.Pdf.PdfColor
public PdfFooterBuilder Content(Action<PdfContentBuilder> build, Double distanceFromEdge, Double bodyGap = 0) #PdfFooterBuilderReplaces the default footer with bounded document flow at a distance from the bottom page edge. Uses normal content-builder styles; content cannot create pages.
Parameters
- build System.Action<OfficeIMO.Pdf.PdfContentBuilder>
- distanceFromEdge System.Double
- bodyGap System.Double = 0
public PdfFooterBuilder Content(Func<PdfRunningContentContext, Action<PdfContentBuilder>> build, Double distanceFromEdge, Double bodyGap = 0) #PdfFooterBuilderComposes the default bounded footer from final page information. The factory can run during pagination stabilization and must be deterministic.
Parameters
- build System.Func<OfficeIMO.Pdf.PdfRunningContentContext, System.Action<OfficeIMO.Pdf.PdfContentBuilder>>
- distanceFromEdge System.Double
- bodyGap System.Double = 0
public PdfFooterBuilder EvenPagesContent(Action<PdfContentBuilder> build, Double distanceFromEdge, Double bodyGap = 0) #PdfFooterBuilderReplaces even-page footers with bounded flow measured from the bottom page edge.
Parameters
- build System.Action<OfficeIMO.Pdf.PdfContentBuilder>
- distanceFromEdge System.Double
- bodyGap System.Double = 0
public PdfFooterBuilder EvenPagesContent(Func<PdfRunningContentContext, Action<PdfContentBuilder>> build, Double distanceFromEdge, Double bodyGap = 0) #PdfFooterBuilderComposes bounded even-page footer flow from final page information.
Parameters
- build System.Func<OfficeIMO.Pdf.PdfRunningContentContext, System.Action<OfficeIMO.Pdf.PdfContentBuilder>>
- distanceFromEdge System.Double
- bodyGap System.Double = 0
public PdfFooterBuilder EvenPagesImage(Byte[] data, Double width, Double height, PdfAlign align = Left, OfficeImageFit fit = Stretch) #PdfFooterBuilderAdds an image to the even-page-only footer.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- align OfficeIMO.Pdf.PdfAlign = Left
- fit OfficeIMO.Drawing.OfficeImageFit = Stretch
public PdfFooterBuilder EvenPagesImage(Byte[] data, Double width, Double height, String? alternativeText) #PdfFooterBuilderAdds a meaningful image to the even-page-only footer with alternate text.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- alternativeText System.String?
public PdfFooterBuilder EvenPagesImage(Byte[] data, Double width, Double height, PdfAlign align, OfficeImageFit fit, String? alternativeText) #PdfFooterBuilderAdds an image to the even-page-only footer.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- align OfficeIMO.Pdf.PdfAlign
- fit OfficeIMO.Drawing.OfficeImageFit
- alternativeText System.String?
public PdfFooterBuilder EvenPagesShape(OfficeShape shape, PdfAlign align = Left) #PdfFooterBuilderAdds a shape to the even-page-only footer.
Parameters
- shape OfficeIMO.Drawing.OfficeShape
- align OfficeIMO.Pdf.PdfAlign = Left
public PdfFooterBuilder EvenPagesText(String format) #PdfFooterBuilderRenders an even-page-only footer text format. Supports {page} and {pages}.
Parameters
- format System.String
public PdfFooterBuilder EvenPagesZones(String? left, String? center, String? right) #PdfFooterBuilderRenders even-page-only left, center, and right footer zones. Supports {page} and {pages}.
Parameters
- left System.String?
- center System.String?
- right System.String?
public PdfFooterBuilder FirstPageContent(Action<PdfContentBuilder> build, Double distanceFromEdge, Double bodyGap = 0) #PdfFooterBuilderReplaces the first-page footer with bounded flow measured from the bottom page edge.
Parameters
- build System.Action<OfficeIMO.Pdf.PdfContentBuilder>
- distanceFromEdge System.Double
- bodyGap System.Double = 0
public PdfFooterBuilder FirstPageContent(Func<PdfRunningContentContext, Action<PdfContentBuilder>> build, Double distanceFromEdge, Double bodyGap = 0) #PdfFooterBuilderComposes bounded first-page footer flow from final page information.
Parameters
- build System.Func<OfficeIMO.Pdf.PdfRunningContentContext, System.Action<OfficeIMO.Pdf.PdfContentBuilder>>
- distanceFromEdge System.Double
- bodyGap System.Double = 0
public PdfFooterBuilder FirstPageImage(Byte[] data, Double width, Double height, PdfAlign align = Left, OfficeImageFit fit = Stretch) #PdfFooterBuilderAdds an image to the page-1-only footer.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- align OfficeIMO.Pdf.PdfAlign = Left
- fit OfficeIMO.Drawing.OfficeImageFit = Stretch
public PdfFooterBuilder FirstPageImage(Byte[] data, Double width, Double height, String? alternativeText) #PdfFooterBuilderAdds a meaningful image to the page-1-only footer with alternate text.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- alternativeText System.String?
public PdfFooterBuilder FirstPageImage(Byte[] data, Double width, Double height, PdfAlign align, OfficeImageFit fit, String? alternativeText) #PdfFooterBuilderAdds an image to the page-1-only footer.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- align OfficeIMO.Pdf.PdfAlign
- fit OfficeIMO.Drawing.OfficeImageFit
- alternativeText System.String?
public PdfFooterBuilder FirstPageShape(OfficeShape shape, PdfAlign align = Left) #PdfFooterBuilderAdds a shape to the page-1-only footer.
Parameters
- shape OfficeIMO.Drawing.OfficeShape
- align OfficeIMO.Pdf.PdfAlign = Left
public PdfFooterBuilder FirstPageText(String format) #PdfFooterBuilderRenders a page-1-only footer text format. Supports {page} and {pages}.
Parameters
- format System.String
public PdfFooterBuilder FirstPageZones(String? left, String? center, String? right) #PdfFooterBuilderRenders page-1-only left, center, and right footer zones. Supports {page} and {pages}.
Parameters
- left System.String?
- center System.String?
- right System.String?
public PdfFooterBuilder Font(PdfStandardFont font) #PdfFooterBuilderSets footer font.
Parameters
- font OfficeIMO.Pdf.PdfStandardFont
public PdfFooterBuilder FontFamily(String familyName) #PdfFooterBuilderUses a registered named font family for footer text.
Parameters
- familyName System.String
public PdfFooterBuilder FontSize(Double size) #PdfFooterBuilderSets footer font size in points.
Parameters
- size System.Double
public PdfFooterBuilder Image(Byte[] data, Double width, Double height, PdfAlign align = Left, OfficeImageFit fit = Stretch) #PdfFooterBuilderAdds an image to the running footer.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- align OfficeIMO.Pdf.PdfAlign = Left
- fit OfficeIMO.Drawing.OfficeImageFit = Stretch
public PdfFooterBuilder Image(Byte[] data, Double width, Double height, String? alternativeText) #PdfFooterBuilderAdds a meaningful image to the running footer with alternate text.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- alternativeText System.String?
public PdfFooterBuilder Image(Byte[] data, Double width, Double height, PdfAlign align, OfficeImageFit fit, String? alternativeText) #PdfFooterBuilderAdds an image to the running footer.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- align OfficeIMO.Pdf.PdfAlign
- fit OfficeIMO.Drawing.OfficeImageFit
- alternativeText System.String?
public PdfFooterBuilder Offset(Double points) #PdfFooterBuilderSets footer baseline offset below the bottom margin in points.
Parameters
- points System.Double
public PdfFooterBuilder PageNumber() #PdfFooterBuilderRenders the current page number in the footer.
public PdfFooterBuilder PageNumberWithTotal() #PdfFooterBuilderRenders the current page number and total pages in the footer.
public PdfFooterBuilder Shape(OfficeShape shape, PdfAlign align = Left) #PdfFooterBuilderAdds a shape to the running footer.
Parameters
- shape OfficeIMO.Drawing.OfficeShape
- align OfficeIMO.Pdf.PdfAlign = Left
public PdfFooterBuilder Text(String format) #PdfFooterBuilderRenders a literal footer text format. Supports {page} and {pages}.
Parameters
- format System.String
public PdfFooterBuilder Zones(String? left, String? center, String? right) #PdfFooterBuilderRenders left, center, and right footer zones on one line. Supports {page} and {pages}.
Parameters
- left System.String?
- center System.String?
- right System.String?
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?