Converter.ConvertTemplate

ConvertTemplate(HTMLDocument, TemplateData, TemplateLoadOptions, string)

Merge template source presented by HTMLDocument with template data (XML, JSON). Result is html file formed by output file path.

public static void ConvertTemplate(HTMLDocument template, TemplateData data, 
    TemplateLoadOptions options, string outputPath)

Parameter	Type	Description
template	HTMLDocument	Merging source skeleton presented by `HTMLDocument`.
data	TemplateData	Template data for merging - substitution (XML, JSON).
options	TemplateLoadOptions	`TemplateLoadOptions` object instance. It used to determine whether the template and data item names match, regardless of case or not (options).
outputPath	String	Full html file path as output conversion result.

Remarks

Template Merger

The idea of template merging is to create an HTML document based on a html template and populate it from a data source. Aspose.HTML provides the inline expressions syntax to work with templates and various data source types, such as XML and JSON. Refer to article where you can find more info about template merging and using ConvertTemplate() method.

Conversion (Merging) steps

Converter class offers few ways to merge html source with template data wherein you should follow one of simple scenarios consists of few steps:

Template source. Define HTML template source by file, URL, HTMLDocument object instance or even by inline content.Conversion result. You can obtain directly resulting HTMLDocument or define result output file path depend of method signature.Create instance of TemplateLoadOptions.Use the ConvertTemplate() method of the Converter class to merge template with data. You can add also configuration as option parameter.Source code

You can download the complete examples and data files from GitHub.

Examples

using System.IO;
using Aspose.Html.IO;
using Aspose.Html.Saving;  
using Aspose.Html.Converters;  
...
      // Form skeleton html source file path
      var sourcePath = Path.Combine(InputFolder, "source.html");

      // Form xml (json) template data file path
      var templateDataPath = Path.Combine(TemplateFolder, "templateData.xml");
      
      // Define TemplateData object instance
      var templateData = new TemplateData(templateDataPath);

      // Form result file path
      var resultPath = Path.Combine(OutputFolder, "result.html");

      // Define default TemplateLoadOptions object
      var options = new TemplateLoadOptions();

      // Form HTML document as conversion source
      var document = new HTMLDocument(sourcePath, new Configuration());

      // Initiate conversion process
      Converter.ConvertTemplate(document, templateData, options, resultPath);

      // Clear resources
      document.Dispose();





*InputFolder - user source template folder.

*TemplateFolder - user template data folder.

*OutputFolder - user output file path.

ConvertTemplate(Url, TemplateData, TemplateLoadOptions, string)

Merge template HTML source presented by URL with template data (XML, JSON). Result is html file formed by output file path.

public static void ConvertTemplate(Url url, TemplateData data, TemplateLoadOptions options, 
    string outputPath)

Parameter	Type	Description
url	Url	Merging HTML source skeleton presented by `URL`.
data	TemplateData	Template data for merging - substitution (XML, JSON).
options	TemplateLoadOptions	`TemplateLoadOptions` object instance. It used to determine whether the template and data item names match, regardless of case or not (options).
outputPath	String	Full html file path as output conversion result.

Remarks

Template Merger

Conversion (Merging) steps

Converter class offers few ways to merge html source with template data wherein you should follow one of simple scenarios consists of few steps:

You can download the complete examples and data files from GitHub.

Examples

using System.IO;
using Aspose.Html.IO;
using Aspose.Html.Saving;  
using Aspose.Html.Converters;  
...
      // Form skeleton html source Url
      var sourceUrl = new Url(Path.Combine(InputFolder, "source.html"));

      // Form xml (json) template data file path
      var templateDataPath = Path.Combine(TemplateFolder, "templateData.xml");

      // Define TemplateData object instance
      var templateData = new TemplateData(templateDataPath);

      // Form result file path
      var resultPath = Path.Combine(OutputFolder, "result.html");

      // Define default TemplateLoadOptions object
      var options = new TemplateLoadOptions();

      // Initiate conversion process
      Converter.ConvertTemplate(sourceUrl, templateData, options, resultPath);





