HiQPdf Documentation

PdfDocumentControl Class

Quickly Create High Quality PDFs
This class controls the properties of the PDF document generated by the HTML to PDF Converter. A reference to an object of this class is exposed by the Document property of the HtmlToPdf class
Inheritance Hierarchy

SystemObject
  HiQPdfPdfDocumentControl

Namespace:  HiQPdf
Assembly:  HiQPdf (in HiQPdf.dll) Version: 14.0.0.0
Syntax

public class PdfDocumentControl

The PdfDocumentControl type exposes the following members.

Constructors

  NameDescription
Public methodPdfDocumentControl
Constructs an object controlling the HTML to PDF conversion
Top
Properties

  NameDescription
Public propertyAutoPdfForm
The object exposed by this property can be used to control the automatically created PDF form
Public propertyBackgroundColor
The PDF pages background color
Public propertyBottomPadding
A padding to insert under the content rendered in a PDF page
Public propertyBreakAfterHtmlElements
An array of HTML CSS selectors to select the HTML elements that will receive a page break after them in the resulted PDF document
Public propertyBreakBeforeHtmlElements
An array of HTML CSS selectors to select the HTML elements that will receive a page break before them in PDF document
Public propertyBreakInsideAvoidHtmlElements
An array of HTML CSS selectors to select the HTML elements not accepting page breaks inside them
Public propertyCloseAdditionalDocuments
Controls if the external documents inserted before or added after conversion result are closed when the conversion ends. This property is true by default
Public propertyColorProfile
The color profile used by document
Public propertyColorSpace
The PDF document color space
Public propertyCompress
This property controls the content streams compression in the PDF document generated by the HTML to PDF converter. By default the content streams are compressed to reduce the size of the generated PDF document
Public propertyConvertHttpLinks
Controls if the HTTP links in the HTML document are converted to HTTP links in PDF. This property is true by default
Public propertyConvertInternalLinks
Controls if the internal links in HTML are converted to internal links in PDF. This property is true by default
Public propertyDestHeight
The height in points of the destination PDF rectangle where the HTML content will be rendered
Public propertyDestWidth
The width in points of the destination PDF rectangle where the HTML content will be rendered
Public propertyDestX
The destination rectangle top left corner X coordinate in points
Public propertyDestY
The destination rectangle top left corner Y coordinate in points
Public propertyDisplayMaskedImages
Indicates if the masked images are displayed. This property is false by default
Public propertyFitPageHeight
Controls if the content is scaled down to fit the PDF page height. This property is false by default
Public propertyFitPageWidth
Controls if the content is scaled down to fit the PDF page width. This property is true by default. When this property is true the images and the text font can be smaller than in HTML
Public propertyFontEmbedding
Controls if the fonts used in HTML are embedded in the PDF document. This property is true by default
Public propertyFooter
Controls the visibility and the content of the footer of the generated PDF document
Public propertyForceFitPageWidth
Controls if the content can be enlarged to fit the PDF page width when FitPageWidth is true. This property is false by default
Public propertyHeader
Controls the visibility and the content of the header of the generated PDF document.
Public propertyHighResolutionGraphics
Indicates if the PDF graphics are using high resolution coordinates. This property is true by default
Public propertyImagesCompression
Controls the images compression percentage in the PDF document on a scale from 0 to 100. A 0 compression produces the best quality images which leads to larger PDF documents while a 100 compression produces low quality images and small PDF documents
Public propertyImagesCutAllowed
Controls if cutting images between PDF pages is permitted in the PDF document generated by the HTML to PDF converter. This property is true by default
Public propertyLiveExcludedElements
Controls if the HTML elements excluded from rendering are live in PDF. This property is false by default
Public propertyMargins
The PDF document margins. By default all the margins are 0
Public propertyOutlines
Controls the automatically generated outlines of the PDF document
Public propertyPageOrientation
The PDF document pages orientation. The default orientation is potrait
Public propertyPageSize
The PDF document page size. The default value is A4. The final width and height of the PDF pages is also influenced by the PageOrientation property
Public propertyPdfDocumentObject
The PdfDocument object created during conversion
Public propertyPdfStandard
The PDF document standard
Public propertyPostCardMode
When this property is true the generated PDF document will have only one page to display the whole content without scaling. This property is false by default
Public propertyProperties
Controls the title, subject, keywords, author and the creation date of the PDF document
Public propertyRenderImagesWithTransparency
Indicates if the images are rendered with transparency in PDF. This property is true by default
Public propertyRenderWithTransparency
Indicates if the resulted PDF can contain transparent objects. This property is true by default
Public propertyRepeatTfootAllowed
Indicates if the repeating of thead content of a HTML table in PDF is allowed. This property is true by default
Public propertyRepeatTfootStacked
Indicates if the tfoot content of the HTML tables rendered on a PDF page are stacked or displayed at the same level. This property is true by default
Public propertyRepeatTheadAllowed
Indicates if the repeating of thead content of a HTML table in PDF is allowed. This property is true by default
Public propertyRepeatTheadStacked
Indicates if the thead content of the HTML tables rendered on a PDF page are stacked or displayed at the same level. This property is true by default
Public propertyResizePageWidth
When this property is true and both FitPageWidth and FitPageHeight are false the PDF page width can be resized to display the whole content without scaling. This property is true by default
Public propertyScaleImages
Indicates if the images can be scaled in PDF. This property is false by default
Public propertyScrictIsoRendering
Indicates if the generated PDF document respects strictly the ISO standard. This property is true by default
Public propertySecurity
The object exposed by this property can be used to password protect the PDF document, disable printing, copying or editing of the PDF document
Public propertyTableOfContents
Controls the automatically generated table of the contents for the converted HTML document
Public propertyTopPadding
A padding to insert above the content rendered in a PDF page
Public propertyViewer
Controls the PDF viewer preferences
Top
Methods

  NameDescription
