Class HtmlToPdfVariableElement

Namespace

EvoPdf

Assembly

evohtmltopdf.dll

This class encapsulates a HTML to PDF converter functionality. Objects of this class can be added at any location in a Template to render HTML. A conversion is performed for each PDF page where the Template is rendered.

[ClassInterface(ClassInterfaceType.AutoDual)]
public class HtmlToPdfVariableElement : HtmlToPdfElement

Inheritance

object

PageElement

PageGraphicElement

HtmlToPdfElement

HtmlToPdfVariableElement

Inherited Members

HtmlToPdfElement.DEFAULT_HTML_VIEWER_WIDTH_PX

HtmlToPdfElement.AUTO_HTML_VIEWER_HEIGHT_PX

HtmlToPdfElement.AVAILABLE_PDF_WIDTH_POINTS

HtmlToPdfElement.AUTO_PDF_HEIGHT_POINTS

HtmlToPdfElement.HtmlViewerWidth

HtmlToPdfElement.HtmlViewerHeight

HtmlToPdfElement.NavigatorUserAgent

HtmlToPdfElement.HtmlViewerZoom

HtmlToPdfElement.Url

HtmlToPdfElement.BaseUrl

HtmlToPdfElement.X

HtmlToPdfElement.Y

HtmlToPdfElement.Width

HtmlToPdfElement.Height

HtmlToPdfElement.TopSpacing

HtmlToPdfElement.BottomSpacing

HtmlToPdfElement.ClipHtmlView

HtmlToPdfElement.AvoidTextBreak

HtmlToPdfElement.AvoidImageBreak

HtmlToPdfElement.AvoidHtmlElementsBreakSelectors

HtmlToPdfElement.PageBreakBeforeHtmlElementsSelectors

HtmlToPdfElement.PageBreakAfterHtmlElementsSelectors

HtmlToPdfElement.FitWidth

HtmlToPdfElement.FitHeight

HtmlToPdfElement.StretchToFit

HtmlToPdfElement.LiveUrlsEnabled

HtmlToPdfElement.InteractiveHiddenElements

HtmlToPdfElement.InternalLinksEnabled

HtmlToPdfElement.JavaScriptEnabled

HtmlToPdfElement.Enable3DTransformations

HtmlToPdfElement.EnableWebGL

HtmlToPdfElement.EnableAccelerated2DCanvas

HtmlToPdfElement.EnablePersistentStorage

HtmlToPdfElement.LocalFilesAccessEnabled

HtmlToPdfElement.Paginate

HtmlToPdfElement.EmbedFonts

HtmlToPdfElement.HttpPostFields

HtmlToPdfElement.MediaType

HtmlToPdfElement.SvgFontsEnabled

HtmlToPdfElement.WebFontsEnabled

HtmlToPdfElement.EnableHttp2

HtmlToPdfElement.PostScriptFontsEnabled

HtmlToPdfElement.ExtensionsEnabled

HtmlToPdfElement.DownloadAllResources

HtmlToPdfElement.PrerenderEnabled

HtmlToPdfElement.InterruptSlowJavaScript

HtmlToPdfElement.HiddenHtmlElementsSelectors

HtmlToPdfElement.RenderedHtmlElementSelector

HtmlToPdfElement.MaxHtmlViewerHeight

HtmlToPdfElement.MinHtmlViewerHeight

HtmlToPdfElement.InitialHtmlViewerHeight

HtmlToPdfElement.DefaultHtmlEncoding

HtmlToPdfElement.ImagePartSize

HtmlToPdfElement.TriggeringMode

HtmlToPdfElement.ConversionDelay

HtmlToPdfElement.ManualTriggeringConversionDelay

HtmlToPdfElement.NavigationTimeout

HtmlToPdfElement.HttpRequestHeaders

HtmlToPdfElement.PersistentHttpRequestHeaders

HtmlToPdfElement.HttpRequestCookies