*InputFolder - user source template folder.

*TemplateFolder - user template data folder.

*OutputFolder - user output file path.

ConvertTemplate(Url, Configuration, TemplateData, TemplateLoadOptions, string)

Merge template HTML source presented by URL with template data (XML, JSON). Result is html file formed by output file path.

public static void ConvertTemplate(Url url, Configuration configuration, TemplateData data, 
    TemplateLoadOptions options, string outputPath)

Parameter	Type	Description
url	Url	Merging HTML source skeleton presented by `URL`.
configuration	Configuration	The environment configuration. Represents the `configuration` context object that is used to set up the environment settings for the application.
data	TemplateData	Template data for merging - substitution (XML, JSON).
options	TemplateLoadOptions	`TemplateLoadOptions` object instance. It used to determine whether the template and data item names match, regardless of case or not (options).
outputPath	String	Full html file path as output conversion result.

Remarks

Template Merger

Conversion (Merging) steps

Converter class offers few ways to merge html source with template data wherein you should follow one of simple scenarios consists of few steps:

You can download the complete examples and data files from GitHub.

Examples

using System.IO;
using Aspose.Html.IO;
using Aspose.Html.Saving;  
using Aspose.Html.Converters;  
...
      // Form skeleton html source Url
      var sourceUrl = new Url(Path.Combine(InputFolder, "source.html"));

      // Form xml (json) template data file path
      var templateDataPath = Path.Combine(TemplateFolder, "templateData.xml");

      // Define TemplateData object instance 
      var templateData = new TemplateData(templateDataPath);

      // Form result file path
      var resultPath = Path.Combine(OutputFolder, "result.html");

      // Define default TemplateLoadOptions object
      var options = new TemplateLoadOptions();

      // Initiate conversion process with default configuration
      Converter.ConvertTemplate(sourceUrl, new Configuration(), templateData, options, resultPath);

*InputFolder - user source template folder.

*TemplateFolder - user template data folder.

*OutputFolder - user output file path.

ConvertTemplate(string, TemplateData, TemplateLoadOptions, string)

Merge template HTML source presented by full file path with template data (XML, JSON). Result is html file formed by output file path.

public static void ConvertTemplate(string sourcePath, TemplateData data, 
    TemplateLoadOptions options, string outputPath)

Parameter	Type	Description
sourcePath	String	Merging HTML source skeleton presented by full file path.
data	TemplateData	Template data for merging - substitution (XML, JSON).
options	TemplateLoadOptions	`TemplateLoadOptions` object instance. It used to determine whether the template and data item names match, regardless of case or not (options).
outputPath	String	Full html file path as output conversion result.

Remarks

Template Merger

Conversion (Merging) steps

Converter class offers few ways to merge html source with template data wherein you should follow one of simple scenarios consists of few steps:

You can download the complete examples and data files from GitHub.

Examples

using System.IO;
using Aspose.Html.IO;
using Aspose.Html.Saving;  
using Aspose.Html.Converters;  
...
      // Form skeleton html source file path
      var sourcePath = Path.Combine(InputFolder, "source.html");

      // Form xml (json) template data file path
      var templateDataPath = Path.Combine(TemplateFolder, "templateData.xml");

      // Define TemplateData object instance
      var templateData = new TemplateData(templateDataPath);

      // Form result file path
      var resultPath = Path.Combine(OutputFolder, "result.html");

      // Define default TemplateLoadOptions object
      var options = new TemplateLoadOptions();

      // Initiate conversion process
      Converter.ConvertTemplate(sourcePath, templateData, options, resultPath);

*InputFolder - user source template folder.

*TemplateFolder - user template data folder.

*OutputFolder - user output file path.

ConvertTemplate(string, Configuration, TemplateData, TemplateLoadOptions, string)

Merge template HTML source presented by full file path with template data (XML, JSON). Result is html file formed by output file path.

