This class encapsulates a HTML to PDF converter. The HTML to PDF conversion is performed
when the element is added to a PDF page.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public sealed class HtmlToPdfElement : PageGraphicElement
Public NotInheritable Class HtmlToPdfElement _ Inherits PageGraphicElement
public ref class HtmlToPdfElement sealed : public PageGraphicElement
Members| All Members | Constructors | Methods | Properties | Fields | Events |
| Icon | Member | Description |
|---|---|---|
 | HtmlToPdfElement(String, String) |
Creates a HTML string to PDF converter element that will be rendered at the (0,0) location in PDF page.
The width of element in PDF page is the available width in PDF page and the height is auto determined.
|
| HtmlToPdfElement(String, String, String) |
Creates a HTML string to PDF converter element that will be rendered at the (0,0) location in PDF page.
The width of element in PDF page is the available width in PDF page and the height is auto determined.
|
| HtmlToPdfElement(String) |
Creates a URL to PDF converter element at the (0,0) location in PDF page.
The width of element in PDF page is the available width in PDF page and the height is auto determined.
|
| HtmlToPdfElement(Single, Single, String, String) |
Creates a HTML string to PDF converter element at the specified x and y coordinates in PDF page.
The width of element in PDF page is the available width in PDF page and the height is auto determined.
|
| HtmlToPdfElement(Single, Single, String, String, String) |
Creates a HTML string to PDF converter element at the specified x and y coordinates in PDF page.
The width of element in PDF page is the available width in PDF page and the height is auto determined.
|
| HtmlToPdfElement(Single, Single, String) |
Creates a URL to PDF converter element at the specified x and y coordinates in PDF page.
The width of element in PDF page is the available width in PDF page and the height is auto determined.
|
| HtmlToPdfElement(Single, Single, Single, String, String) |
Creates a HTML string to PDF converter element at the specified x and y coordinates with the specified
width. The height in PDF is auto determined.
|
| HtmlToPdfElement(Single, Single, Single, String, String, String) |
Creates a HTML string to PDF converter element at the specified x and y coordinates with the specified
width. The height in PDF is auto determined.
|
| HtmlToPdfElement(Single, Single, Single, String) |
Creates a URL to PDF converter element at the specified x and y coordinates with the specified
width. The height in PDF is auto determined.
|
| HtmlToPdfElement(Single, Single, Single, Single, String, String) |
Creates a HTML string to PDF converter element at the specified x and y coordinates with the specified
width and height.
|
| HtmlToPdfElement(Single, Single, Single, Single, String, String, String) |
Creates a HTML string to PDF converter element at the specified x and y coordinates with the specified
width and height.
|
| HtmlToPdfElement(Single, Single, Single, Single, String) |
Creates a URL to PDF converter element at the specified x and y coordinates with the specified
width and height.
|
| HtmlToPdfElement(Single, Single, Single, String, String, Int32) |
Create a HTML string to PDF converter element at the specified x and y coordinates with the specified
width. The height in PDF is auto determined. The virtual browser width in pixels is specified by the htmlViewerWidth parameter.
|
| HtmlToPdfElement(Single, Single, Single, String, String, String, Int32) |
Create a HTML string to PDF converter element at the specified x and y coordinates with the specified
width. The height in PDF is auto determined. The virtual browser width in pixels is specified by the htmlViewerWidth parameter.
|
| HtmlToPdfElement(Single, Single, Single, String, Int32) |
Creates a URL to PDF converter element at the specified x and y coordinates with the specified
width. The height in PDF is auto determined. The virtual browser width in pixels is specified by the htmlViewerWidth parameter.
|
| HtmlToPdfElement(Single, Single, Single, Single, String, String, Int32, Int32) |
Creates a HTML string to PDF converter element at the specified x and y coordinates with the specified
width and height. The virtual browser width and height in pixels is specified by
the htmlViewerWidth and htmlViewerHeight parameters.
|
| HtmlToPdfElement(Single, Single, Single, Single, String, String, String, Int32, Int32) |
Creates a HTML string to PDF converter element at the specified x and y coordinates with the specified
width and height. The virtual browser width and height in pixels is specified by
the htmlViewerWidth and htmlViewerHeight parameters.
|
| HtmlToPdfElement(Single, Single, Single, Single, String, Int32, Int32) |
Create a URL to PDF converter element at the specified x and y coordinates with the specified
width and height. The virtual browser width and height in pixels are specified by the
htmlViewerWidth and htmlViewerHeight paramenters.
|
| HtmlToPdfElement(Single, Single, Single, Single, String, Int32, Int32, String) |
Create a URL to PDF converter element at the specified x and y coordinates with the specified
width and height. The virtual browser width and height in pixels are specified by the
htmlViewerWidth and htmlViewerHeight paramenters.
|
 | ActiveXEnabled |