HtmlToPdfElement.XPSupplementalLanguages

HtmlToPdfElement.TiledRenderingEnabled

HtmlToPdfElement.InsertNewPagesEnabled

HtmlToPdfElement.EnhancedGraphicsQuality

HtmlToPdfElement.TransparentImagesEnabled

HtmlToPdfElement.ImagesScalingEnabled

HtmlToPdfElement.NoSizeElementsEnabled

HtmlToPdfElement.TableHeaderRepeatEnabled

HtmlToPdfElement.TableFooterRepeatEnabled

HtmlToPdfElement.StackRepeatedTableHeaders

HtmlToPdfElement.StackRepeatedTableFooters

HtmlToPdfElement.EvoInternalFileName

HtmlToPdfElement.ProxyOptions

HtmlToPdfElement.AuthenticationOptions

HtmlToPdfElement.ImpersonationOptions

HtmlToPdfElement.PdfBookmarkOptions

HtmlToPdfElement.TableOfContentsEnabled

HtmlToPdfElement.PdfFormOptions

HtmlToPdfElement.HtmlElementsMappingOptions

HtmlToPdfElement.RenderedPagesRectangles

HtmlToPdfElement.HtmlDocumentInfo

HtmlToPdfElement.PrepareRenderPdfPageEvent

HtmlToPdfElement.BeforeRenderPdfPageEvent

HtmlToPdfElement.AfterRenderPdfPageEvent

HtmlToPdfElement.NavigationCompletedEvent

PageGraphicElement.Translate(float, float)

PageGraphicElement.Scale(float, float)

PageGraphicElement.Rotate(float)

PageGraphicElement.Skew(float, float)

PageGraphicElement.BackColor

PageGraphicElement.ForeColor

PageGraphicElement.Opacity

PageGraphicElement.Blending

PageGraphicElement.LineStyle

PageGraphicElement.Gradient

PageGraphicElement.Translated

PageGraphicElement.Scaled

PageGraphicElement.Rotated

PageGraphicElement.Skewed

PageGraphicElement.ClipRectangle

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

HtmlToPdfVariableElement(float, float, float, float, string, string)

Creates a HTML string to PDF converter element at the specified x and y coordinates with the specified width and height using a base URL to resolve the external resources.

public HtmlToPdfVariableElement(float x, float y, float width, float height, string htmlStringToConvert, string htmlStringBaseURL)

Parameters

x float

The x position in points where the rendered content will be placed

y float

The y position in points where the rendered content will be placed

width float

The destination width in points for the rendered content. If the specified with is less or equal 0, the destination width will be given by the available width in page

height float

The destination height in points for the rendered content. If the specified height is less or equal 0, the destination height will be auto determined so all the content can be rendered. Please note that the specified height is the effective height that will be rendered in the PDF document and does not include for example the empty spaces introduced by custom or automatic page breaks.

htmlStringToConvert string

The HTML string convert to PDF.

htmlStringBaseURL string

The full URL of the page from where this string was taken used to resolve the images and CSS files referenced by a relative URL in the HTML string. This parameter is optional and the default value is NULL. When this parameter is NULL no base URL will be used.

HtmlToPdfVariableElement(float, float, float, float, string, string, int, int)

Creates a HTML string to PDF converter element at the specified x and y coordinates with the specified width and height using a base URL to resolve the external resources. The virtual browser width and height in pixels is specified by the htmlViewerWidth and htmlViewerHeight parameters.

public HtmlToPdfVariableElement(float x, float y, float width, float height, string htmlStringToConvert, string htmlStringBaseURL, int htmlViewerWidth, int htmlViewerHeight)

Parameters

x float

The x position in points where the rendered content will be placed

y float

The y position in points where the rendered content will be placed

width float

The destination width in points for the rendered content. If the specified with is less or equal 0, the destination width will be given by the available width in page

height float