public static void ConvertTemplate(string sourcePath, Configuration configuration, 
    TemplateData data, TemplateLoadOptions options, string outputPath)

Parameter	Type	Description
sourcePath	String	Merging HTML source skeleton presented by full file path.
configuration	Configuration	The environment configuration. Represents the `configuration` context object that is used to set up the environment settings for the application.
data	TemplateData	Template data for merging - substitution (XML, JSON).
options	TemplateLoadOptions	`TemplateLoadOptions` object instance. It used to determine whether the template and data item names match, regardless of case or not (options).
outputPath	String	Full html file path as output conversion result.

Remarks

Template Merger

Conversion (Merging) steps

Converter class offers few ways to merge html source with template data wherein you should follow one of simple scenarios consists of few steps:

You can download the complete examples and data files from GitHub.

Examples

using System.IO;
using Aspose.Html.IO;
using Aspose.Html.Saving;  
using Aspose.Html.Converters;  
...
      // Form skeleton html source file path
      var sourcePath = Path.Combine(InputFolder, "source.html");

      // Form xml (json) template data file path
      var templateDataPath = Path.Combine(TemplateFolder, "templateData.xml");

      // Define TemplateData object instance
      var templateData = new TemplateData(templateDataPath);

      // Form result file path
      var resultPath = Path.Combine(OutputFolder, "result.html");

      // Define default TemplateLoadOptions object
      var options = new TemplateLoadOptions();

      // Initiate conversion process with default configuration
      Converter.ConvertTemplate(sourcePath, new Configuration(), templateData, options, resultPath);

*InputFolder - user source template folder.

*TemplateFolder - user template data folder.

*OutputFolder - user output file path.

ConvertTemplate(string, string, TemplateData, TemplateLoadOptions, string)

Merge template HTML source presented by inline content with template data (XML, JSON). Result is html file formed by output file path.

public static void ConvertTemplate(string content, string baseUrl, TemplateData data, 
    TemplateLoadOptions options, string outputPath)

Parameter	Type	Description
content	String	Merging HTML source skeleton presented by inline string content.
baseUrl	String	Base URI of the html template. It will be combined with the current directory path to form an absolute URL.
data	TemplateData	Template data for merging - substitution (XML, JSON).
options	TemplateLoadOptions	`TemplateLoadOptions` object instance. It used to determine whether the template and data item names match, regardless of case or not (options).
outputPath	String	Full html file path as output conversion result.

Remarks

Template Merger

Conversion (Merging) steps

Converter class offers few ways to merge html source with template data wherein you should follow one of simple scenarios consists of few steps:

You can download the complete examples and data files from GitHub.

Examples

using System.IO;
using Aspose.Html.IO;
using Aspose.Html.Saving;  
using Aspose.Html.Converters;  
...
	  // Form inline source content as template
      string templateContent =
        "<html>" + 
        "<body>" +
        "<div data_merge=\"{{#foreach Person}}\">" +
        "<p>{{Title}}</p>" +
        "<p>Name: {{Name}} Surname: {{Surname}}</p>" +
        "<p>Address:</p>" +
        "<p>{{Address.Number}}, {{Address.Street}} {{Address.City}}</p>" +
        "</div>" +
        "</body></html>";
       
      // Form xml (json) template data file path
      var templateDataPath = Path.Combine(TemplateFolder, "templateData.xml");

      // Define TemplateData object instance
      var templateData = new TemplateData(templateDataPath);

      // Form output as merging result 
      var resultFilePath = Path.Combine(OutputFolder, "result.html");

      // Define default TemplateLoadOptions object
      var options = new TemplateLoadOptions();
	  
      // Initiate conversion process
      Converter.ConvertTemplate(templateContent, string.Empty, templateData, options, resultFilePath);

*TemplateFolder - user template data folder.
*OutputFolder - user output file path.

Below is sample data file to merge with source

