GrapeCity.Documents.Html.PdfOptions

PdfOptions Class

Represents output settings for rendering HTML to PDF.

Inheritance

PdfOptions

Namespace: GrapeCity.Documents.Html

Assembly: DS.Documents.Html.dll

Syntax

public class PdfOptions

Public Class PdfOptions

Constructors

Name	Description
PdfOptions()

Properties

Name	Description
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, PreferCSSPageSize, 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.
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.
PreferCSSPageSize	Gets or sets a value indicating whether the CSS-defined page size should have priority over what is declared in PageWidth and PageHeight. Defaults to false.
PrintBackground	Gets or sets a value indicating whether to print background graphics. Defaults to true.
Scale	Gets or sets the scale factor between 0.1 and 2.0. Defaults to 1.0.