Search Results for

    Show / Hide Table of Contents

    Class HtmlHeaderFooter

    A Html Header or Footer which will be printed onto every page of the PDF. This can be used to override Header and Footer

    When using HtmlHeaderFooter it is important to set HtmlFragment and Height

    Merge meta-data into your html using any of these placeholder strings: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}

    Inheritance
    System.Object
    SimpleHeaderFooter
    HtmlHeaderFooter
    Implements
    System.ICloneable
    Inherited Members
    SimpleHeaderFooter.CenterText
    SimpleHeaderFooter.DrawDividerLine
    SimpleHeaderFooter.FontFamily
    SimpleHeaderFooter.FontSize
    SimpleHeaderFooter.LeftText
    SimpleHeaderFooter.RightText
    SimpleHeaderFooter.Spacing
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ToString()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: IronPdf
    Assembly: IronPdf.dll
    Syntax
    public class HtmlHeaderFooter : SimpleHeaderFooter, ICloneable

    Constructors

    HtmlHeaderFooter()

    Declaration
    public HtmlHeaderFooter()

    Fields

    BaseUrl

    The Base URL all URLS in the HtmlFragment will be relative to. This includes 'src' attributes on images, scripts, style-sheets and also hrefs on hyper-links.

    Note: A base URL that points to a directory should end with a slash.

    Base URL accepts file paths as well as URLS. If no BaseUrl is given, the HtmlHeaderFooter BaseUrl will be inherited from the main HTML document where possible.

    Declaration
    public string BaseUrl
    Field Value
    Type Description
    System.String

    Height

    Height of the Html Header / Footer in millimeters. This value must be set sufficiently high to display the full html header / footer content.

    Declaration
    public int Height
    Field Value
    Type Description
    System.Int32

    HtmlFragment

    The Html which will be use to render the Header / Footer. Should be an HTML snippet rather than a complete document. May contain styles & images.

    Merge meta-data into the HtmlFragment by putting any of these placeholder strings into the text: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}. An alternative mail-merge style using the pattern <span class='total-pages'></span> also workd

    HtmlFragment is a stand alone HTML document which does not inherit styles or settings from your main HTML content unless LoadStylesAndCSSFromMainHtmlDocument is set true

    Declaration
    public string HtmlFragment
    Field Value
    Type Description
    System.String

    LoadStylesAndCSSFromMainHtmlDocument

    Loads style code blocks and links to CSS style sheets from the main HTML document (which provides the PDF content) into the HtmlHeaderFooter .

    By default, Html Headers and Footers are stand- alone HTML documents with their own default styles. Setting LoadStylesAndCSSFromMainHtmlDocument to true will attempt to load all STYLE and LINK tags from the main HTML document (which renders teh PDF) into the HtmlHeaderFooter.

    If your main HTML document contains complex CSS frameworks, styles the HEAD or BODY element heavily or loads CSS from javascript then this method may not work as intended.

    This feature is not available for RenderUrlAsPdf(String) and other RenderUrlAsPdf methods. It works for HTMLToPdf and HtmlFileToPdf conversions only.

    It is often preferable to load style sheets explicitly into your HTML Headers and Footers as STYLE and LINK tags within the HtmlFragment for granular control

    Declaration
    public bool LoadStylesAndCSSFromMainHtmlDocument
    Field Value
    Type Description
    System.Boolean

    Methods

    Clone()

    Clones this instance.

    Declaration
    public object Clone()
    Returns
    Type Description
    System.Object

    System.Object of type HtmlHeaderFooter

    Implements

    System.ICloneable

    See Also

    Header
    Footer
    ☀
    ☾
    In This Article
    Back to top
    Install with Nuget