<?xml version="1.0" encoding="utf-8" ?>
<Data>
	<Person>
	<Title>Title 1</Title>
	<Name>John</Name>
	<Surname>Smith</Surname>
	<Address>
		<Number>200</Number>
		<Street>Austin rd.</Street>
		<City>Dallas</City>
	</Address>
	</Person>
	<Person>
	<Title>Title 2</Title>
	<Name>Mike</Name>
	<Surname>Milbert</Surname>
	<Address>
		<Number>126</Number>
		<Street>First Avenue</Street>
		<City>Chicago</City>
	</Address>
	</Person>
</Data>

ConvertTemplate(string, string, Configuration, TemplateData, TemplateLoadOptions, string)

Merge template HTML source presented by inline content with template data (XML, JSON). Result is html file formed by output file path.

public static void ConvertTemplate(string content, string baseUrl, Configuration configuration, 
    TemplateData data, TemplateLoadOptions options, string outputPath)

Parameter	Type	Description
content	String	Merging HTML source skeleton presented by inline string content.
baseUrl	String	Base URI of the html template. It will be combined with the current directory path to form an absolute URL.
configuration	Configuration	The environment configuration. Represents the `configuration` context object that is used to set up the environment settings for the application.
data	TemplateData	Template data for merging - substitution (XML, JSON).
options	TemplateLoadOptions	`TemplateLoadOptions` object instance. It used to determine whether the template and data item names match, regardless of case or not (options).
outputPath	String	Full html file path as output conversion result.

Remarks

Template Merger

Conversion (Merging) steps

Converter class offers few ways to merge html source with template data wherein you should follow one of simple scenarios consists of few steps:

You can download the complete examples and data files from GitHub.

Examples

using System.IO;
using Aspose.Html.IO;
using Aspose.Html.Saving;  
using Aspose.Html.Converters;  
...
   // Form inline source content as template
   string templateContent =
    "<html>" + 
    "<body>" +
    "<div data_merge=\"{{#foreach Person}}\">" +
    "<p>{{Title}}</p>" +
    "<p>Name: {{Name}} Surname: {{Surname}}</p>" +
    "<p>Address:</p>" +
    "<p>{{Address.Number}}, {{Address.Street}} {{Address.City}}</p>" +
    "</div>" +
    "</body></html>";
    
   // Form xml (json) template data file path
   var templateDataPath = Path.Combine(TemplateFolder, "templateData.xml");

   // Define TemplateData object instance
   var templateData = new TemplateData(templateDataPath);

   // Form output as merging result 
   var resultFilePath = Path.Combine(OutputFolder, "result.html");

   // Define configuration object instance
   var configuration = new Configuration();

   // Define default TemplateLoadOptions object
   var options = new TemplateLoadOptions();

   // Initiate conversion process with default configuration
   Converter.ConvertTemplate(templateContent, string.Empty,
        configuration, templateData, options, resultFilePath);

*TemplateFolder - user template data folder.

*OutputFolder - user output file path.

Below is data file to merge with source as template

<?xml version="1.0" encoding="utf-8" ?>
<Data>
	<Person>
	<Title>Title 1</Title>
	<Name>John</Name>
	<Surname>Smith</Surname>
	<Address>
		<Number>200</Number>
		<Street>Austin rd.</Street>
		<City>Dallas</City>
	</Address>
	</Person>
	<Person>
	<Title>Title 2</Title>
	<Name>Mike</Name>
	<Surname>Milbert</Surname>
	<Address>
		<Number>126</Number>
		<Street>First Avenue</Street>
		<City>Chicago</City>
	</Address>
	</Person>
</Data>

ConvertTemplate(HTMLDocument, TemplateData, TemplateLoadOptions)

Merge template source presented by HTMLDocument with template data (XML, JSON). Result is new formed HTMLDocument which can be saved as file.

public static HTMLDocument ConvertTemplate(HTMLDocument template, TemplateData data, 
    TemplateLoadOptions options)