Enable ActiveX when rendering HTML to selectable PDF.
Default is false.
|
| ActiveXEnabledInImage |
Enable ActiveX when rendering HTML to image.
Default is true.
|
| AddPadding |
Add padding at the end of the conversion result.
Default is false.
|
| AdjustBorderSize |
There are situations when a fraction of the right and bottom borders of an image or
table cell are overwritten by the image content or table cell background when the PDF document is viewed with Adobe Reader.
The AdjustBorderSize value is subtracted from the background width and height.
The default value is 0 points.
|
| AlphaBlendEnabled |
Enables or disables alpha blending for transparent images. Default is true.
|
| AuthenticationOptions |
Server authentication options (e.g IIS authentication)
|
  | AUTO_HTML_VIEWER_HEIGHT_PX |
The default virtual browser height in pixels is set to autodetect the HTML content height.
|
| AUTO_PDF_HEIGHT_POINTS |
The default width in PDF of the element is set to available width in PDF page.
|
| AVAILABLE_PDF_WIDTH_POINTS |
The default width in PDF of the element is set to available width in PDF page.
|
| AvoidImageBreak |
When true this property instructs the converter to try to
avoid cutting off the images between PDF pages
|
| AvoidTextBreak |
When true this property instructs the converter to try to
avoid cutting off the text between PDF pages
|
| BackColor |
Gets or sets element background color.
(Inherited from PageGraphicElement.) |
| BatchConversion |
This property is obsolete.
|
 | BeforeCreateNextPageEvent |
This event is raised when the next page is about to be created to continue rendering.
The element rendering can be cancelled from the event handler of this event.
|
| BeforeRenderNextPageEvent |
This is event is raised before rendering the content on a page, including the intial page.
The element rendering can be cancelled from the event handler of this event.
|
| BehaviorsEnabled |
Enable behaviors when rendering HTML to image.
Default is false.
|
| BinaryBehaviorsEnabled |
Internal use.
Default is false.
|
| BkgTransparency |
Modify background transparency. 0 means transparent, 100 means opaque.
|
| Blending |
Gets or sets blending mode for transparent rendering mode of the element.
(Inherited from PageGraphicElement.) |
| ColorSpace |
Gets or sets color space for element rendering.
(Inherited from PageGraphicElement.) |
| ConversionDelay |
An additional time in seconds to wait for asynchronous items to be loaded
|
| DEFAULT_HTML_VIEWER_WIDTH_PX |
The default virtual browser width in pixels
|
| DrawBackground |
Gets or sets a flag indicating if the HTML page background is rendered in PDF.
Default value is true. Setting this property to false can make visible the existing
PDF content behind this element.
|
| EmbedFonts |
When true this options instructs the converter to embed all the true type fonts into the PDF document.
The default value is false.
|
| Equals(Object) | (Inherited from Object.) |
| ExternalSampling |
Internal use only
|
 | Finalize()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
