Рендереры – Renderers – С#

Renderers

Пространство имен Aspose.Html.Rendering состоит из множества объектов рендеринга и соответствующих низкоуровневых классов опций, которые отвечают за рендеринг документов. в реализацию IDevice. Aspose.HTML для .NET API предоставляет следующую реализацию рендереров: HtmlRenderer, SvgRenderer, MhtmlRenderer, и EpubRenderer,, которые используются для рендеринга документов HTML, SVG, MHTML и EPUB соответственно.

В то время как метод RenderTo() класса Document дает вам возможность отправить один документ на выход устройство рендеринга, используя экземпляры Renderer напрямую, вы можете отправлять несколько файлов одновременно. Таким образом, вы можете объединять HTML, документы MHTML, EPUB и SVG и применять параметры рендеринга для преобразования выходного файла.

В данной статье описываются поддерживаемые сценарии преобразования и слияния HTML-файлов в другие популярные форматы с использованием методов Render() Renderer класса.

HtmlRenderer

Использование класса HtmlRenderer для рендеринга файлов HTML в другие популярные форматы – это еще один способ конвертировать HTML путем настройки параметры рендеринга и управление выводом процесса рендеринга.
Давайте рассмотрим использование класса HtmlRenderer для рендеринга HTML в PDF с пользовательскими параметрами рендеринга:

1. Инициализируйте документ HTML. Используйте один из конструкторов HTMLDocument() для создания экземпляра HTMLDocument.
2. Создайте новый объект HtmlRenderer.
3. Создайте экземпляр PdfRenderingOptions и установите пользовательские параметры для выходного PDF-документа. В примере мы указываем свойство AnyPage класса PageSetup, которое устанавливает новый объект Page со страницей размер 600 пикселей на 200 пикселей и свойство Encryption, которое идентифицирует пароли пользователя и владельца, разрешено разрешения и алгоритм шифрования выходного PDF-файла.
4. Используйте конструктор PdfDevice(options, savePath) для создания объекта класса PdfDevice.
5. И, наконец, вызовите метод Render(device, document) для рендеринга HTML-документа в выходной PDF-файл с указанными параметрами рендеринга.

using System.IO;
using Aspose.Html;
using Aspose.Html.Rendering;
using Aspose.Html.Rendering.Pdf;
using Aspose.Html.Rendering.Pdf.Encryption;
...
    // Prepare a path to a source HTML file
    string documentPath = Path.Combine(DataDir, "file.html");

    // Initialize an HTML document from the file
    using var document = new HTMLDocument(documentPath);

    // Create an instance of HTML Renderer
    using var renderer = new HtmlRenderer();

    // Prepare a path to save the converted file 
    string savePath = Path.Combine(OutputDir, "convert-html-options.pdf");

    // Create the instance of the PdfRenderingOptions and set a custom page size and encryption
    var options = new PdfRenderingOptions();
    options.PageSetup.AnyPage = new Page(new Size(600, 200));
    options.Encryption = new PdfEncryptionInfo(
            "user_pwd",
            "owner_pwd",
            PdfPermissions.PrintDocument,
            PdfEncryptionAlgorithm.RC4_128);

    // Create an instance of PDF device
    using var device = new PdfDevice(options, savePath);

    // Render HTML to PDF
    renderer.Render(device, document);

Параметры рендеринга дают вам дополнительный контроль над процессом рендеринга. Чтобы узнать о них больше, прочитайте статью Параметры рендеринга. Устройство визуализации device принимает объект опций в качестве параметра и представляет выходной документ. Чтобы узнать больше, прочитайте статью Устройство рендеринга.

Если вас интересует, как использовать параметры рендеринга для изменения размера страниц документа в соответствии с размером содержимого и наоборот, посетите статью Как изменить размер документа во время преобразования из HTML?

SvgRenderer

SvgRenderer позволяет преобразовывать файлы SVG в другие форматы файлов, такие как PDF, XPS, DOCX и форматы изображений. При этом вы можете настроить выходной файл, используя различные параметры рендеринга. В следующем примере показано, как использовать класс SvgRenderer для преобразования SVG в PDF с указанием пользовательского размера страницы:

1. Инициализируйте документ SVG. Используйте один из конструкторов SVGDocument() для создания экземпляра SVGDocument.
2. Создайте новый объект SvgRenderer.
3. Создайте экземпляр PdfRenderingOptions и установите пользовательские параметры для выходного PDF-документа. В примере мы указываем свойство PageSetup.AnyPage, которое устанавливает новый объект Page с размером страницы 600x500 пикселей.
4. Используйте конструктор PdfDevice(options, savePath) для создания объект класса PdfDevice.
5. И, наконец, вызовите метод Render(device, document) для рендеринга документа SVG в выходной PDF-файл с указанными параметрами рендеринга.

using System.IO;
using Aspose.Html;
using Aspose.Html.Rendering;
using Aspose.Html.Rendering.Pdf;
using Aspose.Html.Rendering.Pdf.Encryption;
...
    // Initialize an SVG document from the file
    using var document = new SVGDocument(Path.Combine(DataDir, "shapes.svg"));    

    // Create an instance of SVG Renderer
    using var renderer = new SvgRenderer();

    // Prepare a path to save the converted file 
    string savePath = Path.Combine(OutputDir, "merge-svg.pdf");

    // Create the instance of the PdfRenderingOptions class and set a custom page size
    var options = new PdfRenderingOptions();
    options.PageSetup.AnyPage = new Page(new Size(600, 500));            

    // Create an instance of PdfDevice class
    using var device = new PdfDevice(options, savePath);

    // Render SVG to PDF
    renderer.Render(device, document);

MhtmlRenderer

В следующем примере показано, как преобразовать MHTML в PDF с указанием параметров рендеринга с использованием класса MhtmlRenderer:

1. Откройте существующий документ MHTML.
2. Создайте экземпляр MhtmlRenderer с помощью конструктора MhtmlRenderer().
3. Инициализируйте класс PdfRenderingOptions и задайте параметры рендеринга.
4. Создайте экземпляр класса PdfDevice.
5. Вызовите метод Render(device, stream) для рендеринга MHTML в PDF.

using System.IO;
using Aspose.Html;
using Aspose.Html.Rendering;
using Aspose.Html.Rendering.Pdf;
...
    // Open an existing MHTML file for reading
    using var stream = File.OpenRead(DataDir + "sample.mht");
            
    // Create an instance of MHTML Renderer
    using var renderer = new MhtmlRenderer();

    // Prepare a path to save the converted file 
    string savePath = Path.Combine(OutputDir, "convert-mhtml-options.pdf");

    // Create the instance of Rendering Options and set a custom page size and background color
    var options = new PdfRenderingOptions();
    options.PageSetup.AnyPage = new Page(new Size(600, 200));
    options.BackgroundColor = System.Drawing.Color.Azure;

    // Create an instance of PDF device
    using var device = new PdfDevice(options, savePath);

    // Render MHTML to PDF
    renderer.Render(device, stream);

EpubRenderer

Класс EpubRenderer позволяет преобразовывать файлы EPUB в другие форматы, такие как PDF, XPS, DOCX и изображения. В следующих примерах C# показано, как преобразовать EPUB в DOCX с настраиваемой настройкой размера страницы:

1. Откройте существующий файл EPUB.
2. Создайте экземпляр класса EpubRenderer.
3. Инициализируйте класс DocRenderingOptions и задайте параметры рендеринга.
4. Создайте экземпляр класса DocDevice.
5. Вызовите метод Render(device, stream) для рендеринга EPUB в DOCX.

using System.IO;
using Aspose.Html;
using Aspose.Html.Rendering;
using Aspose.Html.Rendering.Doc;
...
    // Open an existing EPUB file for reading
    using var stream = File.OpenRead(DataDir + "input.epub");

    // Create an instance of EPUB Renderer
    using var renderer = new EpubRenderer();

    // Prepare a path to save the converted file 
    string savePath = Path.Combine(OutputDir, "convert-epub-options.docx");

    // Create the instance of the DocRenderingOptions class and set a custom page size
    var options = new DocRenderingOptions();
    options.PageSetup.AnyPage = new Page(new Size(800, 400));            

    // Create an instance of the DocDevice class
    using var device = new DocDevice(options, savePath);

    // Render EPUB to DOCX
    renderer.Render(device, stream);

Объединение HTML