The destination height in points for the rendered content. If the specified height is less or equal 0, the destination height will be auto determined so all the content can be rendered. Please note that the specified height is the effective height that will be rendered in the PDF document and does not include for example the empty spaces introduced by custom or automatic page breaks.

htmlStringToConvert string

The HTML string convert to PDF.

htmlStringBaseURL string

The full URL of the page from where this string was taken used to resolve the images and CSS files referenced by a relative URL in the HTML string. This parameter is optional and the default value is NULL. When this parameter is NULL no base URL will be used.

htmlViewerWidth int

The virtual browser width in pixels. The default value is 1024 pixels. The effect of this parameter is similar with viewing the HTML page in a browser window with the specified width.

htmlViewerHeight int

The virtual browser height in pixels. The default value is 0 which means the height will be auto-determined. The effect of this parameter is similar with viewing the HTML page in a browser window with the specified width and height. When this parameter is less or equal to 0, the converter will try to auto-determine the HTML page height from the HTML document content.

HtmlToPdfVariableElement(float, float, float, float, string, string, string)

Creates a HTML string to PDF converter element at the specified x and y coordinates with the specified width and height using a base URL to resolve the external resources and a document URL to resolve the internal links.

public HtmlToPdfVariableElement(float x, float y, float width, float height, string htmlStringToConvert, string htmlStringBaseURL, string internalLinksBaseUrl)

Parameters

x float

The x position in points where the rendered content will be placed

y float

The y position in points where the rendered content will be placed

width float

The destination width in points for the rendered content. If the specified with is less or equal 0, the destination width will be given by the available width in page

height float

The destination height in points for the rendered content. If the specified height is less or equal 0, the destination height will be auto determined so all the content can be rendered. Please note that the specified height is the effective height that will be rendered in the PDF document and does not include for example the empty spaces introduced by custom or automatic page breaks.

htmlStringToConvert string

The HTML string convert to PDF.

htmlStringBaseURL string

The full URL of the page from where this string was taken used to resolve the images and CSS files referenced by a relative URL in the HTML string. This parameter is optional and the default value is NULL. When this parameter is NULL no base URL will be used.

internalLinksBaseUrl string

The full URL of the document referenced by the internal links from the HTML string.

HtmlToPdfVariableElement(float, float, float, float, string, string, string, int, int)

Creates a HTML string to PDF converter element at the specified x and y coordinates with the specified width and height using a base URL to resolve the external resources and a document URL to resolve the internal links. The virtual browser width and height in pixels is specified by the htmlViewerWidth and htmlViewerHeight parameters.

public HtmlToPdfVariableElement(float x, float y, float width, float height, string htmlStringToConvert, string htmlStringBaseURL, string internalLinksBaseUrl, int htmlViewerWidth, int htmlViewerHeight)

Parameters

x float

The x position in points where the rendered content will be placed

y float

The y position in points where the rendered content will be placed

width float

The destination width in points for the rendered content. If the specified with is less or equal 0, the destination width will be given by the available width in page

height float

The destination height in points for the rendered content. If the specified height is less or equal 0, the destination height will be auto determined so all the content can be rendered. Please note that the specified height is the effective height that will be rendered in the PDF document and does not include for example the empty spaces introduced by custom or automatic page breaks.

htmlStringToConvert string

The HTML string convert to PDF.

htmlStringBaseURL string

The full URL of the page from where this string was taken used to resolve the images and CSS files referenced by a relative URL in the HTML string. This parameter is optional and the default value is NULL. When this parameter is NULL no base URL will be used.

internalLinksBaseUrl string

The full URL of the document referenced by the internal links from the HTML string.

htmlViewerWidth int

The virtual browser width in pixels. The default value is 1024 pixels. The effect of this parameter is similar with viewing the HTML page in a browser window with the specified width.

htmlViewerHeight int

The virtual browser height in pixels. The default value is 0 which means the height will be auto-determined. The effect of this parameter is similar with viewing the HTML page in a browser window with the specified width and height. When this parameter is less or equal to 0, the converter will try to auto-determine the HTML page height from the HTML document content.

