 | |
Pdf | |
Represents a html element that can be added to a pdf document.
Inheritance HierarchyNamespace: SelectPdf
Assembly: Select.Pdf (in Select.Pdf.dll) Version: 26.2
SyntaxThe PdfHtmlElement type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PdfHtmlElement(String) | Creates a html object that can be added to a pdf document. |
| PdfHtmlElement(String, String) | Creates a html object that can be added to a pdf document. |
| PdfHtmlElement(Single, Single, String) | Creates a html object that can be added to a pdf document. |
| PdfHtmlElement(Single, Single, Single, String) | Creates a html object that can be added to a pdf document. |
| PdfHtmlElement(Single, Single, String, String) | Creates a html object that can be added to a pdf document. |
| PdfHtmlElement(Single, Single, Single, Single, String) | Creates a html object that can be added to a pdf document. |
| PdfHtmlElement(Single, Single, Single, String, String) | Creates a html object that can be added to a pdf document. |
| PdfHtmlElement(Single, Single, Single, Single, String, String) | Creates a html object that can be added to a pdf document. |
Properties| Name | Description | |
|---|---|---|
 | AllowContentHeightResize | A flag used only by WebKitRestricted, Blink or Chromium engines indicating if the content height can be recalculated to better fit the page. This can introduce certain errors in some cases. The default is True. Set it to False if content is split to more pages than expected. |
