API Reference

Class

PdfHeaderFooterImage

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Modifiers sealed

Describes a simple image rendered in a page header or footer.

Inheritance

  • Object
  • PdfHeaderFooterImage

Constructors

PdfHeaderFooterImage 3 overloads
public PdfHeaderFooterImage(Byte[] data, Double width, Double height, PdfAlign align = Left, OfficeImageFit fit = Stretch) #

Creates a header/footer image.

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 PdfHeaderFooterImage(Byte[] data, Double width, Double height, String alternativeText) #

Creates a meaningful header/footer image 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 PdfHeaderFooterImage(Byte[] data, Double width, Double height, PdfAlign align, OfficeImageFit fit, String alternativeText) #

Creates a header/footer image.

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

Properties

public Byte[] Data { get; } #

Image payload.

public Double Width { get; } #

Requested image box width in PDF points.

public Double Height { get; } #

Requested image box height in PDF points.

public PdfAlign Align { get; } #

Horizontal placement inside the page content width.

public OfficeImageFit Fit { get; } #

Image fit behavior inside the requested image box.

public OfficeImageInfo Info { get; } #

Validated image metadata.

public String AlternativeText { get; } #

Optional alternate text for meaningful header/footer images.