[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

GrapeCity.Documents.Html.PdfSettings

PdfSettings Class

Represents output settings for rendering HTML to PDF.

Inheritance
object
PdfSettings
Namespace: GrapeCity.Documents.Html
Assembly: DS.Documents.Html.dll
Syntax
[Obsolete("Use GcHtmlBrowser with HtmlPage and PdfOptions instead.")]
public class PdfSettings
<Obsolete("Use GcHtmlBrowser with HtmlPage and PdfOptions instead.")>
Public Class PdfSettings

Constructors

Name Description
PdfSettings()

Properties

Name Description
DefaultBackgroundColor

Gets or sets the background color to be used if the HTML page doesn't specify one. Defaults to White color.
DisplayBackgroundGraphics

Gets or sets a value indicating whether the background graphics should be rendered. Defaults to true.
DisplayHeaderFooter

Gets 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.

FooterTemplate

Gets 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:

  • 'date'formatted print date
  • 'title'document title
  • 'url'document location
  • 'pageNumber'current page number
  • 'totalPages'total pages in the document

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

FullPage

Gets 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.

HeaderTemplate

Gets 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:

  • 'date'formatted print date
  • 'title'document title
  • 'url'document location
  • 'pageNumber'current page number
  • 'totalPages'total pages in the document

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

IgnoreCSSPageSize

Gets 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.

Landscape

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

Note that this property is ignored if FullPage is true.

Margins

Gets or sets page margins, in inches. Defaults to no margins.

Note that this property is ignored if FullPage is true.

PageHeight

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

Note that this property is ignored if FullPage is true.

PageRanges

Gets 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.

PageWidth

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

Note that this property is ignored if FullPage is true.

Scale

Gets or sets the scale factor, from 0.1 to 2.0. Defaults to 1.0.
TaggedPdf

Gets or sets a value indicating whether a tagged (accessible) PDF is generated. Defaults to true.
WindowSize

Gets or sets the virtual window size, in pixels. Defaults to 800 x 600.