PdfPageOptions Class

The options for PDF pages created during HTML to PDF conversions.

Inheritance Hierarchy

System.Object
  BitMiracle.Docotic.Pdf.HtmlToPdf.PdfPageOptions

Namespace:  BitMiracle.Docotic.Pdf.HtmlToPdf
Assembly:  BitMiracle.Docotic.Pdf.HtmlToPdf (in BitMiracle.Docotic.Pdf.HtmlToPdf.dll)

Syntax

C#
public class PdfPageOptions
VB
Public Class PdfPageOptions

The PdfPageOptions type exposes the following members.

Properties

  NameDescription
Public propertyFooterTemplate
Gets or sets the HTML template for page footer.
Public propertyHeaderTemplate
Gets or sets the HTML template for page header.
Public propertyHeight
Gets the height of the page in points.
Public propertyIsLandscape
Gets the value indicating whether the page orientation is landscape.
Public propertyKeepBackground
Gets or sets the value indicating whether the conversion should keep the background color and/or graphics.
Public propertyMarginBottom
Gets or sets the bottom margin of the page in points.
Public propertyMarginLeft
Gets or sets the left margin of the page in points.
Public propertyMarginRight
Gets or sets the right margin of the page in points.
Public propertyMarginTop
Gets or sets the top margin of the page in points.
Public propertyScale
Gets or sets the scale of the page rendering.
Public propertySize
Gets the PdfPaperSize value specifying the size of the page.
Public propertyTransparentBackground
Gets or sets the value indicating whether the default background should be transparent.
Public propertyWidth
Gets the width of the page in points.

Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetSize
Sets the size-related properties of the page using the provided PdfPaperSize value.
Public methodSetSizeInches
Sets the size-related properties of the page using the provided width and height in inches.
Public methodSetSizePoints
Sets the size-related properties of the page using the provided width and height in points.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)

See Also