Public methodAppendPdfDocument(PdfDocument)
Call this method to append a PDF document object after the HTML to PDF conversion in the final document
Public methodAppendPdfDocument(PdfDocument, Boolean, Boolean, Boolean)
Call this method to append a PDF document object after the HTML to PDF conversion in the final document. The boolean parameter controls if the header and footer are applied on external PDF document loaded from a file or a stream. When the parameter is true the interactive features are disabled in the external PDF
Public methodAppendPdfFile(String)
Call this method to append a PDF file after the HTML to PDF conversion in the final document
Public methodAppendPdfFile(String, Boolean, Boolean, Boolean)
Call this method to append a PDF file after the HTML to PDF conversion in the final document. The boolean parameter controls if the header and footer are applied on external PDF document. When the parameter is true the interactive features are disabled in the external PDF
Public methodAppendPdfStream(Stream)
Call this method to append a PDF from a stream after the HTML to PDF conversion in the final document
Public methodAppendPdfStream(Stream, Boolean, Boolean, Boolean)
Call this method to append a PDF from a stream after the HTML to PDF conversion in the final document. The boolean parameter controls if the header and footer are applied on external PDF document. When the parameter is true the interactive features
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 a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInsertPdfDocumentBefore(PdfDocument)
Call this method to insert a PDF document object before the HTML to PDF conversion in the final document
Public methodInsertPdfDocumentBefore(PdfDocument, Boolean, Boolean, Boolean)
Call this method to insert a PDF document object before the HTML to PDF conversion in the final document. The boolean parameter controls if the header and footer are applied on external PDF document loaded from a file or a stream. When the parameter is true the interactive features are disabled in the external PDF
Public methodInsertPdfFileBefore(String)
Call this method to insert a PDF file before the HTML to PDF conversion in the final document
Public methodInsertPdfFileBefore(String, Boolean, Boolean, Boolean)
Call this method to insert a PDF file before the HTML to PDF conversion in the final document. The boolean parameter controls if the header and footer are applied on external PDF document. When the parameter is true the interactive features are disabled in the external PDF
Public methodInsertPdfStreamBefore(Stream)
Call this method to insert a PDF from a stream before the HTML to PDF conversion in the final document
Public methodInsertPdfStreamBefore(Stream, Boolean, Boolean, Boolean)
Call this method to insert a PDF from a stream before the HTML to PDF conversion in the final document. The boolean parameter controls if the header and footer are applied on external PDF document. When the parameter is true the interactive features are disabled in the external PDF
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also

Reference