Parameter	Type	Description
template	HTMLDocument	Merging source skeleton presented by `HTMLDocument`.
data	TemplateData	Template data for merging - substitution (XML, JSON).
options	TemplateLoadOptions	`TemplateLoadOptions` object instance. It used to determine whether the template and data item names match, regardless of case or not (options).

Return Value

New formed HTMLDocument as conversion result which can be saved through output file path.

Remarks

Template Merger

Conversion (Merging) steps

Converter class offers few ways to merge html source with template data wherein you should follow one of simple scenarios consists of few steps:

You can download the complete examples and data files from GitHub.

Examples

using System.IO;
using Aspose.Html.IO;
using Aspose.Html.Saving;  
using Aspose.Html.Converters;  
...
      // Form skeleton html source file path
      var sourcePath = Path.Combine(InputFolder, "source.html");

      // Form xml (json) template data file path
      var templateDataPath = Path.Combine(TemplateFolder, "templateData.xml");

      // Define TemplateData object instance
      var templateData = new TemplateData(templateDataPath);

      // Form result file path
      var resultPath = Path.Combine(OutputFolder, "result.html");

      // Define default TemplateLoadOptions object
      var options = new TemplateLoadOptions();
      
      // Form HTML document as conversion source
      using (var template = new HTMLDocument(sourcePath, new Configuration()))
      {
        // Initiate conversion process
        var document = Converter.ConvertTemplate(template, templateData, options);
         
        // Save result with linked resources
        document.Save(new Url(resultPath));
      }





*InputFolder - user source template folder.

*TemplateFolder - user template data folder.

*OutputFolder - user output file path.

ConvertTemplate(Url, TemplateData, TemplateLoadOptions)

Merge template HTML source presented by URL with template data (XML, JSON). Result is new formed HTMLDocument which can be saved as file.

public static HTMLDocument ConvertTemplate(Url url, TemplateData data, TemplateLoadOptions options)

Parameter	Type	Description
url	Url	Merging HTML source skeleton presented by `URL`.
data	TemplateData	Template data for merging - substitution (XML, JSON).
options	TemplateLoadOptions	`TemplateLoadOptions` object instance. It used to determine whether the template and data item names match, regardless of case or not (options).

Return Value

New formed HTMLDocument as conversion result which can be saved through output file path.

Remarks

Template Merger

Conversion (Merging) steps

Converter class offers few ways to merge html source with template data wherein you should follow one of simple scenarios consists of few steps:

You can download the complete examples and data files from GitHub.

Examples

using System.IO;
using Aspose.Html.IO;
using Aspose.Html.Saving;  
using Aspose.Html.Converters;  
...
      // Form Url to skeleton html source file
      var sourceUrl = new Url(Path.Combine(InputFolder, "source.html"));

      // Form xml (json) template data file path
      var templateDataPath = Path.Combine(TemplateFolder, "templateData.xml");

      // Define TemplateData object instance
      var templateData = new TemplateData(templateDataPath);

      // Form result file path
      var resultPath = Path.Combine(OutputFolder, "result.html");

      // Define default TemplateLoadOptions object
      var options = new TemplateLoadOptions();

      // Initiate conversion process
      using (var document = Converter.ConvertTemplate(sourceUrl, templateData, options))
      {
        // Save result with linked resources
        document.Save(new Url(resultPath));
      }

*InputFolder - user source template folder.

*TemplateFolder - user template data folder.

*OutputFolder - user output file path.

ConvertTemplate(Url, Configuration, TemplateData, TemplateLoadOptions)

Merge template HTML source presented by URL with template data (XML, JSON). Result is new formed HTMLDocument which can be saved as file.

public static HTMLDocument ConvertTemplate(Url url, Configuration configuration, TemplateData data, 
    TemplateLoadOptions options)

