HtmlLoadOptions

HtmlLoadOptions class

Represents options for loading/importing html file into pdf document.

public sealed class HtmlLoadOptions : LoadOptions

Constructors

Name	Description
HtmlLoadOptions()	Creates load options for converting html into pdf document with empty base path.
HtmlLoadOptions(string)	Creates load options for converting html into pdf document with defined base path.

Properties

Name	Description
BasePath { get; }	The base path/url for the html file.
HtmlMediaType { get; set; }	Gets or sets possible media types used during rendering.
InputEncoding { get; set; }	Gets or sets the attribute specifying the encoding used for this document at the time of the parsing. If this attribute is null the encoding will determine from document character set atribute.
IsEmbedFonts { get; set; }	Gets or sets fonts embedding to result document
IsRenderToSinglePage { get; set; }	Gets or sets rendering all document to single page
LoadFormat { get; }	Represents file format which `LoadOptions` describes.
PageInfo { get; set; }	Gets or sets document page info
PageLayoutOption { get; set; }	Gets or sets layout option.
WarningHandler { get; set; }	Callback to handle any warnings generated. The WarningHandler returns ReturnAction enum item specifying either Continue or Abort. Continue is the default action and the Load operation continues, however the user may also return Abort in which case the Load operation should cease.

Fields

Name	Description
CustomLoaderOfExternalResources	Sometimes it’s necessary to avoid usage of internal loader of external resources(like images or CSSes) and supply custom method that will get requested resources from somewhere. For example, during usage of Aspose.PDF in cloude direct access to referenced files impossible: in such case some custome code put into special method should be used, and delegate that refers that method should be assygned to this attribute.
ExternalResourcesCredentials	If loading of external data referenced in HTML requirs credentials, You can put them into this parameter - they will be used during loading of external resources

Name

Description

CustomLoaderOfExternalResources

Sometimes it’s necessary to avoid usage of internal loader of external resources(like images or CSSes) and supply custom method that will get requested resources from somewhere. For example, during usage of Aspose.PDF in cloude direct access to referenced files impossible: in such case some custome code put into special method should be used, and delegate that refers that method should be assygned to this attribute.

ExternalResourcesCredentials

If loading of external data referenced in HTML requirs credentials, You can put them into this parameter - they will be used during loading of external resources

Examples

The following example shows how to convert HTML file to PDF file

[C#]
	// The path to the documents directory.
	string dataDir = @"YOUR_DATA_DIRECTORY";

	// The path to your HTML File.
	string htmlFile = Path.Combine(dataDir, "HTML-to-PDF.html");

	// The path to output PDF File.
	string pdfFile = Path.Combine(dataDir, "HTML-to-PDF.pdf");

	// Initialize HtmlLoadOptions	
	HtmlLoadOptions htmlLoadOptions = new HtmlLoadOptions();
		
	using (Document pdfDocument = new Document(htmlFile, htmlLoadOptions))
	{ 
		// Save PDF file
		pdfDocument.Save(pdfFile);
	}

[VB.NET]

    ' The path to the documents directory.
    Dim dataDir As String = "YOUR_DATA_DIRECTORY"

    ' The path to your HTML File.
    Dim htmlFile = Path.Combine(dataDir, "HTML-to-PDF.html")

    ' The path to output PDF File.
    Dim pdfFile = Path.Combine(dataDir, "HTML-to-PDF.pdf")
 
    ' Initialize HtmlLoadOptions    
    Dim htmlLoadOptions As HtmlLoadOptions = New HtmlLoadOptions()
 
    Using pdfDocument As Document = New Document(htmlFile, htmlLoadOptions)
 
        ' Save PDF file
        pdfDocument.Save(pdfFile)
    End Using

HtmlLoadOptions