Aspose.HTML для .NET API предоставляет Renderer для рендеринга и объединения документов HTML, MHTML, EPUB и SVG в популярные форматы. В то время как метод RenderTo() дает вам возможность отправить один документ на выходное устройство рендеринга, используя экземпляры Renderer напрямую, вы можете отправлять несколько файлов одновременно. Используя реализацию средств визуализации: HtmlRenderer, SvgRenderer, MhtmlRenderer и EpubRenderer, вы можете объединять документы HTML, SVG, MHTML и EPUB соответственно. В следующем примере показано, как использовать HtmlRenderer для рендеринга нескольких HTML-документов:

using System.IO;
using Aspose.Html;
using Aspose.Html.Rendering;
using Aspose.Html.Rendering.Pdf;
...
    // Prepare HTML code
    var code1 = @"<br><span style='color: green'>Hello World!!</span>";
    var code2 = @"<br><span style='color: blue'>Hello World!!</span>";
    var code3 = @"<br><span style='color: red'>Hello World!!</span>";

    // Create three HTML documents to merge later
    using var document1 = new HTMLDocument(code1, ".");
    using var document2 = new HTMLDocument(code2, ".");
    using var document3 = new HTMLDocument(code3, ".");

    // Create an instance of HTML Renderer
    using var renderer = new HtmlRenderer();

    // Prepare a path to save the converted file 
    string savePath = Path.Combine(OutputDir, "merge-html.pdf");

    // Create an instance of PDF device
    using var device = new PdfDevice(savePath);
                    
    // Merge all HTML documents into PDF
    renderer.Render(device, document1, document2, document3);  

Установить время ожидания

Еще одна важная функция, доступная для рендереров, – тайм-аут. Вы можете использовать его, чтобы указать, как долго вы готовы ждать завершения всех внутренних процессов, связанных с жизненным циклом документа, таких как загрузка ресурсов, активные таймеры и т. д. Конечно, вы можете указать бесконечный период ожидания. Однако, если документ содержит скрипт с бесконечным циклом, вы будете ждать бесконечно долго. В приведенном ниже примере показано, как использовать параметр тайм-аута:

using System.IO;
using Aspose.Html;
using Aspose.Html.Rendering;
using Aspose.Html.Rendering.Pdf;
...
    // Prepare HTML code
    var code = @"
    <script>
        var count = 0;
        setInterval(function()
            {
                var element = document.createElement('div');
                var message = (++count) + '. ' + 'Hello, World!! I know how to use Renderers!';
                var text = document.createTextNode(message);
                element.appendChild(text);
                document.body.appendChild(element);
            }, 1000);
    </script>";

    // Initialize an HTML document based on prepared HTML code
    using var document = new HTMLDocument(code, ".");

    // Create an instance of HTML Renderer
    using HtmlRenderer renderer = new HtmlRenderer();

    // Prepare a path to save the converted file 
    string savePath = Path.Combine(OutputDir, "set-timeout.pdf");

    // Create an instance of PDF device
    using var device = new PdfDevice(savePath);
                    
    // Render HTML to PDF and set timeout
    renderer.Render(device, TimeSpan.FromSeconds(5), document); 

В этом примере мы создаем документ HTML, который каждую секунду добавляет новый элемент <div> с порядковым номером и сообщением «Hello, World!!» Мы используем параметр TimeSpan в Render(device, timeout, document) для установки времени ожидания. Этот параметр указывает максимальное время, которое средство визуализации потратит на визуализацию документа. В этом случае общее время устанавливается равным 5 секундам. Если модуль визуализации не сгенерировал документ в течение указанного времени, он остановится и визуализирует частично визуализированный документ. Запустив этот пример, вы получите документ с пятью строками «Привет, мир!! Я знаю, как использовать визуализаторы!» сообщение следующим образом:

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

Aspose.HTML предлагает бесплатные онлайн Конвертеры, которые могут преобразовывать файлы HTML, XHTML, MHTML, EPUB, XML и Markdown в ряд популярных форматов. Вы можете легко конвертировать HTML-документы в форматы PDF, XPS, DOCX, JPG, PNG, GIF, TIFF и другие форматы. Просто выберите файл, выберите формат для преобразования, и все готово. Лучше всего то, что это совершенно бесплатно!

< /а>