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
WinnovativeClientDocument
Namespace: WinnovativeClient
Assembly: WinnovativeClient (in WinnovativeClient.dll) Version: 17.0.0.0 (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(Byte) |
Creates a PDF document object from the specified PDF document data.
|
| 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(String) |
Creates a PDF document from and existing PDF file.
|
| Document(UInt32) |
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(Boolean, String) |
Creates an empty PDF document object using a web service from a given URL.
New pages can be added to the document and new PDF elements can be added to document pages.
|
| Document(Byte, String) |
Creates a PDF document from binary data containing a password protected PDF document.
The specified password can be a user or owner password.
|
| 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(String, Byte) |
Creates a PDF document object from the specified PDF document data.
|
| Document(String, String) |
Creates a PDF document object from an existing password protected PDF file.
|
| Document(String, UInt32) |
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(String, ColorProfile) |
Creates a PDF document with a color profile.
|
| Document(String, 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(String, 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(UInt32, Byte) |
Creates a PDF document object from the specified PDF document data.
|
| Document(UInt32, String) |
Creates a PDF document from and existing PDF file.
|
| Document(UInt32, ColorProfile) |
Creates a PDF document with a color profile.
|
| Document(UInt32, 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(UInt32, 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(Boolean, String, Byte) |
Creates a PDF document object from the specified PDF document data using a web service from a given URL.
|
| Document(Boolean, String, String) |
Creates a PDF document from and existing PDF file using a web service from a given URL.
|
| Document(Boolean, String, ColorProfile) |
Creates a PDF document with a color profile using a web service from a given URL.
|
| Document(Boolean, String, ColorSpace) |
Creates a PDF document with the specified color space using a web service from a given URL. 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(Boolean, String, PdfStandardSubset) |
Creates a PDF document based on the specified PDF standard using a web service from a given URL.
By default the Full PDF standard is used.
This property can be used to create PDF/A or PDF/X compliant documents.
|
| Document(String, Byte, String) |
Creates a PDF document from binary data containing a password protected PDF document.
The specified password can be a user or owner password.
|
| Document(String, String, String) |
Creates a PDF document object from an existing password protected PDF file.
|
| Document(String, UInt32, Byte) |
Creates a PDF document object from the specified PDF document data.
|
| Document(String, UInt32, String) |
Creates a PDF document from and existing PDF file.
|
| Document(String, UInt32, ColorProfile) |
Creates a PDF document with a color profile.
|
| Document(String, UInt32, 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(String, UInt32, 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(String, 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(UInt32, Byte, String) |
Creates a PDF document from binary data containing a password protected PDF document.
The specified password can be a user or owner password.
|
| Document(UInt32, String, String) |
Creates a PDF document object from an existing password protected PDF file.
|
| Document(UInt32, 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(Boolean, String, Byte, String) |
Creates a PDF document from binary data containing a password protected PDF document using a web service from a given URL.
The specified password can be a user or owner password.
|
| Document(Boolean, String, String, String) |
Creates a PDF document object from an existing password protected PDF file using a web service from a given URL.
|
| Document(Boolean, String, PdfStandardSubset, ColorSpace) |
Creates a PDF document based on the specified PDF standard and using the specified color space
using a web service from a given URL.
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(String, UInt32, Byte, String) |
Creates a PDF document from binary data containing a password protected PDF document.
The specified password can be a user or owner password.
|
| Document(String, UInt32, String, String) |
Creates a PDF document object from an existing password protected PDF file.
|
| Document(String, UInt32, 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(Boolean, String, String, Byte, String) |
Creates a PDF document from binary data containing a password protected PDF document using a web service from a given URL.
The specified password can be a user or owner password.
|
| Document(Boolean, String, String, String, String) |
Creates a PDF document object from an existing password protected PDF file using a web service from a give URL.
|
| Document(Boolean, String, PdfStandardSubset, ColorSpace, ColorProfile) |
Creates a PDF document based on the specified PDF standard and using the specified color space and color profile
using a wb service from a given URL.
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(String, UInt32, String, Byte, String) |
Creates a PDF document from binary data containing a password protected PDF document.
The specified password can be a user or owner password.
|
| Document(String, UInt32, String, String, String) |
Creates a PDF document object from an existing password protected PDF file.
|
| Document(String, UInt32, 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.
|
| Document(Boolean, String, String, PdfStandardSubset, ColorSpace, ColorProfile) |
Creates a PDF document based on the specified PDF standard and using the specified color space and color profile
using a web service from a given URL.
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(String, UInt32, String, 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 | |
|---|---|---|
 | ClientProxy |
You can set this property with an object implementing the IWebProxy interface to be used when accessing the PDF Document Web Service
through a proxy server.
This property does not have any effect when using a TCP Service
|
| 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.
|
| 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. You can add a document footer with AddFooterTemplate(Single) method.
|
| 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. You can add a document footer with AddHeaderTemplate(Single) method.
|
| 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.
|
| PageCount |
Gets the current number of PDF pages
|
| Pages |
Gets the current list of PDF pages
|
| Port |
The server port number
|
| Security |
Offers access to security options of the PDF document like encryption.
|
| Server |
The server IP or name
|
| ServicePassword |
Gets or sets the HTML to PDF converter service password. You have to set this property if the HTML to PDF service is password protected.
|
| 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
|
| 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.
|
| UseWebService |
A flag indicating if the client library will call the Web service or the TCP service to create the PDF document
|
| ViewerPreferences |
Offers access to the viewer preferences settings for the document.
|
| WebServiceUrl |
The web service URL
|
Methods
| Name | Description | |
|---|---|---|
| AddBookmark(Bookmark) |
Adds a top level bookmark to PDF document
|
| AddBookmark(Bookmark, Bookmark) |
Adds a child bookmark to PDF document having a previously added bookmark as parent
|
| AddElement(PageElement) |
Adds a PDF page element to this document right after the last PDF element added to document or to a page
|
| AddElement(PageElement, Single) |
Adds a PDF page element to this document at the given Y offset after the last PDF element added to document or to a page
|
| AddElement(PageElement, Single, Single) |
Adds a PDF page element to this document at the given X offset and the given Y offset after the last PDF element
added to document or to a page
|
| AddElement(PageElement, Single, Boolean, Single, Boolean) |
Adds a PDF page element to this document at the given X and Y location in the PDF page where the last element rendering ended.
The location can be absolute in PDF page or relative as an offset from the position where the last element rendering ended.
|
| AddElement(PageElement, Single, Boolean, Boolean, Single, Boolean, Boolean) |
Adds a PDF page element to this document at the given X and Y location in the PDF page where the last element rendering ended.
The location can be absolute in PDF page or relative as an offset from the position where the last element rendering ended.
|
| AddFileAttachment(String) |
Adds an attachment a given file to this PDF document
|
| AddFileAttachment(Byte, String) |
Adds an attachment with the given name from binary data to this PDF document
|
| AddFileAttachment(String, String) |
Adds an attachment a given file and given description to this PDF document
|
| AddFileAttachment(Byte, String, String) |
Adds an attachment with the given name and a given description from binary data to this PDF document
|
| AddFooterTemplate |
Adds a footer with the given height to document
|
| AddFormField(PdfFormField) |
Adds a form field to this document right after the last PDF element added to document or to a page
|
| AddFormField(PdfFormField, Single) |
Adds a form field to this document at the given Y offset after the last PDF element added to document or to a page
|
| AddFormField(PdfFormField, Single, Single) |
Adds a form field to this document at the given X offset and the given Y offset after the last PDF element
added to document or to a page
|
| AddFormField(PdfFormField, Single, Boolean, Single, Boolean) |
Adds a form field to this document at the given X and Y location in the PDF page where the last element rendering ended.
The location can be absolute in PDF page or relative as an offset from the position where the last element rendering ended.
|
| AddFormField(PdfFormField, Single, Boolean, Boolean, Single, Boolean, Boolean) |
Adds a form field to this document at the given X and Y location in the PDF page where the last element rendering ended.
The location can be absolute in PDF page or relative as an offset from the position where the last element rendering ended.
|
| 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(PdfMargins) |
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(PdfPageSize, PdfMargins) |
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, PdfMargins, PdfPageOrientation) |
Creates a new PDF page with the specified size, margins and orientation and adds it to the collection
|
| AddPage(PdfPageSize, PdfMargins, PdfPageOrientation, RotationAngle) |
Creates a new PDF page with the specified size, margins and orientation and adds it to the 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.
|
| AddTemplate(Single, Single, Single, Single) |
Adds a new template with the specified bounds to the document templates collection.
|
| AppendDocument(Byte) |
Appends the PDF document given as parameter to the current document
|
| AppendDocument(String) |
Appends the PDF file given as parameter to this document
|
| AppendDocument(Byte, String) |
Appends the password protected PDF document given as parameter to the current document
|
| AppendDocument(String, String) |
Appends the password protected PDF file given as parameter to this document
|
| AppendDocument(Byte, Boolean, Boolean, Boolean) |
Appends the PDF document given as parameter to the current document and optionally applies the current document header and footer to the
appended document pages
|
| AppendDocument(String, Boolean, Boolean, Boolean) |
Appends the PDF file given as parameter to the current document and optionally applies the current document header and footer to the
appended document pages
|
| AppendDocument(Byte, String, Boolean, Boolean, Boolean) |
Appends the password protected PDF document given as parameter to the current document and optionally applies the current document header and footer to the
appended document pages
|
| AppendDocument(String, String, Boolean, Boolean, Boolean) |
Appends the password protected PDF file given as parameter to the current document and optionally applies the current document header and footer to the
appended document pages
|
| Close |
Releases all the resources allocated by this PDF document
|
| 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.) |
| GetPage |
Gets the PDF page from the given index or null if the index is out of bounds
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IndexOfPage |
Gets the index of a PDF page in pages collection
|
| InsertDocument(Int32, Byte) |
Inserts the PDF document given as parameter in the current document at the given page index
|
| InsertDocument(Int32, String) |
Inserts the PDF file given as parameter in the current document at the given page index
|
| InsertDocument(Int32, Byte, String) |
Inserts the password protected PDF document given as parameter in the current document at the given page index
|
| InsertDocument(Int32, String, String) |
Inserts the password protected PDF file given as parameter in the current document at the given page index
|
| InsertDocument(Int32, Byte, Boolean, Boolean, Boolean) |
Inserts the PDF document given as parameter to the current document and optionally applies the current document header and footer to the
appended document pages
|
| InsertDocument(Int32, String, Boolean, Boolean, Boolean) |
Inserts the PDF file given as parameter to the current document and optionally applies the current document header and footer to the
appended document pages
|
| InsertDocument(Int32, Byte, String, Boolean, Boolean, Boolean) |
Inserts the password protected PDF document given as parameter to the current document and optionally applies the current document header and footer to the
appended document pages
|
| InsertDocument(Int32, String, String, Boolean, Boolean, Boolean) |
Inserts the password protected PDF file given as parameter to the current document and optionally applies the current document header and footer to the
appended document pages
|
| InsertPage(Int32, PdfPageSize, PdfMargins, PdfPageOrientation) |
Creates a new PDF page with the specified size, margins and orientation and inserts it into the collection
at the specified index.
|
| InsertPage(Int32, PdfPageSize, PdfMargins, PdfPageOrientation, RotationAngle) |
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.) |
| Save |
Saves the PDF document as byte array that can be further saved into a file or sent over HTTP to a browser.
|
| 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.) |
See Also