API Reference
PdfHeaderCompose
Header builder (alignment, text, page number tokens).
Inheritance
- Object
- PdfHeaderCompose
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
- Method PdfHeaderCompose.AlignCenter
- Method PdfHeaderCompose.AlignLeft
- Method PdfHeaderCompose.AlignRight
- Method PdfHeaderCompose.Color
- Method PdfHeaderCompose.EvenPagesImage
- Method PdfHeaderCompose.EvenPagesImage
- Method PdfHeaderCompose.EvenPagesImage
- Method PdfHeaderCompose.EvenPagesShape
- Method PdfHeaderCompose.EvenPagesText
- Method PdfHeaderCompose.EvenPagesText
- Method PdfHeaderCompose.EvenPagesZones
- Method PdfHeaderCompose.FirstPageImage
- Method PdfHeaderCompose.FirstPageImage
- Method PdfHeaderCompose.FirstPageImage
- Method PdfHeaderCompose.FirstPageShape
- Method PdfHeaderCompose.FirstPageText
- Method PdfHeaderCompose.FirstPageText
- Method PdfHeaderCompose.FirstPageZones
- Method PdfHeaderCompose.Font
- Method PdfHeaderCompose.FontFamily
- Method PdfHeaderCompose.FontSize
- Method PdfHeaderCompose.Image
- Method PdfHeaderCompose.Image
- Method PdfHeaderCompose.Image
- Method PdfHeaderCompose.Offset
- Method PdfHeaderCompose.PageNumber
- Method PdfHeaderCompose.PageNumberWithTotal
- Method PdfHeaderCompose.Shape
- Method PdfHeaderCompose.Text
- Method PdfHeaderCompose.Text
- Method PdfHeaderCompose.Zones
Accepted by parameters
- Method PdfDocument.Header
- Method PdfPageCompose.Header
Methods
public PdfHeaderCompose AlignCenter() #PdfHeaderComposeSets header alignment to the center.
public PdfHeaderCompose Color(PdfColor color) #PdfHeaderComposeSets header text color.
Parameters
- color OfficeIMO.Pdf.PdfColor
public PdfHeaderCompose EvenPagesImage(Byte[] data, Double width, Double height, PdfAlign align = Left, OfficeImageFit fit = Stretch) #PdfHeaderComposeAdds 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 PdfHeaderCompose EvenPagesImage(Byte[] data, Double width, Double height, String alternativeText) #PdfHeaderComposeAdds 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 PdfHeaderCompose EvenPagesImage(Byte[] data, Double width, Double height, PdfAlign align, OfficeImageFit fit, String alternativeText) #PdfHeaderComposeAdds 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 PdfHeaderCompose EvenPagesShape(OfficeShape shape, PdfAlign align = Left) #PdfHeaderComposeAdds a shape to the even-page-only header.
Parameters
- shape OfficeIMO.Drawing.OfficeShape
- align OfficeIMO.Pdf.PdfAlign = Left
public PdfHeaderCompose EvenPagesText(String format) #PdfHeaderComposeRenders an even-page-only header text format. Supports {page} and {pages}.
Parameters
- format System.String
public PdfHeaderCompose EvenPagesText(Action<HeaderTextBuilder> build) #PdfHeaderComposeBuilds 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 PdfHeaderCompose EvenPagesZones(String left, String center, String right) #PdfHeaderComposeRenders even-page-only left, center, and right header zones. Supports {page} and {pages}.
Parameters
- left System.String
- center System.String
- right System.String
public PdfHeaderCompose FirstPageImage(Byte[] data, Double width, Double height, PdfAlign align = Left, OfficeImageFit fit = Stretch) #PdfHeaderComposeAdds 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 PdfHeaderCompose FirstPageImage(Byte[] data, Double width, Double height, String alternativeText) #PdfHeaderComposeAdds 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 PdfHeaderCompose FirstPageImage(Byte[] data, Double width, Double height, PdfAlign align, OfficeImageFit fit, String alternativeText) #PdfHeaderComposeAdds 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 PdfHeaderCompose FirstPageShape(OfficeShape shape, PdfAlign align = Left) #PdfHeaderComposeAdds a shape to the page-1-only header.
Parameters
- shape OfficeIMO.Drawing.OfficeShape
- align OfficeIMO.Pdf.PdfAlign = Left
public PdfHeaderCompose FirstPageText(String format) #PdfHeaderComposeRenders a page-1-only header text format. Supports {page} and {pages}.
Parameters
- format System.String
public PdfHeaderCompose FirstPageText(Action<HeaderTextBuilder> build) #PdfHeaderComposeBuilds 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 PdfHeaderCompose FirstPageZones(String left, String center, String right) #PdfHeaderComposeRenders page-1-only left, center, and right header zones. Supports {page} and {pages}.
Parameters
- left System.String
- center System.String
- right System.String
public PdfHeaderCompose Font(PdfStandardFont font) #PdfHeaderComposeSets header font.
Parameters
- font OfficeIMO.Pdf.PdfStandardFont
public PdfHeaderCompose FontFamily(String familyName) #PdfHeaderComposeUses a registered named font family for header text.
Parameters
- familyName System.String
public PdfHeaderCompose FontSize(Double size) #PdfHeaderComposeSets header font size in points.
Parameters
- size System.Double
public PdfHeaderCompose Image(Byte[] data, Double width, Double height, PdfAlign align = Left, OfficeImageFit fit = Stretch) #PdfHeaderComposeAdds 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 PdfHeaderCompose Image(Byte[] data, Double width, Double height, String alternativeText) #PdfHeaderComposeAdds a meaningful image to the running header with alternate text.
Parameters
- data System.Byte[]
- width System.Double
- height System.Double
- alternativeText System.String
public PdfHeaderCompose Image(Byte[] data, Double width, Double height, PdfAlign align, OfficeImageFit fit, String alternativeText) #PdfHeaderComposeAdds 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 PdfHeaderCompose Offset(Double points) #PdfHeaderComposeSets header baseline offset above the top margin in points.
Parameters
- points System.Double
public PdfHeaderCompose PageNumber() #PdfHeaderComposeRenders the current page number in the header.
public PdfHeaderCompose PageNumberWithTotal() #PdfHeaderComposeRenders the current page number and total pages in the header.
public PdfHeaderCompose Shape(OfficeShape shape, PdfAlign align = Left) #PdfHeaderComposeAdds a shape to the running header.
Parameters
- shape OfficeIMO.Drawing.OfficeShape
- align OfficeIMO.Pdf.PdfAlign = Left
public PdfHeaderCompose Text(String format) #PdfHeaderComposeRenders a literal header text format. Supports {page} and {pages}.
Parameters
- format System.String
public PdfHeaderCompose Text(Action<HeaderTextBuilder> build) #PdfHeaderComposeBuilds a custom header from text and page tokens.
Parameters
- build System.Action{OfficeIMO.Pdf.HeaderTextBuilder}
- Delegate to compose header segments.
public PdfHeaderCompose Zones(String left, String center, String right) #PdfHeaderComposeRenders left, center, and right header zones on one line. Supports {page} and {pages}.
Parameters
- left System.String
- center System.String
- right System.String