Конвертировать шаблон в HTML – Template to HTML- примеры C#

Aspose.HTML for .NET предлагает набор методов ConvertTemplate(), которые используются для преобразования HTML-шаблона в HTML-документ. Методы принимают несколько параметров, таких как путь к файлу шаблона, источник данных и параметры загрузки, и возвращают HTML-документ. Шаблон HTML (HTML Template) – это фрагмент кода HTML, содержащий заполнители для динамических данных. Эти заполнители называются выражениями и заключаются в двойные фигурные скобки, например: {{выражение}}. Источник данных предоставляет фактические значения для этих выражений. Метод ConvertTemplate() заменяет выражения в шаблоне значениями из источника данных, создавая полный HTML-документ. Этот метод можно использовать с различными типами источников данных, такими как XML и JSON.

В этой статье описывается, как конвертировать шаблон в HTML на примерах C# с использованием библиотеки Aspose.HTML for .NET.

Преобразование шаблона в HTML одной строкой кода

После того, как вы подготовили HTML-шаблон, вы можете преобразовать шаблон в HTML документ в своем приложении C# буквально с помощью одной строки кода! Для этого необходимо передать необходимые параметры методу ConvertTemplate(sourcePath, data, options, outputPath).

// Convert template to HTML
Converter.ConvertTemplate(
    Path.Combine(DataDir, "template.html"),
    new TemplateData(Path.Combine(DataDir, "data-source.json")),
    new TemplateLoadOptions(),
    Path.Combine(OutputDir, "template-with-single-line.html")
);

Конвертировать Template в HTML документ

Давайте воспользуемся методом ConvertTemplate(HTMLDocument, TemplateData, TemplateLoadOptions, string) для преобразования шаблона HTML в настоящий документ HTML. Метод принимает четыре параметра:

1. В качестве источника шаблона используется объект HTMLDocument.
2. Объект TemplateData содержит данные, которые будут использоваться для заполнения шаблона.
3. Объект TemplateLoadOptions предоставляет опции для загрузки шаблона.
4. Строковый параметр используется для указания полного пути к файлу HTML в качестве результата преобразования.

Метод использует информацию из этих параметров для создания HTML-документа.

// Prepare a path to an HTML source file
var sourcePath = Path.Combine(DataDir, "template.html");

// Prepare a path to an xml template data file
var templateDataPath = Path.Combine(DataDir, "templateData.xml");

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

// Prepare a path to the result file
var resultPath = Path.Combine(OutputDir, "result.html");

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

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

// Convert template to HTML
Converter.ConvertTemplate(document, templateData, options, resultPath);

// Clear resources
document.Dispose();

Код создает экземпляр класса HTMLDocument и использует метод Converter.ConvertTemplate(), чтобы преобразовать файл шаблона (template.html) в документ HTML с использованием файла источника данных (templateData.xml). Метод принимает четыре параметра: объект HTMLDocument, объект TemplateData, созданный с использованием файла источника данных, объект TemplateLoadOptions и путь к файлу для результирующего HTML-документа. Результирующий HTML-документ сохраняется по указанному пути к файлу (result.html). После преобразования объект document удаляется.

Конвертировать Template в HTML документ на лету

Если ваш случай предполагает указание данных и создание шаблона на лету, вам необходимо выполнить несколько шагов:

1. Подготовьте шаблон HTML и сохраните его в файл. Метод ConvertTemplate() принимает путь к файлу шаблона в качестве параметра (sourcePath).
2. Подготовьте источник данных JSON и XML и сохраните его в файл. Конструктор TemplateData() берет путь к этому файлу данных и создает объект данных для метода ConvertTemplate().
3. Инициализируйте экземпляр класса TemplateLoadOptions, чтобы определить, совпадают ли имена шаблона и элемента данных, независимо от регистра или нет.
4. Вызовите метод ConvertTemplate() и передайте sourcePath, data, options и outputPath для него. OutputPath – путь для сохранения заполненного данными файла шаблона.

// Prepare a path to JSON data source file
string jsonPath = Path.Combine(OutputDir, "data-source.json");

// Prepare a JSON data source and save it to the file
var data = @"{
    ""FirstName"": ""John"",
    ""LastName"": ""Doe"",
    ""Address"": {
        ""City"": ""Dallas"",
        ""Street"": ""Austin rd."",
        ""Number"": ""200""
        }
    }";
File.WriteAllText(jsonPath, data);

// Prepare a path to an HTML Template file
string sourcePath = Path.Combine(OutputDir, "template.html");

// Prepare an HTML Template and save it to the file
var template = @"
    <table border=1>
        <tr>
            <th>Person</th>
            <th>Address</th>
        </tr>
        <tr>
            <td>{{FirstName}} {{LastName}}</td>
            <td>{{Address.Street}} {{Address.Number}}, {{Address.City}}</td>
        </tr>
    </table>
    ";
File.WriteAllText(sourcePath, template);

// Prepare a path to the output file (data-filled template file)
string outputPath = Path.Combine(OutputDir, "template-output.html");

// Invoke Converter.ConvertTemplate in order to populate 'template.html' with the data source from 'data-source.json' file
Converter.ConvertTemplate(sourcePath, new TemplateData(jsonPath), new TemplateLoadOptions(), outputPath);

Aspose.HTML предлагает бесплатные онлайн Конвертеры для преобразования HTML, XHTML, MHTML, EPUB, XML и Markdown файлы в различные популярные форматы. Вы можете легко конвертировать HTML в PDF, HTML в JPG, SVG to PDF, MHTML в PDF или MD в HTML. Просто выберите файл, выберите формат для преобразования, и все готово. Это быстро и совершенно бесплатно!

Вы можете скачать полные примеры и файлы данных с GitHub.