API Reference
PdfHeaderBuilder
Header builder (alignment, text, page number tokens).
Inheritance
- Object
- PdfHeaderBuilder
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 PdfHeaderBuilder.AlignCenter
- Method PdfHeaderBuilder.AlignLeft
- Method PdfHeaderBuilder.AlignRight
- Method PdfHeaderBuilder.Color
- Method PdfHeaderBuilder.Content
- Method PdfHeaderBuilder.EvenPagesContent
- Method PdfHeaderBuilder.EvenPagesImage
- Method PdfHeaderBuilder.EvenPagesShape
- Method PdfHeaderBuilder.EvenPagesStyledZones
- Method PdfHeaderBuilder.EvenPagesText
- Method PdfHeaderBuilder.EvenPagesZones
- Method PdfHeaderBuilder.FirstPageContent
- Method PdfHeaderBuilder.FirstPageImage
- Method PdfHeaderBuilder.FirstPageShape
- Method PdfHeaderBuilder.FirstPageStyledZones
- Method PdfHeaderBuilder.FirstPageText
- Method PdfHeaderBuilder.FirstPageZones
- Method PdfHeaderBuilder.Font
- Method PdfHeaderBuilder.FontFamily
- Method PdfHeaderBuilder.FontSize
- Method PdfHeaderBuilder.Image
- Method PdfHeaderBuilder.Offset
- Method PdfHeaderBuilder.PageNumber
- Method PdfHeaderBuilder.PageNumberWithTotal
- Method PdfHeaderBuilder.Shape
- Method PdfHeaderBuilder.StyledZones
- Method PdfHeaderBuilder.Text
- Method PdfHeaderBuilder.Zones
Accepted by parameters 1
- Method PdfPageBuilder.Header
Methods
public PdfHeaderBuilder AlignCenter() #PdfHeaderBuilderSets header alignment to the center.
public PdfHeaderBuilder Color(PdfColor color) #PdfHeaderBuilderSets header text color.
Parameters
- color OfficeIMO.Pdf.PdfColor
public PdfHeaderBuilder Content(Action<PdfContentBuilder> build, Double distanceFromEdge, Double bodyGap = 0) #PdfHeaderBuilderReplaces the default header with bounded document flow at a distance from the top 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 PdfHeaderBuilder Content(Func<PdfRunningContentContext, Action<PdfContentBuilder>> build, Double distanceFromEdge, Double bodyGap = 0) #PdfHeaderBuilderComposes the default bounded header 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 PdfHeaderBuilder EvenPagesContent(Action<PdfContentBuilder> build, Double distanceFromEdge, Double bodyGap = 0) #PdfHeaderBuilderReplaces even-page headers with bounded flow measured from the top page edge.
Parameters
- build System.Action<OfficeIMO.Pdf.PdfContentBuilder>
- distanceFromEdge System.Double
- bodyGap System.Double = 0
public PdfHeaderBuilder EvenPagesContent(Func<PdfRunningContentContext, Action<PdfContentBuilder>> build, Double distanceFromEdge, Double bodyGap = 0) #PdfHeaderBuilderComposes bounded even-page header 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 PdfHeaderBuilder EvenPagesImage(Byte[] data, Double width, Double height, PdfAlign align = Left, OfficeImageFit fit = Stretch) #PdfHeaderBuilderAdds an image to the even-page-only header.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- align OfficeIMO.Pdf.PdfAlign = Left
- fit OfficeIMO.Drawing.OfficeImageFit = Stretch
public PdfHeaderBuilder EvenPagesImage(Byte[] data, Double width, Double height, String? alternativeText) #PdfHeaderBuilderAdds a meaningful image to the even-page-only header with alternate text.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- alternativeText System.String?
public PdfHeaderBuilder EvenPagesImage(Byte[] data, Double width, Double height, PdfAlign align, OfficeImageFit fit, String? alternativeText) #PdfHeaderBuilderAdds an image to the even-page-only header.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- align OfficeIMO.Pdf.PdfAlign
- fit OfficeIMO.Drawing.OfficeImageFit
- alternativeText System.String?
public PdfHeaderBuilder EvenPagesShape(OfficeShape shape, PdfAlign align = Left) #PdfHeaderBuilderAdds a shape to the even-page-only header.
Parameters
- shape OfficeIMO.Drawing.OfficeShape
- align OfficeIMO.Pdf.PdfAlign = Left
public PdfHeaderBuilder EvenPagesStyledZones(Action<HeaderTextBuilder>? left, Action<HeaderTextBuilder>? center, Action<HeaderTextBuilder>? right) #PdfHeaderBuilderRenders independently styled even-page-only header zones.
Parameters
- left System.Action<OfficeIMO.Pdf.HeaderTextBuilder>?
- center System.Action<OfficeIMO.Pdf.HeaderTextBuilder>?
- right System.Action<OfficeIMO.Pdf.HeaderTextBuilder>?
public PdfHeaderBuilder EvenPagesText(String format) #PdfHeaderBuilderRenders an even-page-only header text format. Supports {page} and {pages}.
Parameters
- format System.String
public PdfHeaderBuilder EvenPagesText(Action<HeaderTextBuilder> build) #PdfHeaderBuilderBuilds an even-page-only header from text and page tokens.
Parameters
- build System.Action<OfficeIMO.Pdf.HeaderTextBuilder>
- Delegate to compose even-page header segments.
public PdfHeaderBuilder EvenPagesZones(String? left, String? center, String? right) #PdfHeaderBuilderRenders even-page-only left, center, and right header zones. Supports {page} and {pages}.
Parameters
- left System.String?
- center System.String?
- right System.String?
public PdfHeaderBuilder FirstPageContent(Action<PdfContentBuilder> build, Double distanceFromEdge, Double bodyGap = 0) #PdfHeaderBuilderReplaces the first-page header with bounded flow measured from the top page edge.
Parameters
- build System.Action<OfficeIMO.Pdf.PdfContentBuilder>
- distanceFromEdge System.Double
- bodyGap System.Double = 0
public PdfHeaderBuilder FirstPageContent(Func<PdfRunningContentContext, Action<PdfContentBuilder>> build, Double distanceFromEdge, Double bodyGap = 0) #PdfHeaderBuilderComposes bounded first-page header 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 PdfHeaderBuilder FirstPageImage(Byte[] data, Double width, Double height, PdfAlign align = Left, OfficeImageFit fit = Stretch) #PdfHeaderBuilderAdds an image to the page-1-only header.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- align OfficeIMO.Pdf.PdfAlign = Left
- fit OfficeIMO.Drawing.OfficeImageFit = Stretch
public PdfHeaderBuilder FirstPageImage(Byte[] data, Double width, Double height, String? alternativeText) #PdfHeaderBuilderAdds a meaningful image to the page-1-only header with alternate text.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- alternativeText System.String?
public PdfHeaderBuilder FirstPageImage(Byte[] data, Double width, Double height, PdfAlign align, OfficeImageFit fit, String? alternativeText) #PdfHeaderBuilderAdds an image to the page-1-only header.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- align OfficeIMO.Pdf.PdfAlign
- fit OfficeIMO.Drawing.OfficeImageFit
- alternativeText System.String?
public PdfHeaderBuilder FirstPageShape(OfficeShape shape, PdfAlign align = Left) #PdfHeaderBuilderAdds a shape to the page-1-only header.
Parameters
- shape OfficeIMO.Drawing.OfficeShape
- align OfficeIMO.Pdf.PdfAlign = Left
public PdfHeaderBuilder FirstPageStyledZones(Action<HeaderTextBuilder>? left, Action<HeaderTextBuilder>? center, Action<HeaderTextBuilder>? right) #PdfHeaderBuilderRenders independently styled page-1-only header zones.
Parameters
- left System.Action<OfficeIMO.Pdf.HeaderTextBuilder>?
- center System.Action<OfficeIMO.Pdf.HeaderTextBuilder>?
- right System.Action<OfficeIMO.Pdf.HeaderTextBuilder>?
public PdfHeaderBuilder FirstPageText(String format) #PdfHeaderBuilderRenders a page-1-only header text format. Supports {page} and {pages}.
Parameters
- format System.String
public PdfHeaderBuilder FirstPageText(Action<HeaderTextBuilder> build) #PdfHeaderBuilderBuilds a page-1-only header from text and page tokens.
Parameters
- build System.Action<OfficeIMO.Pdf.HeaderTextBuilder>
- Delegate to compose first-page header segments.
public PdfHeaderBuilder FirstPageZones(String? left, String? center, String? right) #PdfHeaderBuilderRenders page-1-only left, center, and right header zones. Supports {page} and {pages}.
Parameters
- left System.String?
- center System.String?
- right System.String?
public PdfHeaderBuilder Font(PdfStandardFont font) #PdfHeaderBuilderSets header font.
Parameters
- font OfficeIMO.Pdf.PdfStandardFont
public PdfHeaderBuilder FontFamily(String familyName) #PdfHeaderBuilderUses a registered named font family for header text.
Parameters
- familyName System.String
public PdfHeaderBuilder FontSize(Double size) #PdfHeaderBuilderSets header font size in points.
Parameters
- size System.Double
public PdfHeaderBuilder Image(Byte[] data, Double width, Double height, PdfAlign align = Left, OfficeImageFit fit = Stretch) #PdfHeaderBuilderAdds an image to the running header.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- align OfficeIMO.Pdf.PdfAlign = Left
- fit OfficeIMO.Drawing.OfficeImageFit = Stretch
public PdfHeaderBuilder Image(Byte[] data, Double width, Double height, String? alternativeText) #PdfHeaderBuilderAdds a meaningful image to the running header with alternate text.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- alternativeText System.String?
public PdfHeaderBuilder Image(Byte[] data, Double width, Double height, PdfAlign align, OfficeImageFit fit, String? alternativeText) #PdfHeaderBuilderAdds an image to the running header.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- align OfficeIMO.Pdf.PdfAlign
- fit OfficeIMO.Drawing.OfficeImageFit
- alternativeText System.String?
public PdfHeaderBuilder Offset(Double points) #PdfHeaderBuilderSets header baseline offset above the top margin in points.
Parameters
- points System.Double
public PdfHeaderBuilder PageNumber() #PdfHeaderBuilderRenders the current page number in the header.
public PdfHeaderBuilder PageNumberWithTotal() #PdfHeaderBuilderRenders the current page number and total pages in the header.
public PdfHeaderBuilder Shape(OfficeShape shape, PdfAlign align = Left) #PdfHeaderBuilderAdds a shape to the running header.
Parameters
- shape OfficeIMO.Drawing.OfficeShape
- align OfficeIMO.Pdf.PdfAlign = Left
public PdfHeaderBuilder StyledZones(Action<HeaderTextBuilder>? left, Action<HeaderTextBuilder>? center, Action<HeaderTextBuilder>? right) #PdfHeaderBuilderRenders independently styled left, center, and right header zones on one line.
Parameters
- left System.Action<OfficeIMO.Pdf.HeaderTextBuilder>?
- center System.Action<OfficeIMO.Pdf.HeaderTextBuilder>?
- right System.Action<OfficeIMO.Pdf.HeaderTextBuilder>?
public PdfHeaderBuilder Text(String format) #PdfHeaderBuilderRenders a literal header text format. Supports {page} and {pages}.
Parameters
- format System.String
public PdfHeaderBuilder Text(Action<HeaderTextBuilder> build) #PdfHeaderBuilderBuilds a custom header from text and page tokens.
Parameters
- build System.Action<OfficeIMO.Pdf.HeaderTextBuilder>
- Delegate to compose header segments.
public PdfHeaderBuilder Zones(String? left, String? center, String? right) #PdfHeaderBuilderRenders left, center, and right header 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?