HtmlToPdfVariableElement(float, float, float, string, string)

Creates a HTML string to PDF converter element at the specified x and y coordinates with the specified width using a base URL to resolve the external resources. The height in PDF is auto determined.

public HtmlToPdfVariableElement(float x, float y, float width, string htmlStringToConvert, string htmlStringBaseURL)

Parameters

x float

The x position in points where the rendered content will be placed

y float

The y position in points where the rendered content will be placed

width float

The destination width in points for the rendered content. If the specified with is less or equal 0, the destination width will be given by the available width in page

htmlStringToConvert string

The HTML string convert to PDF.

htmlStringBaseURL string

The full URL of the page from where this string was taken used to resolve the images and CSS files referenced by a relative URL in the HTML string. This parameter is optional and the default value is NULL. When this parameter is NULL no base URL will be used.

HtmlToPdfVariableElement(float, float, float, string, string, int)

Creates a HTML string to PDF converter element at the specified x and y coordinates with the specified width using a base URL to resolve the external resources. The height in PDF is auto determined. The virtual browser width in pixels is specified by the htmlViewerWidth parameter.

public HtmlToPdfVariableElement(float x, float y, float width, string htmlStringToConvert, string htmlStringBaseURL, int htmlViewerWidth)

Parameters

x float

The x position in points where the rendered content will be placed

y float

The y position in points where the rendered content will be placed

width float

The destination width in points for the rendered content. If the specified with is less or equal 0, the destination width will be given by the available width in page

htmlStringToConvert string

The HTML string convert to PDF.

htmlStringBaseURL string

The full URL of the page from where this string was taken used to resolve the images and CSS files referenced by a relative URL in the HTML string. This parameter is optional and the default value is NULL. When this parameter is NULL no base URL will be used.

htmlViewerWidth int

The virtual browser width in pixels. The default value is 1024 pixels. The effect of this parameter is similar with viewing the HTML page in a browser window with the specified width.

HtmlToPdfVariableElement(float, float, float, string, string, string)

Creates a HTML string to PDF converter element at the specified x and y coordinates with the specified width using a base URL to resolve the external resources and a document URL to resolve the internal links. The height in PDF is auto determined.

public HtmlToPdfVariableElement(float x, float y, float width, string htmlStringToConvert, string htmlStringBaseURL, string internalLinksBaseUrl)

Parameters

x float

The x position in points where the rendered content will be placed

y float

The y position in points where the rendered content will be placed

width float

The destination width in points for the rendered content. If the specified with is less or equal 0, the destination width will be given by the available width in page

htmlStringToConvert string

The HTML string convert to PDF.

htmlStringBaseURL string

The full URL of the page from where this string was taken used to resolve the images and CSS files referenced by a relative URL in the HTML string. This parameter is optional and the default value is NULL. When this parameter is NULL no base URL will be used.

internalLinksBaseUrl string

The full URL of the document referenced by the internal links from the HTML string.

HtmlToPdfVariableElement(float, float, float, string, string, string, int)

Creates a HTML string to PDF converter element at the specified x and y coordinates with the specified width using a base URL to resolve the external resources and a document URL to resolve the internal links. The height in PDF is auto determined. The virtual browser width in pixels is specified by the htmlViewerWidth parameter.

public HtmlToPdfVariableElement(float x, float y, float width, string htmlStringToConvert, string htmlStringBaseURL, string internalLinksBaseUrl, int htmlViewerWidth)

Parameters

x float

The x position in points where the rendered content will be placed

y float

The y position in points where the rendered content will be placed

width float

The destination width in points for the rendered content. If the specified with is less or equal 0, the destination width will be given by the available width in page

htmlStringToConvert string

The HTML string convert to PDF.

htmlStringBaseURL string

