Objects of this class can be used to render a HTML string or an URL to a specified position in the header or footer of the document.
The PdfConverter.PdfHeaderOptions.HtmlToPdfArea property can be set with an object of this type.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class HtmlToPdfArea : PdfElement
Public Class HtmlToPdfArea _ Inherits PdfElement
public ref class HtmlToPdfArea : public PdfElement
Members| All Members | Constructors | Methods | Properties | Fields | |
| Icon | Member | Description |
|---|---|---|
 | HtmlToPdfArea(String, String) |
Creates a HTML string to PDF converter element and places the rendered PDF content inside a rectangle with the top left corner at (0,0) coordinate and
having the width equal to PDF page width. The converter is using the default values for the HTML viewer width and height.
The HTML string to convert is given by the htmlStringToConvert parameter.
|
| HtmlToPdfArea(String) |
Creates an URL to PDF converter element and places the rendered PDF content inside a rectangle with the top left corner at (0,0) coordinate and
having the width equal to PDF page width.
The URL to convert is given by the urlToConvert parameter.
The converter is using the default values for HTML viewer width and height.
|
| HtmlToPdfArea(Single, Single, String, String) |
Creates a HTML string to PDF converter element and places the rendered PDF content inside a rectangle with the top left corner at (x,y) coordinate and
having the width equal to the available width in PDF page. The converter is using the default values for the HTML viewer width and height.
The HTML string to convert is given by the htmlStringToConvert parameter.
|
| HtmlToPdfArea(Single, Single, String) |
Creates an URL to PDF converter element and places the rendered PDF content inside a rectangle with the top left corner at (x,y) coordinate and
having the width equal to the available width in PDF page.
The URL to convert is given by the urlToConvert parameter.
The converter is using the default values for HTML viewer width and height.
|
| HtmlToPdfArea(Single, Single, Single, String, String) |
Creates a HTML string to PDF converter element and places the rendered PDF content inside a rectangle with the top left corner at (x,y) coordinate and
having the width equal to the width specified as parameter.
The converter is using the default values for the HTML viewer width and height.
The HTML string to convert is given by the htmlStringToConvert parameter.
|
| HtmlToPdfArea(Single, Single, Single, String) |
Creates an URL to PDF converter element and places the rendered PDF content inside a rectangle with the top left corner at (x,y) coordinate and
having the width equal to the width specified as parameter. The URL to converter is given by the urlToConvert parameter.
The converter is using the default values for HTML viewer width and height.
|
| HtmlToPdfArea(Single, Single, Single, String, String, Int32) |
Creates a HTML string to PDF converter element and places the rendered PDF content inside a rectangle with the top left corner at (x,y) coordinate and
having the width equal to the width specified as parameter. The HTML string to convert is given by the htmlStringToConvert parameter.
The converter is using the specified value for HTML viewer width and the default value for the HTML viewer height.
|
| HtmlToPdfArea(Single, Single, Single, String, Int32) |
Creates an URL to PDF converter element and places the rendered PDF content inside a rectangle with the top left corner at (x,y) coordinate and
having the width equal to the width specified as parameter. The URL to converter is given by the urlToConvert parameter.
The converter is using the value specified as parameter for HTML viewer width and the default value for the HTML viewer height.
|
| HtmlToPdfArea(Single, Single, Single, String, String, Int32, Int32) |
Creates a HTML string to PDF converter element and places the rendered PDF content inside a rectangle with the top left corner at (x,y) coordinate and
having the width equal to the width specified as parameter. The HTML string to convert is given by the htmlStringToConvert parameter.
The converter is using the values specified as parameters for HTML viewer width and height.
|
| HtmlToPdfArea(Single, Single, Single, Single, String, String, Int32, Int32) |
Creates a HTML string to PDF converter element and places the rendered PDF content inside a rectangle with the top left corner at (x,y) coordinate and
having the width and height equal to the width and height specified as parameters. The HTML string to convert is given by the htmlStringToConvert parameter.
The converter is using the values specified as parameters for HTML viewer width and height.
|
| HtmlToPdfArea(Single, Single, Single, String, Int32, Int32) |
Creates an URL to PDF converter element and places the rendered PDF content inside a rectangle with the top left corner at (x,y) coordinate and
having the width equal to the width specified as parameter. The URL to converter is given by the urlToConvert parameter.
The converter is using the values specified as parameters for HTML viewer width and height.
|
| HtmlToPdfArea(Single, Single, Single, Single, String, Int32, Int32) |
Creates an URL to PDF converter element and places the rendered PDF content inside a rectangle with the top left corner at (x,y) coordinate and
having the width and height equal to the width and height specified as parameters. The URL to converter is given by the urlToConvert parameter.
The converter is using the values specified as parameters for HTML viewer width and height.
|
 | 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 |
A small value to subtract from the width and hight of the colored background to make the thin lines of 1 pixel around this background more visible
when zooming out in the Adobe Reader PDF Viewer. The default value is 0.5 pixels.
|
| AdjustThinLinesWidth |
A small increment value for the 1 pixel thin lines width to make them more visible
when zooming out in the Adobe Reader PDF Viewer. The default value is 0 pixels.
|
| AlphaBlendEnabled |
Enables or disables alpha blending for transparent images. Default is true.
|
| AuthenticationOptions |
The AuthenticationOptions can be set with an username and a password in order to authenticate to the web server
before accessing the URL to be converted. They can be used for example to resolve the IIS Integrated Windows Authentication
or other types of IIS authentication. They cannot be used to resolve ASP.NET Forms Authentication
or a custom authentication method defined at application level.
|
| 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
|
| BatchConversion |
This property is obsolete.
|
| 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.
|
| ConversionDelay |
An additional time in seconds to wait for asynchronous items to be loaded.
A delay is necessary for example to allow a Flash movie to start before starting conversion.
|
  | DEFAULT_HTML_VIEWER_WIDTH_PX |
The default virtual browser width in pixels
|
| DrawBackColors |
Gets or sets a flag indicating if the background color of the HTML elements is rendered in PDF.
Default value is true.
|
| 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.) |
 | 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
|
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| 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 converter 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
when the HtmlToPdfArea is added to a PDF page.
The default value is true.
|
| InternetSecurityZone |
Specifies the internet security zone settings used by the HTML converter to convert web sites.
|
| LiveUrlsEnabled |
When true this options instructs the converter to convert the html links in PDF links.
The default value is true.
|
| 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.
|
| RightToLeftEnabled |
This property is obsolete. Setting this property is not necessary anymore when converting pages in
right-to-left languages like Hebrew or Arabic.
|
| ScriptsEnabled |
Enable scripts when rendering HTML to selectable PDF.
Default is false.
|
| ScriptsEnabledInImage |
Enable scripts when rendering HTML to image.
Default is true.
|
| 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.) |
| TruncateOutOfBoundsText |
Internal use only.
|
Inheritance Hierarchy| Object | ||
 | PdfElement | |
| HtmlToPdfArea | |