Parameter	Type	Description
url	Url	Merging HTML source skeleton presented by `URL`.
configuration	Configuration	The environment configuration. Represents the `configuration` context object that is used to set up the environment settings for the application.
data	TemplateData	Template data for merging - substitution (XML, JSON).
options	TemplateLoadOptions	`TemplateLoadOptions` object instance. It used to determine whether the template and data item names match, regardless of case or not (options).

Return Value

New formed HTMLDocument as conversion result which can be saved through output file path.

Remarks

Template Merger

Conversion (Merging) steps

Converter class offers few ways to merge html source with template data wherein you should follow one of simple scenarios consists of few steps:

You can download the complete examples and data files from GitHub.

Examples

using System.IO;
using Aspose.Html.IO;
using Aspose.Html.Saving;  
using Aspose.Html.Converters;  
...
      // Form Url to skeleton html source file
      var sourceUrl = new Url(Path.Combine(InputFolder, "source.html"));

      // Form xml (json) template data file path
      var templateDataPath = Path.Combine(TemplateFolder, "templateData.xml");

      // Define TemplateData object instance
      var templateData = new TemplateData(templateDataPath);

      // Form result file path
      var resultPath = Path.Combine(OutputFolder, "result.html");

      // Define default TemplateLoadOptions object
      var options = new TemplateLoadOptions();

      // Initiate conversion process with default configuration
      using (var document = Converter.ConvertTemplate(sourceUrl, new Configuration(), templateData, options))
      {
        // Save result with linked resources
        document.Save(new Url(resultPath));
      }

*InputFolder - user source template folder.

*TemplateFolder - user template data folder.

*OutputFolder - user output file path.

ConvertTemplate(string, TemplateData, TemplateLoadOptions)

Merge template HTML source presented by full file path with template data (XML, JSON). Result is new formed HTMLDocument which can be saved as file.

public static HTMLDocument ConvertTemplate(string sourcePath, TemplateData data, 
    TemplateLoadOptions options)

Parameter	Type	Description
sourcePath	String	Merging HTML source skeleton presented by full file path.
data	TemplateData	Template data for merging - substitution (XML, JSON).
options	TemplateLoadOptions	`TemplateLoadOptions` object instance. It used to determine whether the template and data item names match, regardless of case or not (options).

Return Value

New formed HTMLDocument as conversion result which can be saved through output file path.

Remarks

Template Merger

Conversion (Merging) steps

Converter class offers few ways to merge html source with template data wherein you should follow one of simple scenarios consists of few steps:

You can download the complete examples and data files from GitHub.

Examples

using System.IO;
using Aspose.Html.IO;
using Aspose.Html.Saving;  
using Aspose.Html.Converters;  
...
      // Form skeleton html source file path
      var sourcePath = Path.Combine(InputFolder, "source.html");

      // Form xml (json) template data file path
      var templateDataPath = Path.Combine(TemplateFolder, "templateData.xml");

      // Define TemplateData object instance
      var templateData = new TemplateData(templateDataPath);

      // Form result file path
      var resultPath = Path.Combine(OutputFolder, "result.html");

      // Define default TemplateLoadOptions object
      var options = new TemplateLoadOptions();

      // Initiate conversion process
      using (var document = Converter.ConvertTemplate(sourcePath, templateData, options))
      {
        // Save result with linked resources
        document.Save(new Url(resultPath));
      }

*InputFolder - user source template folder.

*TemplateFolder - user template data folder.

*OutputFolder - user output file path.

ConvertTemplate(string, Configuration, TemplateData, TemplateLoadOptions)

Merge template HTML source presented by full file path with template data (XML, JSON). Result is new formed HTMLDocument which can be saved as file.

public static HTMLDocument ConvertTemplate(string sourcePath, Configuration configuration, 
    TemplateData data, TemplateLoadOptions options)

Parameter	Type	Description
sourcePath	String	Merging HTML source skeleton presented by full file path.
configuration	Configuration	The environment configuration. Represents the `configuration` context object that is used to set up the environment settings for the application.
data	TemplateData	Template data for merging - substitution (XML, JSON).
options	TemplateLoadOptions	`TemplateLoadOptions` object instance. It used to determine whether the template and data item names match, regardless of case or not (options).

