This class encapsulates a PDF document and can be used to create a new PDF document or to load an existing PDF document
Inheritance Hierarchy
WinnovativeDocument
Namespace: Winnovative
Assembly: wnvhtmltopdf (in wnvhtmltopdf.dll) Version: 17.0.0.0
Syntax
The Document type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | Document |
Creates an empty PDF document object. New pages can be added to the document and new PDF elements can be added
to document pages.
|
| Document(ColorProfile) |
Creates a PDF document with a color profile.
|
| Document(ColorSpace) |
Creates a PDF document with the specified color space. This property can be used to create
PDF documents in RGB, Grayscale or CMYK color spaces. By default the document uses the RGB color space.
|
| Document(PdfStandardSubset) |
Creates a PDF document based on the specified PDF standard. By default the Full PDF standard is used.
This property can be used to create PDF/A or PDF/X compliant documents.
|
| Document(Stream) |
Creates a PDF document object from the specified stream containing the PDF document.
|
| Document(String) |
Creates a PDF document from and existing PDF file.
|
| Document(PdfStandardSubset, ColorSpace) |
Creates a PDF document based on the specified PDF standard and using the specified color space.
By default the Full PDF standard is used. This property can be used to create PDF/A or PDF/X
compliant documents using the specified color space.
|
| Document(Stream, String) |
Creates a PDF document from a stream containing a password protected PDF document.
The specified password can be a user or owner password.
|
| Document(String, String) |
Creates a PDF document object from an existing password protected PDF file.
|
| Document(PdfStandardSubset, ColorSpace, ColorProfile) |
Creates a PDF document based on the specified PDF standard and using the specified color space and color profile.
By default the Full PDF standard is used. This property can be used to create PDF/A or PDF/X
compliant documents using the specified color space.
|
Properties
| Name | Description | |
|---|---|---|
 | AutoCloseAppendedDocs |