| Authentication | Handles authentication options if the web page being converted requires authentication. |
| AutoFitHeight | Specifies the vertical auto fit mode. |
| AutoFitWidth | Specifies the horizontal auto fit mode. |
| BackColor |
Gets or sets the pdf element background color.
(Inherited from PdfElement) |
| Blending |
Gets or sets the blending mode for transparent rendering of the pdf element.
(Inherited from PdfElement) |
| BlinkEngineLaunchMaxTries | Blink engine process launch tries. |
| BlinkEngineLaunchTimeout | Blink engine process launch timeout. |
| BlinkEnginePath | Gets or sets the full path (excluding the chrome.exe file name) of the Blink html rendering engine binaries. |
| BlinkEngineTemporaryFilesPath | Gets or sets the full path of a folder where Blink html rendering engine will write temporary files. |
| CefEnginePath | Gets or sets the full path of the folder containing the CEF (Chromium) html rendering engine binaries. |
| CefEngineTemporaryFilesPath | Gets or sets the full path of a folder where the CEF rendering engine will write temporary files. |
| ClickElementsDelayAfter | Delay in miliseconds, after element click. |
| ClickElementsDelayBefore | Delay in miliseconds, before element click. |
| ClickElementsSelectors | Specifies elements from the web page that will be clicked before converting the page. |
| ColorSpace |
Gets or sets the color space for the pdf element rendering.
(Inherited from PdfElement) |
| ConsoleLog | Returns the console log of the browser used to render the web page. |
| CssMediaType | Indicates what css styles are used when the web page is rendered. |
| CustomCSS | Use this property to specify some CSS styles that will be injected into the page that is converted. |
| DenyLocalFileAccess | A flag indicating if local files can be loaded during the conversion. The default value is False and local files can be loaded. |
| DisplayCutText | Gets or sets a flag indicating if the text that is out of the calculated rendering rectangle is displayed or not. |
| DisplayFooterOnEvenPages | Controls the visibility of the document footer on the even numbered pages generated by this pdf element. |
| DisplayFooterOnOddPages | Controls the visibility of the document footer on the odd numbered pages generated by this pdf element. |
| DisplayHeaderOnEvenPages | Controls the visibility of the document header on the even numbered pages generated by this pdf element. |
| DisplayHeaderOnOddPages | Controls the visibility of the document header on the odd numbered pages generated by this pdf element. |
| DrawBackground | Gets or sets a flag indicating if the web page background is rendered in pdf. |
| EmbedFonts | Instructs the converter to embed all the needed fonts into the pdf document or not. |
| ExternalBrowserEndpoint | External browser service. |
| ExternalLinksEnabled | Controls the rendering of external hyperlinks in pdf. |
| ForeColor |
Gets or sets the pdf element foreground color.
(Inherited from PdfElement) |
| Gradient |
Gets or sets the gradient used to fill a shape.
(Inherited from PdfElement) |
| HiddenWebElements | Gets a reference to the object that controls the visibility of some web elements in the generated pdf document. |
| HttpCookies | Gets the collection of custom HTTP cookies used for the conversion. |
| HttpHeaders | Get the collection of custom HTTP headers used for the conversion. |
| HttpPostParameters | Gets the collection of custom HTTP POST parameters used for the conversion. |
| InternalLinksEnabled | Controls the conversion of internal html links to internal pdf links. |
| JavaScriptEnabled | Enable scripts when rendering the url or html string. |
| KeepImagesTogether | This property instructs the converter whether to try to avoid cutting off the images between pdf pages or not. |
| KeepTextsTogether | This property instructs the converter whether to try to avoid cutting off the text lines between pdf pages or not. |
| LazyImagesLoadingDelay | Delay per page, in miliseconds, for lazy images loading. |
| LazyImagesLoadingEnabled | Enables a delay mechanism to allow images to fully load. |
| LFN | Internal use only. |
| LineStyle |
Gets or sets the line style for pdf elements rendering lines.
(Inherited from PdfElement) |
| LoginOptions | Handle custom page login. |
| MaxConversionTime | Timeout in seconds for the print phase. Applies to the Chromium rendering engine only. |
| MaxPageLoadTime | The web page navigation timeout in seconds. |
| MinPageLoadTime | An additional time in seconds to wait for asynchronous items to be loaded before the web page is rendered. |
| PageBreaksEnhancedAlgorithm | Gets or sets a flag indicating if an enhanced custom page breaks algorithm is used. The enhanced algorithm is a little bit slower but it will prevent the appearance of hidden text in the PDF when custom page breaks are used. |
| PdfBookmarkOptions | Gets a reference to the object that controls the bookmarks creation for the generated pdf document. |
| PdfPagesRectangles | The size and position of the html content rendered in all pages of the pdf document. |
| PluginsEnabled | A flag indicating if plugins (like Flash players) are enabled in the converter. |
| PostLoadingScript | Use this property to specify some JavaScript code that will be injected into the page that is converted and executed after the page was fully loaded. |
| PostLoadingScriptDelayAfter | Delay in miliseconds, after post page loading javascript injection. |
| ProxyOptions | Gets a reference to an object containing the proxy settings used to access the web page that is being converted. |
| RenderingEngine | Gets or sets the rendering engine used by the converter to load and render the HTML. The possible values are WebKit, WebKitRestricted and Blink. The Webkit rendering engine is internal and renders similar to Apple's Safari. For Blink, Chromium binaries must be also installed. |
| RenderPageOnTimeout | A flag indicating if the page is rendered even if a navigation timeout occurs. The default value is False and a navigation timeout exception is raised. |
| Rotated |
A flag to indicate if the current pdf element was rotated.
(Inherited from PdfElement) |
| Scaled |
A flag to indicate if the current pdf element was scaled.
(Inherited from PdfElement) |
| ScaleImages | A flag indicating if the images from the page are scaled during the conversion process. The default value is False and images are not scaled. |
| SecureProtocol | Protocol used for secure (HTTPS) connections. |
| Skewed |
A flag to indicate if the current pdf element was skewed.
(Inherited from PdfElement) |
| StartupMode | Use this property to specify how the conversion starts. |
| StartupScript | Use this property to specify some JavaScript code that will be injected into the page that is converted. |
| Translated |
A flag to indicate if the current pdf element was translated.
(Inherited from PdfElement) |
| Transparency |
Gets or sets the pdf element transparency.
(Inherited from PdfElement) |
| VisibleWebElementId | Use this property to convert only a certain section of the page, specified by the html element ID. |
| WebPageFixedSize | Controls whether the web page is rendered with a fixed size internal browser or the size automatically extends to make the whole content visible. |
| WebPageHeight | Gets or sets the height of the converted web page as it would appear in the internal browser used to render the html. |
| WebPageInformation | Gets an object populated after conversion with the title, keywords and description of the converted web page. |
| WebPageWidth | Gets or sets the width of the converted web page as it would appear in the internal browser used to render the html. |
Methods| Name | Description | |
|---|---|---|
| Rotate |
Rotes the coordinate system before rendering the pdf element.
(Inherited from PdfElement) |
| Scale |
Scales the coordinate system before rendering the pdf element.
(Inherited from PdfElement) |
| Skew |
Skews the x and y axis by an two different angles before rendering the pdf element.
(Inherited from PdfElement) |
| Translate |
Translates the coordinate system before rendering the pdf element.
(Inherited from PdfElement) |
Remarks
The html can be specified by either an url or a html string.
The html to pdf conversion is performed when the element is added to the drawing canvas (pdf page or template).
See Also