The full URL of the page from where this string was taken used to resolve the images and CSS files referenced by a relative URL in the HTML string. This parameter is optional and the default value is NULL. When this parameter is NULL no base URL will be used.

internalLinksBaseUrl string

The full URL of the document referenced by the internal links from the HTML string.

htmlViewerWidth int

The virtual browser width in pixels. The default value is 1024 pixels. The effect of this parameter is similar with viewing the HTML page in a browser window with the specified width.

HtmlToPdfVariableElement(float, float, string, string)

Creates a HTML string to PDF converter element at the specified x and y coordinates in PDF page using a base URL to resolve the external resources. The width of element in PDF page is the available width in PDF page and the height is auto determined.

public HtmlToPdfVariableElement(float x, float y, string htmlStringToConvert, string htmlStringBaseURL)

Parameters

x float

The x position in points where the rendered content will be placed

y float

The y position in points where the rendered content will be placed the destination width will be given by the available width in page

htmlStringToConvert string

The HTML string convert to PDF.

htmlStringBaseURL string

The full URL of the page from where this string was taken used to resolve the images and CSS files referenced by a relative URL in the HTML string. This parameter is optional and the default value is NULL. When this parameter is NULL no base URL will be used.

HtmlToPdfVariableElement(float, float, string, string, string)

Creates a HTML string to PDF converter element at the specified x and y coordinates in PDF page using a base URL to resolve the external resources and a document URL to resolve the internal links. The width of element in PDF page is the available width in PDF page and the height is auto determined.

public HtmlToPdfVariableElement(float x, float y, string htmlStringToConvert, string htmlStringBaseURL, string internalLinksBaseUrl)

Parameters

x float

The x position in points where the rendered content will be placed

y float

The y position in points where the rendered content will be placed the destination width will be given by the available width in page

htmlStringToConvert string

The HTML string convert to PDF.

htmlStringBaseURL string

The full URL of the page from where this string was taken used to resolve the images and CSS files referenced by a relative URL in the HTML string. This parameter is optional and the default value is NULL. When this parameter is NULL no base URL will be used.

internalLinksBaseUrl string

The full URL of the document referenced by the internal links from the HTML string.

HtmlToPdfVariableElement(string, string)

Creates a HTML string to PDF converter element that will be rendered at the (0,0) location in PDF page using a base URL to resolve the external resources. The width of element in PDF page is the available width in PDF page and the height is auto determined.

public HtmlToPdfVariableElement(string htmlStringToConvert, string htmlStringBaseURL)

Parameters

htmlStringToConvert string

The HTML string convert to PDF.

htmlStringBaseURL string

The full URL of the page from where this string was taken used to resolve the images and CSS files referenced by a relative URL in the HTML string. This parameter is optional and the default value is NULL. When this parameter is NULL no base URL will be used.

HtmlToPdfVariableElement(string, string, string)

Creates a HTML string to PDF converter element that will be rendered at the (0,0) location in PDF page using a base URL to resolve the external resources and a document URL to resolve the internal links. The width of element in PDF page is the available width in PDF page and the height is auto determined.

public HtmlToPdfVariableElement(string htmlStringToConvert, string htmlStringBaseURL, string internalLinksBaseUrl)

Parameters

htmlStringToConvert string

The HTML string convert to PDF.

htmlStringBaseURL string

The full URL of the page from where this string was taken used to resolve the images and CSS files referenced by a relative URL in the HTML string. This parameter is optional and the default value is NULL. When this parameter is NULL no base URL will be used.

internalLinksBaseUrl string

The full URL of the document referenced by the internal links from the HTML string.

Properties

Html

Gets or sets the variable HTML string to be converted to PDF

public override string Html { get; set; }

Property Value

string

Events

BeforeRenderInPageEvent

This event is raised right before the variable HTML is rendered in a PDF page

public event BeforeRenderInPageDelegate BeforeRenderInPageEvent

Event Type

BeforeRenderInPageDelegate