| FitHeight |
When this property is true the HTML content will be resized if necessary to fit the available height in PDF page.
By default this property is false.
|
| FitWidth |
When this property is true the HTML content will be resized if necessary to fit the available width in PDF page.
When false the HTML content will be rendered at the real size. By default this property is true and
the content will be resized if necessary to fit the available width in PDF page.
|
| ForeColor |
Gets or sets the element foreground color.
(Inherited from PageGraphicElement.) |
| GetHashCode()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| Gradient |
The gradient used to fill a shape.
(Inherited from PageGraphicElement.) |
| HtmlDocumentInfo |
Gets an object populated after conversion with the title, keywords, and description of the converted HTML document.
|
| HtmlElementsMappingOptions |
Gets a reference to the object controlling the retrieval of HTML elements position in the generated PDF.
In order to retrieve the position in PDF for a list of HTML elements, the HtmlElementIds and HtmlTagNames properties of
HtmlElementsMappingOptions must be set with an array of strings containing the HTML IDs and tag names of the HTML elements.
The positions of the HTML elements in the generated PDF document will be returned in the
HtmlElementsMappingResult object after the element was added to the page.
|
| HtmlExcludedRegionsOptions |
Gets a reference to the object controlling the exclusion of HTML elements from rendering to PDF.
In order to exclude from PDF for a list of HTML elements, the HtmlElementIds and HtmlTagNames properties of
HtmlExcludedRegionsOptions must be set with an array of strings containing the HTML IDs or tag names
of the HTML elements excluded from conversion to PDF.
|
| HtmlViewerHeight |
Gets or sets the HTML viewer height in pixels. If the viewer width was not set,
this property has no effect
|
| HtmlViewerWidth |
Gets or sets the HTML viewer width in pixels
|
| HttpRequestHeaders |
Gets or sets a string containing the HTTP headers sent by the convertor to the web server
when the web page is requested from a URL.
The HTTP headers string can be used to define cookies, authentication options, URL referer or any other
HTTP header to be sent to the web browser.
|
| ImgTransparency |
Modify images transparency. 0 means transparent, 100 means opaque.
|
| InternalLinksEnabled |
When true this options instructs the converter to convert the internal HTML links to internal PDF links.
The default value is true.
|
| InternetSecurityZone |
Specifies the internet security zone settings used by the HTML converter to convert web sites.
|
| LayoutHtmlTimeoutSec |
This static parameter gives the maximum time in seconds necessary to layout a HTML document.
The default value is 10 minutes.
|
| LineStyle |
Gets or sets the line style for elements rendering lines.
(Inherited from PageGraphicElement.) |
| LiveUrlsEnabled |
When true this options instructs the converter to convert the HTML links in PDF links.
The default value is true.
|
| LoadHtmlConcurrencyLevel |
This static parameter gives the maximum number of threads in the current process that can download and execute
HTML documents simultaneously.
This parameter must be set before the first conversion performed in the current process.
When this parameter is 0 or negative and SerializeLoadHtml is false the concurrency level is the maximum value.
The default value is 5.
|
| MaskBltEnabled |
Enables or disables masking for transparent images. Default is true.
|
| MemberwiseClone()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| NavigationTimeout |
The navigation timeout in seconds. Default value is 60.
|
| OptimizeMemoryUsage |
When this property is true the library will try to release the unused memory as soon as possible.
The default value is true.
|
| OptimizePdfPageBreaks |
A flag indicating if the converter uses an optimized page breaks algorithm to improve
document scrolling inside a PDF Viewer. The optimized algorithm can introduce a small
additional processing time when the PDF document is generated.
The default value is true and the optimized page breaks algorithm is used by default.
|
| Paginate |
When true the element can be paginated
|
| PdfBookmarkOptions |
Gets a reference to the object controlling the bookmarks creation for the rendered PDF document.
In order to enable creation of bookmarks you have to set the TagNames property of PdfBookmarkOptions
with the names of the HTML tags you want to bookmark.
|
| PdfConverterConcurrencyLevel |
This static parameter gives the maximum number of threads in the current process that can convert HTML to PDF simultaneously.
This parameter must be set before the first conversion performed in the current process.
When this property is set with a negative value or zero the concurrency level is maximum. The default value is 8.
|
| RenderedPagesRectangles |
The bounds of the rendered rectangle on each PDF page. This property is assigned
after the element has been added to a PDF page.
|
| RightToLeftEnabled |
This property is obsolete. Setting this property is not necessary anymore when converting pages in
right-to-left languages like Hebrew or Arabic.
|
| Rotate(Single) |
Rotates the coordinate system axes clockwise by the specified angle before rendering the element.
The coordinates of the element are relative to the rotated coordinates system.
(Inherited from PageGraphicElement.) |
| Rotated |
A flag to indicate if this element was rotated.
(Inherited from PageGraphicElement.) |
| SampleHtmlString |
Internal use only
|
| SamplingEnabled |
Internal use only
|
| SamplingModeAuto |
Internal use only
|
| Scale(Single, Single) |
Scales the coordinates so that 1 unit in the horizontal and vertical dimensions of the new coordinate system
is the same size as sx and sy units, respectively, in the previous coordinate system.
(Inherited from PageGraphicElement.) |
| Scaled |
A flag to indicate if this element was scaled.
(Inherited from PageGraphicElement.) |
| ScriptsEnabled |
Enable scripts when rendering HTML to selectable PDF.
Default is false.
|
| ScriptsEnabledInImage |
Enable scripts when rendering HTML to image.
Default is true.
|
| SerializeLoadHtml |
This static flag indicates if the download and execution of the HTML code is serialized
when the converter is called simultaneously from multiple threads of an application.
This parameter must be set before the first conversion performed in the current process.
Default value is false.
|
| ShowFooterOnEvenPages |
Show or not the document footer on even pages generated by this element. By default the footer is displayed both on odd and even pages.
|
| ShowFooterOnOddPages |
Show or not the document footer on odd pages generated by this element. By default the footer is displayed both on odd and even pages.
The ShowFooterTemplate property of the page to which this element is added has priority over ShowFooterOnOddPages.
|
| ShowHeaderOnEvenPages |
Show or not the document header on even pages generated by this element. By default the header is displayed both on odd and even pages.
|
| ShowHeaderOnOddPages |
Show or not the document header on odd pages generated by this element. By default the header is displayed both on odd and even pages.
The ShowHeaderTemplate property of the page to which this element is added has priority over ShowHeaderOnOddPages.
|
| Skew(Single, Single) |
Skews the x axis by an skewXAngle and the y axis by an skewYAngle
before rendering the element.
(Inherited from PageGraphicElement.) |
| Skewed |
A flag to indicate if this element was skewed.
(Inherited from PageGraphicElement.) |
| StretchToFit |
This property has effect only when FitWidth property is true. When FitWidth is true and this property is true
the HTML content will be stretched if necessary to fit the available width in PDF page.
By default this property is false and the content will not be stretched to fit the available width in PDF page.
|
| ToString()()() | (Inherited from Object.) |
| Translate(Single, Single) |
Translates the coordinate system before rendering the element.
The coordinates of the element are relative to the translated coordinate system.
(Inherited from PageGraphicElement.) |
| Translated |
A flag to indicate if this element was translated.
(Inherited from PageGraphicElement.) |
| Transparency |
Gets or sets element transparency. The transparency is expressed as a value between 0 and 100.
0 means completely transparent and 100 completely opaque.
(Inherited from PageGraphicElement.) |
| TruncateOutOfBoundsText |
Internal use only.
|
Inheritance Hierarchy| Object | |||
 | PageElement | ||
| PageGraphicElement | ||
| HtmlToPdfElement | ||