Return Value

New formed HTMLDocument as conversion result which can be saved through output file path.

Remarks

Template Merger

Conversion (Merging) steps

Converter class offers few ways to merge html source with template data wherein you should follow one of simple scenarios consists of few steps:

You can download the complete examples and data files from GitHub.

Examples

using System.IO;
using Aspose.Html.IO;
using Aspose.Html.Saving;  
using Aspose.Html.Converters;  
...
      // Form skeleton html source file path
      var sourcePath = Path.Combine(InputFolder, "source.html");

      // Form xml (json) template data file path
      var templateDataPath = Path.Combine(TemplateFolder, "templateData.xml");

      // Define TemplateData object instance
      var templateData = new TemplateData(templateDataPath);

      // Form result file path
      var resultPath = Path.Combine(OutputFolder, "result.html");

      // Define default TemplateLoadOptions object
      var options = new TemplateLoadOptions();

      // Initiate conversion process with default configuration
      using (var document = Converter.ConvertTemplate(sourcePath, new Configuration(), templateData, options))
      {
        // Save result with linked resources
        document.Save(new Url(resultPath));
      }

*InputFolder - user source template folder.

*TemplateFolder - user template data folder.

*OutputFolder - user output file path.

ConvertTemplate(string, string, TemplateData, TemplateLoadOptions)

Merge template HTML source presented by inline content with template data (XML, JSON). Result is new formed HTMLDocument which can be saved as file.

public static HTMLDocument ConvertTemplate(string content, string baseUrl, TemplateData data, 
    TemplateLoadOptions options)

Parameter	Type	Description
content	String	Merging HTML source skeleton presented by inline string content.
baseUrl	String	Base URI of the html template. It will be combined with the current directory path to form an absolute URL.
data	TemplateData	Template data for merging - substitution (XML, JSON).
options	TemplateLoadOptions	`TemplateLoadOptions` object instance. It used to determine whether the template and data item names match, regardless of case or not (options).

Return Value

New formed HTMLDocument as conversion result which can be saved through output file path.

Remarks

Template Merger

Conversion (Merging) steps

Converter class offers few ways to merge html source with template data wherein you should follow one of simple scenarios consists of few steps:

You can download the complete examples and data files from GitHub.

Examples

using System.IO;
using Aspose.Html.IO;
using Aspose.Html.Saving;  
using Aspose.Html.Converters;  
...
      // Form inline source content as template
      string templateContent =
        "<html>" +
        "<body>" +
        "<div data_merge=\"{{#foreach Person}}\">" +
        "<p>{{Title}}</p>" +
        "<p>Name: {{Name}} Surname: {{Surname}}</p>" +
        "<p>Address:</p>" +
        "<p>{{Address.Number}}, {{Address.Street}} {{Address.City}}</p>" +
        "</div>" +
        "</body></html>";

      // Form xml (json) template data file path
      var templateDataPath = Path.Combine(TemplateFolder, "templateData.xml");

      // Define TemplateData object instance
      var templateData = new TemplateData(templateDataPath);

      // Form output as merging result 
      var resultFilePath = Path.Combine(OutputFolder, "result.html");

      // Define default TemplateLoadOptions object
      var options = new TemplateLoadOptions();

      // Initiate conversion process and save result
      using (var document = Converter.ConvertTemplate(
        templateContent, string.Empty,
        templateData,
        options))
      {
        document.Save(new Url(resultFilePath));
      }

*TemplateFolder - user template data folder.

*OutputFolder - user output file path.

ConvertTemplate(string, string, Configuration, TemplateData, TemplateLoadOptions)

Merge template HTML source presented by inline content with template data (XML, JSON). Result is new formed HTMLDocument which can be saved as file.

public static HTMLDocument ConvertTemplate(string content, string baseUrl, 
    Configuration configuration, TemplateData data, TemplateLoadOptions options)

