Renderizadores – renderice HTML, MHTML, EPUB y SVG en C#

Renderizadores

El espacio de nombres Aspose.Html.Rendering consta de numerosos objetos de representación y clases de opciones de bajo nivel apropiadas, que son responsables de representar documentos en la implementación de IDevice. Aspose.HTML for .NET API proporciona la siguiente realización de renderizadores: HtmlRenderer, SvgRenderer, MhtmlRenderer, y EpubRenderer, que se utilizan para representar HTML, Documentos SVG, MHTML y EPUB, respectivamente.

Si bien el método RenderTo() de la clase Documento le brinda la posibilidad de enviar un solo documento al dispositivo de procesamiento de salida, utilizando las instancias Renderer directamente, puede enviar varios archivos a la vez. Por lo tanto, puede combinar documentos HTML, MHTML, EPUB y SVG y aplicar opciones de renderizado para convertir el archivo de salida.

El artículo actual describe escenarios admitidos de conversión y fusión de archivos basados ​​en HTML a otros formatos populares utilizando los métodos Render() de la clase Renderer.

HtmlRenderer

El uso de la clase HtmlRenderer para renderizar archivos HTML a otros formatos populares es una forma más de convertir HTML personalizando las opciones de renderizado y controlando la salida del proceso de renderizado. Veamos el uso de la clase HtmlRenderer para representar HTML a PDF con opciones de representación personalizadas:

1. Inicialice un documento HTML. Utilice uno de los constructores HTMLDocument() para crear una instancia de HTMLDocument.
2. Cree un nuevo objeto HtmlRenderer.
3. Cree la instancia de PdfRenderingOptions y establezca opciones personalizadas para el documento PDF de salida. En el ejemplo, especificamos la propiedad AnyPage de la clase PageSetup que establece un nuevo objeto Página con un tamaño de página de 600 x 200 píxeles y la propiedad Encryption que identifica las contraseñas de usuario y propietario. , permisos permitidos y algoritmo de cifrado para el archivo PDF de salida.
4. Utilice el constructor PdfDevice(options, savePath) para crear un objeto de la clase PdfDevice.
5. Y finalmente, llame al método Render(device, document) para renderizar el documento HTML en el archivo PDF de salida con las opciones de renderizado especificadas.

// 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 Rendering Options and set a custom page-size
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);

Las opciones de renderizado le brindan control adicional sobre el proceso de renderizado. Para obtener más información sobre ellos, lea el artículo Opciones de renderizado.

Para obtener más información sobre el proceso de renderizado, lea el artículo Dispositivo de renderizado.

Si está interesado en cómo utilizar las opciones de representación para cambiar el tamaño de las páginas del documento al tamaño del contenido y viceversa, visite el artículo ¿Cómo cambiar el tamaño del documento durante la conversión desde HTML?

SVGRenderer

El SvgRenderer le permite renderizar archivos SVG en otros formatos de archivo, como PDF, XPS, DOCX y formatos de imagen. Con esto, puede personalizar el archivo de salida utilizando varias opciones de renderizado. El siguiente ejemplo demuestra cómo utilizar la clase SvgRenderer para representar SVG a PDF con un tamaño de página personalizado que especifica:

1. Inicialice un documento SVG. Utilice uno de los constructores SVGDocument() para crear una instancia de SVGDocument.
2. Cree un nuevo objeto SvgRenderer.
3. Cree una instancia de PdfRenderingOptions y configure opciones personalizadas para el documento PDF de salida. En el ejemplo, especificamos la propiedad PageSetup.AnyPage que establece un nuevo objeto Página con un tamaño de página de 600x500 píxeles.
4. Utilice el constructor PdfDevice(options, savePath) para crear un objeto de la clase PdfDevice.
5. Y finalmente, llame al método Render(device, document) para renderizar el documento SVG en el archivo PDF de salida con las opciones de renderizado especificadas.

// 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, "rendering-svg.pdf");

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

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

// Merge all SVG documents into PDF
renderer.Render(device, document);

MhtmlRenderer

El siguiente ejemplo demuestra cómo convertir MHTML a PDF con las opciones de representación especificadas mediante la clase MhtmlRenderer:

1. Abra un documento MHTML existente.
2. Cree una instancia de MhtmlRenderer usando el constructor MhtmlRenderer().
3. Inicialice la clase PdfRenderingOptions y establezca las opciones de representación.
4. Cree una instancia de la clase PdfDevice.
5. Llame al método Render(device, stream) para renderizar MHTML a 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);

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

EpubRenderer

La clase EpubRenderer le permite convertir archivos EPUB a otros formatos como PDF, XPS, DOCX e imágenes. Los siguientes ejemplos de C# muestran cómo convertir EPUB a DOCX con una configuración de tamaño de página personalizada:

1. Abra un archivo EPUB existente.
2. Cree una instancia de la clase EpubRenderer.
3. Inicialice la clase DocRenderingOptions y configure las opciones de representación.
4. Cree una instancia de la clase DocDevice.
5. Llame al método Render(device, stream) para renderizar EPUB a DOCX.

// 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 Rendering Options 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);

Fusionar HTML

Aspose.HTML for .NET API proporciona la clase Renderer para renderizar y fusionar documentos HTML, MHTML, EPUB y SVG en formatos populares. Si bien el método RenderTo() le brinda la posibilidad de enviar un solo documento al dispositivo de procesamiento de salida, utilizando las instancias Renderer directamente, puede enviar varios archivos a la vez. Utilizando la implementación de renderizadores: HtmlRenderer, SvgRenderer, MhtmlRenderer y EpubRenderer, puede fusionar documentos HTML, SVG, MHTML y EPUB, respectivamente. El siguiente ejemplo demuestra cómo utilizar HtmlRenderer para representar varios documentos HTML:

// 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);

Establecer tiempo de espera

Una característica más importante que está disponible para los renderizadores es el tiempo de espera. Puede usarlo para especificar cuánto tiempo está listo para esperar a que se completen todos los procesos internos relacionados con el ciclo de vida de un documento, como la carga de recursos, temporizadores activos, etc. Claro, puede especificar un período de espera infinito. Sin embargo, si el documento contiene un script con un bucle sin fin, esperará indefinidamente. El siguiente ejemplo demuestra cómo utilizar el parámetro de tiempo de espera:

// 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, "output-timeout.pdf");

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

En este ejemplo, creamos un documento HTML que agrega un nuevo elemento <div> cada segundo con un número secuencial y el mensaje “Hello, World!!” Usamos el parámetro TimeSpan en el método Render(device, timeout, document) para establecer el tiempo de espera. Esta configuración especifica el tiempo máximo que el renderizador dedicará a renderizar el documento. En este caso, el tiempo total se establece en 5 segundos. Si el renderizador no ha generado un documento dentro del tiempo especificado, se detendrá y renderizará un documento parcialmente renderizado. Al ejecutar este ejemplo, obtendrá un documento con cinco líneas que dicen “Hello, World!! I know how to use Renderers!” mensaje, de la siguiente manera:

Puede descargar los ejemplos completos de C# y los archivos de datos desde GitHub.

Aspose.HTML ofrece Convertidores gratuitos en línea que pueden convertir archivos HTML, XHTML, MHTML, EPUB, XML y Markdown a una variedad de formatos populares. Puede convertir fácilmente sus documentos basados ​​en HTML a PDF, XPS, DOCX, JPG, PNG, GIF, TIFF y otros. Simplemente seleccione un archivo, elija el formato a convertir y listo. ¡Lo mejor de todo es que es completamente gratis!