Document Solutions for PDF
DS.Documents.Html Assembly / GrapeCity.Documents.Html Namespace / PdfSettings Class
Properties

In This Topic
    PdfSettings Class Members
    In This Topic

    The following tables list the members exposed by PdfSettings.

    Public Constructors
     NameDescription
    Public ConstructorPdfSettings Constructor  
    Top
    Public Properties
     NameDescription
    Public PropertyDefaultBackgroundColorGets or sets the background color to be used if the HTML page doesn't specify one. Defaults to White color.  
    Public PropertyDisplayBackgroundGraphicsGets or sets a value indicating whether the background graphics should be rendered. Defaults to true.  
    Public PropertyDisplayHeaderFooterGets or sets a value indicating whether the header and footer are rendered. Defaults to false.

    Note that this property is ignored if FullPage is true.

     
    Public PropertyFooterTemplateGets or sets the HTML template for the page footer.

    This should be a valid HTML markup that may include the following special classes used to inject print values:

    • formatted print date
    • document title
    • document location
    • current page number
    • total pages in the document

    For example, "<span class='title'></span>" would generate a span containing the document title.

     
    Public PropertyFullPageGets or sets a value indicating whether the whole HTML page should be rendered as a single PDF page. Defaults to false.

    Note that if this property is true, the following properties are ignored: Landscape, PageWidth, PageHeight, IgnoreCSSPageSize, Margins, PageRanges, DisplayHeaderFooter, HeaderTemplate and FooterTemplate.

     
    Public PropertyHeaderTemplateGets or sets the HTML template for the page header.

    This should be a valid HTML markup that may include the following special classes used to inject print values:

    • formatted print date
    • document title
    • document location
    • current page number
    • total pages in the document

    For example, "<span class='title'></span>" would generate a span containing the document title.

     
    Public PropertyIgnoreCSSPageSizeGets or sets a value indicating whether the CSS-defined page size should be ignored. Defaults to false.

    Note that this property is ignored if FullPage is true.

     
    Public PropertyLandscapeGets or sets a value indicating whether the paper orientation is Landscape. Defaults to false.

    Note that this property is ignored if FullPage is true.

     
    Public PropertyMarginsGets or sets page margins, in inches. Defaults to no margins.

    Note that this property is ignored if FullPage is true.

     
    Public PropertyPageHeightGets or sets the page height, in inches. If unspecified, 11 inches is used.

    Note that this property is ignored if FullPage is true.

     
    Public PropertyPageRangesGets or sets the range of pages to render, e.g., '1-5, 8, 11-13'. Defaults to all pages.

    Note that this property is ignored if FullPage is true.

     
    Public PropertyPageWidthGets or sets the page width, in inches. If unspecified, 8.5 inches is used.

    Note that this property is ignored if FullPage is true.

     
    Public PropertyScaleGets or sets the scale factor, from 0.1 to 2.0. Defaults to 1.0.  
    Public PropertyTaggedPdfGets or sets a value indicating whether a tagged (accessible) PDF is generated. Defaults to true.  
    Public PropertyWindowSizeGets or sets the virtual window size, in pixels. Defaults to 800 x 600.  
    Top
    See Also

    Reference

    PdfSettings Class
    GrapeCity.Documents.Html Namespace