Load XML document with options Leave feedback
On this page
GroupDocs.Conversion provides XmlLoadOptions to give you control over how the source XML document will be processed. The following options could be set:
| Option | Description |
|---|---|
| BasePath | Specifies the base path/url for the HTML |
| Encoding | Specifies the encoding to be used to load the document. If not specified, the encoding will be determined from the document’s character set attribute |
| ExecuteScripts | Whether the document’s scripts run while it loads and converts. Default: false. Available since version 26.10. |
| ExternalResourceHandler | A handler called for each resource the document asks to load; it can allow the resource, skip it or supply its content. Default: null. Available since version 26.10. |
| Format | Input document file type |
| PageNumbering | Whether to generate page numbers for the converted document. Default: false |
| ResourceLoadingTimeout | Specifies the timeout of loading the external resources. |
| SkipExternalResources | Whether to skip the external resources the document references. Default: true. Content the document carries, local files inside its folder and resources that match WhitelistedResources still load. |
| UseAsDataSource | Use source XML document as a data source |
| WhitelistedResources | Absolute URI prefixes, such as https://cdn.example.com/assets/, of external resources to load while SkipExternalResources is true. Since version 26.10, an entry that is not an absolute URI prefix makes the load fail with InvalidLoadOptionsException. |
| XslFoFactory | XSL document stream to convert XML-FO using XSL. |
| XsltFactory | XSLT document stream to convert XML performing XSL transformation to HTML. |
The following code snippet shows how to use XML as a data source and convert it to a spreadsheet:
using (Converter converter = new Converter("data.xml", (LoadContext loadContext) => new XmlLoadOptions
{
UseAsDataSource = true
}))
{
SpreadsheetConvertOptions options = new SpreadsheetConvertOptions();
converter.Convert("converted.xlsx", options);
}
The following code shows how to convert a XML transformed through XSLT to a PDF:
using (var converter = new Converter("books.xml", (LoadContext loadContext) => new XmlLoadOptions
{
XsltFactory = () => File.OpenRead("books.xsl")
}))
{
var options = new PdfConvertOptions();
converter.Convert("converted.pdf", options);
}
External resources refer to data or content that is referenced or linked from within an XML document but is stored separately, typically in separate files or locations. Common external resources include DTDs or XML schemas, entities, XSLT Stylesheets, data sources, images, multimedia, and so on.
External resources are not loaded by default, and scripts do not run. Read the Skip loading of external resources article to learn how to allow trusted resources, decide per resource with a handler and run scripts with GroupDocs.Conversion for .NET.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