Gets or sets a value indicating if the PDF documents appended to this document using the
AppendDocument(Document) method are automatically closed when the current document is closed using the
Close method. The default value is false.
The appended documents must remain open until the current document is saved.
|
| Bookmarks |
Gets the bookmarks collection of the document.
|
| CompressCrossReference |
Set this property on true to store the PDF cross-reference table and PDF trailer in compressed cross-reference streams
and to reduce the PDF file size. The default value is false for the new documents
|
| CompressionLevel |
Gets or sets the PDF document compression level. By default the compression level is Normal |
| DocumentInformation |
Offers access to the document information object where the document's
title, subject, keywords, etc can be set.
|
| Fonts |
Gets the collection of fonts of this PDF document.
|
| Footer |
Represents the default PDF document footer template. This footer is automatically considered
when calculating the available space for rendering in a PDF page. This template is automatically
docked to the bottom of the PDF page.
|
| Form |
Gets a reference to the PDF form of this PDF document
|
| Header |
Represents the default PDF document header template. This header is automatically considered
when calculating the available space for drawing in a PDF page. This template is automatically
docked to the top of the PDF page.
|
| JpegCompressionEnabled |
Gets or sets a flag indicating if the JPEG compression is enabled or not for the images in the generated PDF.
By default the JPEG compression is enabled to reduce the size of the generated PDF. When the JPEG compression is enabled
the quality of the images in the generated PDF is lower than the quality of the original images in the HTML document,
function of the JpegCompressionLevel parameter. When the JpegCompressionLevel is increased, the quality of the images in PDF decreases.
|
| JpegCompressionLevel |
Gets or sets the compression level of images in the generated PDF as an integer value between 0 and 100.
This property has effect only when the JpegCompressionEnabled is true.
When the JpegCompressionLevel is 0, the compression rate is the lowest and the quality of the images is the best.
When the JpegCompressionLevel is 100, the compression rate is the highest and quality of the images in PDF is the worst.
The default JPEG compression level is 10, which should offer a good balance between the compression rate and
the quality of the images in PDF.
|
| LicenseKey |
Gets or sets the license key string received from the vendor.
If this property is null the library will automatically enter in evaluation mode
and a demo watermark will be displayed on the generated PDF document.
|
| Margins |
The default document margins. The new pages will use the default margins
if no margins are specified
|
| OpenAction |
The Go To, JavaScript, Submit Form or Reset Form action to be performed when the PDF document is opened.
|
| Pages |
Gets the collection of pages of this PDF document.
|
| Security |
Offers access to security features of the PDF document like encryption.
|
| TableOfContents |
Gets a reference to the object controlling the automatic creation of a table of contents in the generated PDF document
based on HtmlToPdfElement and HtmlToImageElement objects added to PDF document
|
| Templates |
Gets the collection of templates of this PDF document.
|
| TransparencyEnabled |
Gets or sets a flag indicating if the transparency is enabled in the PDF document.
Default value is true. This property can be set to false to eliminate the additional flattening time
when the document is sent to the printer from Adobe Reader viewer.
|
| ViewerPreferences |
Offers access to the viewer preferences settings for the document.
|
Methods
| Name | Description | |
|---|---|---|
| AddBookmark(String, ExplicitDestination) |
Creates a root bookmark for the document
|
| AddBookmark(String, ExplicitDestination, Bookmark) |
Creates a child bookmark for the existing parentBookmark
|
| AddFileAttachment(String) |
Adds an attachment a given file to this PDF document
|
| AddFileAttachment(Stream, String) |
Adds an attachment with the given name from a stream to this PDF document
|
| AddFileAttachment(String, String) |
Adds an attachment a given file and given description to this PDF document
|
| AddFileAttachment(Stream, String, String) |
Adds an attachment with the given name and a given description from a stream to this PDF document
|
| AddFont(Byte) |
Adds a system font to the fonts collection. The font is created from the specified font data.
If the font was already added the method returns the existing font.
|
| AddFont(Font) |
Adds a system font to the fonts collection. If the font was already added
the method returns the existing font. By default the font
is embedded in the PDF document in order to support Unicode texts.
|
| AddFont(StandardCJKFont) |
Adds a standard CJK font to the collection.
If the font was already added the method returns the existing font.
|
| AddFont(StdFontBaseFamily) |
Adds a standard font to the fonts collection.
If the font was already added the method returns the existing font.
|
| AddFont(String) |
Adds a system font to the fonts collection. The font is created from the specified file.
If the font was already added the method returns the existing font.
|
| AddFont(Font, Boolean) |
Adds a system font to the fonts collection. If the font was already added
the method returns the existing font. The embedFont property indicates if the added font
will be embedded into the PDF document.
|
| AddFont(Byte, Single, FontStyle) |
Adds a system font to the fonts collection. The font is created from the specified font data with the specified style.
If the font was already added the method returns the existing font.
|
| AddFont(String, Single, FontStyle) |
Adds a system font to the fonts collection. The font is created from the specified file with the specified style.
If the font was already added the method returns the existing font.
|
| AddFooterTemplate |
Adds a footer with the given height to document
|
| AddHeaderTemplate |
Adds a header with the given height to document
|
| AddPage |
Creates a new PDF page and adds it to the collection. If there is a previous page in the
collection, the orientation and size are inherited from the that page otherwise a first page with
the default A4 size and Portrait orientation is created. The page margins are inherited from the
default document margins
|
| AddPage(Margins) |
Creates a new PDF page and adds it to the collection. If there is a previous page in the
collection, the orientation and size are inherited from the that page otherwise a first page with
the default A4 size and Portrait orientation is created
|
| AddPage(PdfPage) |
Adds the specified page to the document pages collection. The page to be added is allowed to be
from another document. The source document of the page to be added must remain opened until the
current document is saved.
|
| AddPage(PdfPageSize, Margins) |
Creates a new PDF page and adds it to the collection. If there is a previous page in the
collection, the page orientation is inherited from the that page otherwise a first page with
the specified size and Portrait orientation is created
|
| AddPage(PdfPageSize, Margins, PdfPageOrientation) |
Creates a new PDF page with the specified size, margins and orientation and adds it to the collection
|
| AddTemplate(RectangleF) |
Adds a new template with the specified bounds to the document templates collection.
|
| AddTemplate(Single, Single) |
Adds a new template with the specified width and height to the document templates collection.
The template location is top left corner of the page.
|
| AppendDocument(Document) |
Appends the document given as parameter to the current document.
The appended document must remain open until the current document is saved
|
| AppendDocument(Document, Int32, Int32) |
Appends a range of pages from the document given as parameter to the current document.
The appended document must remain open until the current document is saved
|
| AppendDocument(Document, Boolean, Boolean, Boolean) |
Appends the document given as parameter to the current document and optionally applies the current document header and footer to the
appended document pages if the appended document was loaded from an external file or stream
|
| AppendDocument(Document, Int32, Int32, Boolean, Boolean, Boolean) |
Appends a range of pages from the document given as parameter to the current document and optionally applies the current document header and footer to the
appended document pages if the appended document was loaded from an external file or stream
|
| Close |
Releases all the resources allocated by this PDF document. Always call this method after the document was saved.
If the document was created from a stream or file, the stream will be closed if it was not explicitly detached
by calling the DetachStream() before the document is closed.
|
| DetachStream |
Call this method to detach the stream from which this document was created. When this method is called before
calling Close(), the Close method will not close the detached stream.
|
| Equals | (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
 | GetPageCount(Stream) |
A fast method to obtain the page count of a PDF document from the given stream.
|
| GetPageCount(String) |
A fast method to obtain the page count of a PDF document from the given file path.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InsertDocument(Int32, Document) |
Inserts the document given as parameter in the current document at the given page index.
The appended document must remain open until the current document is saved
|
| InsertDocument(Int32, Document, Int32, Int32) |
Inserts a range of pages from the document given as parameter in the current document at the given page index.
The appended document must remain open until the current document is saved
|
| InsertDocument(Int32, Document, Boolean, Boolean, Boolean) |
Inserts the document given as parameter to the current document and optionally applies the current document header and footer to the
appended document pages if the appended document was loaded from an external file or stream
|
| InsertDocument(Int32, Document, Int32, Int32, Boolean, Boolean, Boolean) |
Inserts a range of pages from the document given as parameter to the current document and optionally applies the current document header and footer to the
appended document pages if the appended document was loaded from an external file or stream
|
| InsertPage(Int32, PdfPage) |
Inserts the specified page into the document pages collection given by the Pages property at the specified index.
The page to be added is allowed to be from another document.
The source document of the page to be inserted must remain opened until the
current document is saved.
|
| InsertPage(Int32, PdfPageSize, Margins, PdfPageOrientation) |
Creates a new PDF page with the specified size, margins and orientation and inserts it into the collection
at the specified index.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| RemovePage(Int32) |
Removes the PDF page at the specified index in pages collection.
|
| RemovePage(PdfPage) |
Removes the specified PDF page from the pages collection of this document.
|
| Save |
Saves the PDF document as byte array that can be further saved into a file or sent over HTTP to a browser.
|
| Save(Stream) |
Saves this PDF document into the specified output stream.
|
| Save(String) |
Saves this PDF document into the file given by the method parameter
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events
| Name | Description | |
|---|---|---|
 | ExternalPdfPageAddedEvent |
The event is raised after a page from an external PDF document is added to this document
|
See Also