HiQPdf Client for .NET Core
Html
The base class for HTML converter objects
Definition
Namespace: HiQPdfClient
Assembly: HiQPdfClient.NetCore (in HiQPdfClient.NetCore.dll) Version: 16.0.0
Assembly: HiQPdfClient.NetCore (in HiQPdfClient.NetCore.dll) Version: 16.0.0
C#
public abstract class HtmlObjectBase : PdfDrawableObjectVB
Public MustInherit Class HtmlObjectBase
Inherits PdfDrawableObjectC++
public ref class HtmlObjectBase abstract : public PdfDrawableObjectF#
[<AbstractClassAttribute>]
type HtmlObjectBase =
class
inherit PdfDrawableObject
end- Inheritance
- Object PdfObject PdfDrawableObject HtmlObjectBase
- Derived
Properties
| AcceleratedCanvasEnabled | Controls if the accelerated canvas is enabled. This property is false by default |
| Authentication | The object exposed by this propery encapsulates a username and a password that can be used to access web pages requiring HTTP authentication in this HTML object |
| BackColor |
The PDF object back color
(Inherited from PdfDrawableObject) |
| BlendingMode |
The blending mode when this object is drawn in PDF.
This property is Normal by default
(Inherited from PdfDrawableObject) |
| BreakAfterHtmlElements | An array of HTML CSS selectors to select the HTML elements that will receive a page break after them in PDF document |
| BreakBeforeHtmlElements | An array of HTML CSS selectors to select the HTML elements that will receive a page break before them in PDF document |
| BreakInsideAvoidHtmlElements | An array of HTML CSS selectors to select the HTML elements not accepting page breaks inside them |
| BrowserHeight | The browser window height in pixels in this HTML object. The default height is set to render the entire HTML document |
| BrowserUserAgent | The browser custom user agent |
| BrowserWidth | The browser window width in pixels in this HTML object. The default width is 1200 pixels |
| BrowserZoom | The browser window zoom percentage. The default zoom is 100 |
| ClipRectangle |
The clip rectangle applied when drawing the object in PDF
(Inherited from PdfDrawableObject) |
| ConversionInfo | This property is initialized after conversion with an object containing information about the converted HTML document, about the HTML elements in the HTML document and about the regions rendered in the PDF document |
| ConvertedHtmlElementSelector | This property can be set with a value representing the CSS selector of the HTML element to be converted in this HTML object. If many elements in the HTML document are selected, only the the first one will be converted. The values of the attributes in the CSS selectors are case sensitive. If this property is not set then the whole HTML document is converted |
| ConvertHttpLinks | Controls if the HTTP links in the HTML document are converted to HTTP links in PDF in this HTML object. This property is true by default |
| ConvertInternalLinks | Controls if the internal links in HTML are converted to internal links in PDF in this HTML object. This property is true by default |
| DefaultCharset | The default character set to be used when the character set meta tag is not set in HTML document header |
| FitDestHeight | Controls if the content is scaled down to fit the PDF destination height iof this HTML object. This property is false by default |
| FitDestWidth | Controls if the content is scaled down to fit the PDF destination width of this HTML object. This property is true by default. When this property is true the images and the text font can be smaller than in HTML |
| ForceFitDestWidth | Controls if the content can be enlarged to fit the PDF destination width of this HTML object when FitDestWidth is true. This property is false by default |
| ForceNewPdfPages | Controls if a new PDF page is always created when the HTML object is laid out on the next PDF page. By default this property is false and if there is a next page already created in PDF document it will be used to layout this object |
| ForceResourcesDownload | Controls if the HTML converter object should force all possible resources to be downloaded in this HTML object. The default value is false |
| ForeColor |
The PDF object fore color
(Inherited from PdfDrawableObject) |
| Gradient |
The PDF object gradient color
(Inherited from PdfDrawableObject) |
| HtmlLoadedTimeout | The maximum time in seconds to wait for HTML document to be loaded in this HTML object. The default value is 120 seconds. An exception is thrown if the HTML document cannot be loaded in HtmlLoadedTimeout seconds |
| Http2Enabled | Controls if the HTTP2 protocol is enabled in NG version for this HTML object. The default value is false |
| HttpCookies | A collection of HTTP cookies to be used when accessing a web page in this HTML object |
| HttpHeaders | A collection of the HTTP headers to be used when accessing a web page in this HTML object |
| HttpPostFields | A collection of HTTP POST fields to be used when accessing a web page in this HTML object. If the collection is not empty, the converter will make a POST request to the web page URL with the fields from this collection. |
| ImagesCutAllowed | Controls if cutting images between PDF pages is permitted. This property is true by default |
| Impersonation | The object exposed by this propery encapsulates the properties controlling the internal browser impersonation in this HTML object |
| LayoutWithHinting | Controls if the hinting is used to layout HTML in this HTML object. Layout hinting is disabled by default. Enabling this property can improve the layout but it can make the conversion slower |
| LineStyle |
The style of the lines rendered by this object
(Inherited from PdfDrawableObject) |
| LiveExcludedElements | Controls if the HTML elements excluded from rendering are live in PDF. This property is false by default |
| LocalFilesLoadEnabled | Controls if the local files can be loaded by converter. This property is true by default |
| LocalStorageEnabled | Controls if the local web storage is enabled. This property is false by default |
| ManualTriggerWaitBeforeConvert | An additional time in seconds to wait before starting the conversion when the triggering mode is set to manual |
| MaxBrowserHeight | This property can be used to set a maximum limit in pixels for the rendered top part of a HTML document in this HTML object. The default value is 0 and the height is not limited |
| MaxImageTileHeight | The maximum height in pixels of the image tiles captured by converter in this HTML object |
| MediaType | Controls the media type for which to render the HTML document in this HTML object. If this property is null or empty the default media type is 'screen'. It can be set to a value like 'print' and in this case the CSS properties defined by the '@media print' rule will be used when the HTML is rendered |
| MinBrowserHeight | This property can be used to set a minimum height in pixels to be rendered in this HTML object. The default value is 0 pixels. This property is ignored when the BrowserHeight property is set |
| Opacity |
The element opacity as a value between 0 which means completely transparent to 100 which means completely opaque.
The object is completely opaque by default
(Inherited from PdfDrawableObject) |
| Outlines | Controls the outlines automatically generated by this HTML object |
| ProbeLayout | Controls if the HTML converter object should do a probe layout first in this HTML object. The default value is false |
| Proxy | The object exposed by this property encapsulates the parameters (address, username, password) that can be used to access web pages through a proxy server in this HTML object |
| RenderSvgFonts | Controls if the SVG fonts are rendered in this HTML object. The default value is false when converting HTML to PDF or SVG and true when converting HTML to a raster image |
| RenderWebFonts | Controls if the Web Fonts are rendered in this HTML object. The default value is true |
| RepeatFooterInEvenPages | Controls if the footer is repeated in even pages where this object is rendered. This property is true by default |
| RepeatFooterInOddPages | Controls if the footer is repeated in odd pages where this object is rendered. This property is true by default |
| RepeatHeaderInEvenPages | Controls if the header is repeated in even pages where this object is rendered. This property is true by default |
| RepeatHeaderInOddPages | Controls if the header is repeated in odd pages where this object is rendered. This property is true by default |
| RepeatHttpHeaders | This property controls if the headers defined by the HttpHeaders property are also used when accessing the resources referenced by the web page, not only when accessing the web page in this HTML object. The default value is true and the headers are repeated when accessing the referenced resources |
| RetrieveExcludedElements | Controls if the HTML elements excluded from rendering can be selected for detailed information retrieval. This property is true by default |
| RunExtensions | Controls if the browser extensions like Flash players are executed in this HTML object. The default value is false and no extension is executed |
| RunJavaScript | Controls if the JavaScript in the HTML document is executed in this HTML object. The default value of this property is true and the JavaScript is executed |
| SelectedHtmlElements | An array of HTML CSS selectors to select the HTML elements for which to retrieve detailed information in SelectedHtmlElementsInfo collection exposed by ConversionInfo property in this HTML object |
| StartBrowserHeight | This property can be used to set the starting height in pixels of the browser. This property is ignored when the BrowserHeight property is set |
| StopSlowScripts | Controls if the browser should interrupt slow scripts in the web page in this HTML object. The default value is false and the scripts are not stopped |
| Transform3DEnabled | Controls if the 3D transformations are enabled. This property is false by default |
| TriggerMode | The method of triggering the conversion in HTML object. The default value is Auto |
| TrimToBrowserWidth | If the HTML document cannot be entirely displayed in BrowserWidth pixels and the TrimToBrowserWidth is false then the browser window width will be automatically set to display the entire HTML document in this HTML object. If the HTML document cannot be entirely displayed in BrowserWidth pixels and the TrimToBrowserWidth is true then the browser window width will not be automatically set to display the entire HTML document and the HTML document will be trimmed |
| WaitBeforeConvert | An additional time in seconds to wait before starting the conversion to allow more time to JavaScript to update the web page in this HTML object. When the property is set with a positive value the TriggerMode property is automatically set to WaitTime. This property has effect only if the TriggerMode property is WaitTime |
| WebGLEnabled | Controls if the WebGL is enabled. This property is false by default |
Methods
| Equals | (Inherited from Object) |
| Finalize | (Inherited from Object) |
| GetHashCode | (Inherited from Object) |
| GetType | (Inherited from Object) |
| MemberwiseClone | (Inherited from Object) |
| SetRotationAngle |
Sets the clockwise rotation angle of the coordinates system before drawing this object in PDF
(Inherited from PdfDrawableObject) |
| SetScaling |
Sets the horizontal and vertical scaling of the coordinates system before drawing this object in PDF
(Inherited from PdfDrawableObject) |
| SetSkewAngles |
Sets the clockwise skew angles of the coordinates system before drawing this object in PDF
(Inherited from PdfDrawableObject) |
| SetTranslation |
Sets the horizontal and vertical translation of the coordinates system before drawing this object in PDF
(Inherited from PdfDrawableObject) |
| ToString | (Inherited from Object) |