Package com.ironsoftware.ironpdf.headerfooter

Class HeaderFooterOptions

java.lang.Object
com.ironsoftware.ironpdf.headerfooter.HeaderFooterOptions
public class HeaderFooterOptions extends Object
Defines options for Headers and Footers applied to a PdfDocument during rendering or at any other time.

See: HtmlHeaderFooter

See: TextHeaderFooter

See: ChromePdfRenderOptions

  • Constructor Details

    • HeaderFooterOptions

      public HeaderFooterOptions()
      Instantiates a new Header footer options.

  • Method Details

    • getMarginLeftMm

      public int getMarginLeftMm()
      Gets margin left mm. The left margin of the header on the page; in millimeters. Default is 0mm.
      Returns:
      the margin left mm

    • setMarginLeftMm

      public void setMarginLeftMm(int marginLeftMm)
      Sets margin left mm. The left margin of the header on the page; in millimeters. Default is 0mm.
      Parameters:
      marginLeftMm - the margin left mm

    • getMarginRightMm

      public int getMarginRightMm()
      Gets margin right mm. The top margin of the header on the page; in millimeters. Default is 0mm.
      Returns:
      the margin right mm

    • setMarginRightMm

      public void setMarginRightMm(int marginRightMm)
      Sets margin right mm. The top margin of the header on the page; in millimeters. Default is 0mm.
      Parameters:
      marginRightMm - the margin right mm

    • getMarginTopMm

      public int getMarginTopMm()
      Gets margin top mm. The top margin of the header on the page; in millimeters. Default is 0mm.
      Returns:
      the margin top mm

    • setMarginTopMm

      public void setMarginTopMm(int marginTopMm)
      Sets margin top mm. The top margin of the header on the page; in millimeters. Default is 0mm.
      Parameters:
      marginTopMm - the margin top mm

    • getMarginBottomMm

      public int getMarginBottomMm()
      Gets margin bottom mm. The bottom margin of the header on the page; in millimeters. Default is 0mm.
      Returns:
      the margin bottom mm

    • setMarginBottomMm

      public void setMarginBottomMm(int marginBottomMm)
      Sets margin bottom mm. The bottom margin of the header on the page; in millimeters. Default is 0mm.
      Parameters:
      marginBottomMm - the margin bottom mm

    • getFirstPageNumber

      public int getFirstPageNumber()
      Gets first page number.First number used in {page} merge fields on the first page of the PDF. Subsequent page numbers will increment from this number. Default is 0.
      Returns:
      the first page number

    • setFirstPageNumber

      public void setFirstPageNumber(int firstPageNumber)
      Sets first page number. First number used in {page} merge fields on the first page of the PDF. Subsequent page numbers will increment from this number. Default is 0.
      Parameters:
      firstPageNumber - the first page number

    • getRenderPdfCssMediaType

      public CssMediaType getRenderPdfCssMediaType()
      Gets render pdf css media type. RenderPdfCssMediaType, Default is PRINT. This will be ignored if the header/footer is TextHeaderFooter.
      Returns:
      the render pdf css media type

    • setRenderPdfCssMediaType

      public void setRenderPdfCssMediaType(CssMediaType renderPdfCssMediaType)
      Sets render pdf css media type. RenderPdfCssMediaType, Default is PRINT. This will be ignored if the header/footer is TextHeaderFooter.
      Parameters:
      renderPdfCssMediaType - the render pdf css media type

    • getPdfTitle

      public String getPdfTitle()
      Gets pdf title. Default is null.
      Returns:
      the pdf title

    • setPdfTitle

      public void setPdfTitle(String pdfTitle)
      Sets pdf title. Default is null.
      Parameters:
      pdfTitle - the pdf title

    • getHtmlTitle

      public String getHtmlTitle()
      Gets html title. Default is null. This will be ignored if the header/footer is TextHeaderFooter.
      Returns:
      the html title

    • setHtmlTitle

      public void setHtmlTitle(String htmlTitle)
      Sets html title. Default is null. This will be ignored if the header/footer is TextHeaderFooter.
      Parameters:
      htmlTitle - the html title