Parameter	Type	Description
content	String	Merging HTML source skeleton presented by inline string content.
baseUrl	String	Base URI of the html template. It will be combined with the current directory path to form an absolute URL.
configuration	Configuration	The environment configuration. Represents the `configuration` context object that is used to set up the environment settings for the application.
data	TemplateData	Template data for merging - substitution (XML, JSON).
options	TemplateLoadOptions	`TemplateLoadOptions` object instance. It used to determine whether the template and data item names match, regardless of case or not (options).

Return Value

New formed HTMLDocument as conversion result which can be saved through output file path.

Remarks

Template Merger

Conversion (Merging) steps

Converter class offers few ways to merge html source with template data wherein you should follow one of simple scenarios consists of few steps:

You can download the complete examples and data files from GitHub.

Examples

using System.IO;
using Aspose.Html.IO;
using Aspose.Html.Saving;  
using Aspose.Html.Converters;  
...
      // Form inline source content as template
      string templateContent =
        "<html>" + 
        "<body>" +
        "<div data_merge=\"{{#foreach Person}}\">" +
        "<p>{{Title}}</p>" +
        "<p>Name: {{Name}} Surname: {{Surname}}</p>" +
        "<p>Address:</p>" +
        "<p>{{Address.Number}}, {{Address.Street}} {{Address.City}}</p>" +
        "</div>" +
        "</body></html>";
       
      // Form xml (json) template data file path
      var templateDataPath = Path.Combine(TemplateFolder, "templateData.xml");

      // Define TemplateData object instance
      var templateData = new TemplateData(templateDataPath);

      // Form output as merging result 
      var resultFilePath = Path.Combine(OutputFolder, "result.html");

      // Define configuration object instance
      var configuration = new Configuration();

      // Define default TemplateLoadOptions object
      var options = new TemplateLoadOptions();

      // Initiate conversion process and save result
      using (var document = Converter.ConvertTemplate(
        templateContent, string.Empty,
        configuration,
        templateData,
        options))
      {
        document.Save(new Url(resultFilePath));
      }

*TemplateFolder - user template data folder.

*OutputFolder - user output file path.

Converter.ConvertTemplate

ConvertTemplate(HTMLDocument, TemplateData, TemplateLoadOptions, string)

Remarks

Examples

See Also

ConvertTemplate(Url, TemplateData, TemplateLoadOptions, string)

Remarks

Examples

See Also

ConvertTemplate(Url, Configuration, TemplateData, TemplateLoadOptions, string)

Remarks

Examples

See Also

ConvertTemplate(string, TemplateData, TemplateLoadOptions, string)

Remarks

Examples

See Also

ConvertTemplate(string, Configuration, TemplateData, TemplateLoadOptions, string)

Remarks

Examples

See Also

ConvertTemplate(string, string, TemplateData, TemplateLoadOptions, string)

Remarks

Examples

See Also

ConvertTemplate(string, string, Configuration, TemplateData, TemplateLoadOptions, string)

Remarks

Examples

See Also

ConvertTemplate(HTMLDocument, TemplateData, TemplateLoadOptions)

Return Value

Remarks

Examples

See Also

ConvertTemplate(Url, TemplateData, TemplateLoadOptions)

Return Value

Remarks

Examples

See Also

ConvertTemplate(Url, Configuration, TemplateData, TemplateLoadOptions)

Return Value

Remarks

Examples

See Also

ConvertTemplate(string, TemplateData, TemplateLoadOptions)

Return Value

Remarks

Examples

See Also

ConvertTemplate(string, Configuration, TemplateData, TemplateLoadOptions)

Return Value

Remarks

Examples

See Also

ConvertTemplate(string, string, TemplateData, TemplateLoadOptions)

Return Value

Remarks

Examples

See Also

ConvertTemplate(string, string, Configuration, TemplateData, TemplateLoadOptions)

Return Value

Remarks

Examples

See Also