Renderers – Rendre HTML, MHTML, EPUB et SVG en C#

Renderers

L’espace de noms Aspose.Html.Rendering comprend de nombreux objets de rendu et des classes d’options de bas niveau appropriées, qui sont responsables du rendu des documents dans l’implémentation IDevice. L’API Aspose.HTML for .NET fournit les objets de rendu suivants : HtmlRenderer, SvgRenderer, MhtmlRenderer et EpubRenderer, qui sont utilisés pour rendre les documents HTML, SVG, MHTML et EPUB, respectivement.

Alors que la méthode RenderTo() de la classe Document vous permet d’envoyer un seul document au dispositif de rendu de sortie, l’utilisation directe des instances Renderer vous permet d’envoyer plusieurs fichiers à la fois. Ainsi, vous pouvez fusionner des documents HTML, MHTML, EPUB et SVG et appliquer des options de rendu pour transformer le fichier de sortie.

Cet article décrit les scénarios pris en charge pour la conversion et la fusion de fichiers HTML vers d’autres formats populaires à l’aide des méthodes Render() de la classe Renderer.

HtmlRenderer

L’utilisation de la classe HtmlRenderer pour convertir des fichiers HTML en d’autres formats populaires est un moyen supplémentaire de convertir du HTML en personnalisant les options de rendu et en contrôlant le résultat du processus de rendu. Voyons comment utiliser la classe HtmlRenderer pour convertir du HTML en PDF avec des options de rendu personnalisées :

1. Initialiser un document HTML. Utilisez l’un des constructeurs HTMLDocument() pour créer une instance de document HTML.
2. Créer un nouvel objet HtmlRenderer.
3. Créez l’instance de PdfRenderingOptions et définissez des options personnalisées pour le document PDF de sortie. Dans l’exemple, nous spécifions la propriété AnyPage de la classe PageSetup qui définit un nouvel objet Page avec une taille de page de 600 pixels par 200 pixels et la propriété Encryption qui identifie les mots de passe de l’utilisateur et du propriétaire, les permissions autorisées et l’algorithme de cryptage pour le fichier PDF de sortie.
4. Utilisez le constructeur PdfDevice(options, savePath) pour créer un objet de la classe PdfDevice.
5. Enfin, appelez la méthode Render(device, document) pour rendre le document HTML dans le fichier PDF de sortie avec les options de rendu spécifiées.

// Render HTML to PDF with custom page settings using C#

// Prepare a path to a source HTML file
string documentPath = Path.Combine(DataDir, "file.html");

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

// Create an instance of HTML Renderer
using HtmlRenderer 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
PdfRenderingOptions 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 PdfDevice device = new PdfDevice(options, savePath);

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

Les options de rendu vous donnent un contrôle supplémentaire sur le processus de rendu. Pour en savoir plus, lisez l’article Options de rendu.

Pour en savoir plus sur le processus de rendu, veuillez lire l’article Dispositif de rendu – Rendering Device.

Si vous souhaitez savoir comment utiliser les options de rendu pour redimensionner les pages d’un document en fonction de la taille du contenu et vice versa, veuillez consulter l’article Comment redimensionner un document lors d’une conversion à partir de HTML?

SvgRenderer

Le SvgRenderer vous permet de convertir des fichiers SVG en d’autres formats de fichiers, tels que PDF, XPS, DOCX et des formats d’images. Vous pouvez ainsi personnaliser le fichier de sortie à l’aide de diverses options de rendu. L’exemple suivant montre comment utiliser la classe SvgRenderer pour rendre un fichier SVG au format PDF en spécifiant une taille de page personnalisée :

1. Initialiser un document SVG. Utilisez l’un des constructeurs SVGDocument() pour créer une instance de SVGDocument.
2. Créer un nouvel objet SvgRenderer.
3. Créez une instance de PdfRenderingOptions et définissez des options personnalisées pour le document PDF de sortie. Dans l’exemple, nous spécifions la propriété PageSetup.AnyPage qui définit un nouvel objet Page avec une taille de page de 600x500 pixels.
4. Utilisez le constructeur PdfDevice(options, savePath) pour créer un objet de la classe PdfDevice.
5. Enfin, appelez la méthode Render(device, document) pour effectuer le rendu du document SVG dans le fichier PDF de sortie avec les options de rendu spécifiées.

// Render SVG to PDF using C#

// Initialize an SVG document from the file
using SVGDocument document = new SVGDocument(Path.Combine(DataDir, "shapes.svg"));

// Create an instance of SVG Renderer
using SvgRenderer 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
PdfRenderingOptions options = new PdfRenderingOptions();
options.PageSetup.AnyPage = new Page(new Size(600, 500));

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

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

MhtmlRenderer

L’exemple suivant montre comment convertir du MHTML en PDF en spécifiant les options de rendu à l’aide de la classe MhtmlRenderer :

1. Ouvrir un document MHTML existant.
2. Créez une instance de MhtmlRenderer en utilisant le constructeur MhtmlRenderer().
3. Initialiser la classe PdfRenderingOptions et définir les options de rendu.
4. Créer une instance de la classe PdfDevice.
5. Appeler la méthode Render(device, stream) pour convertir le MHTML en PDF.

// Convert MHTML to PDF with custom page settings using C#

// Open an existing MHTML file for reading
using FileStream stream = File.OpenRead(DataDir + "sample.mht");

// Create an instance of MHTML Renderer
using MhtmlRenderer 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
PdfRenderingOptions 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 PdfDevice device = new PdfDevice(options, savePath);

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

EpubRenderer

La classe EpubRenderer vous permet de convertir des fichiers EPUB en d’autres formats tels que PDF, XPS, DOCX et images. L’exemple C# suivant montre comment convertir un EPUB en DOCX avec un paramètre de taille de page personnalisé :

1. Ouvrir un fichier EPUB existant.
2. Créer une instance de la classe EpubRenderer.
3. Initialiser la classe DocRenderingOptions et définir les options de rendu.
4. Créer une instance de la classe DocDevice.
5. Appeler la méthode Render(device, stream) pour convertir l’EPUB en DOCX.

// Convert EPUB to DOCX with custom page size using C#

// Open an existing EPUB file for reading
using FileStream stream = File.OpenRead(DataDir + "input.epub");

// Create an instance of EPUB Renderer
using EpubRenderer 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
DocRenderingOptions options = new DocRenderingOptions();
options.PageSetup.AnyPage = new Page(new Size(800, 400));

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

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

Fusionner HTML

l’API Aspose.HTML for .NET API fournit la classe Renderer pour le rendu et la fusion de documents HTML, MHTML, EPUB et SVG dans les formats les plus courants. Alors que la méthode RenderTo() vous permet d’envoyer un seul document au dispositif de rendu de sortie, l’utilisation directe des instances Renderer vous permet d’envoyer plusieurs fichiers à la fois. En utilisant l’implémentation des moteurs de rendu : HtmlRenderer, SvgRenderer, MhtmlRenderer et EpubRenderer, vous pouvez fusionner des documents HTML, SVG, MHTML et EPUB, respectivement. L’exemple suivant montre comment utiliser HtmlRenderer pour rendre plusieurs documents HTML :

// Merge HTML to PDF using C#

// Prepare HTML code
string code1 = @"<br><span style='color: green'>Hello, World!!</span>";
string code2 = @"<br><span style='color: blue'>Hello, World!!</span>";
string code3 = @"<br><span style='color: red'>Hello, World!!</span>";

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

// Create an instance of HTML Renderer
using HtmlRenderer 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 PdfDevice device = new PdfDevice(savePath);

// Merge all HTML documents into PDF
renderer.Render(device, document1, document2, document3);

Définir le délai d’attente

Une autre fonction importante disponible pour les moteurs de rendu est le délai d’attente. Vous pouvez l’utiliser pour spécifier la durée pendant laquelle vous êtes prêt à attendre que tous les processus internes liés au cycle de vie d’un document soient terminés, tels que le chargement des ressources, les temporisations actives, etc. Bien sûr, vous pouvez spécifier une période d’attente infinie. Bien sûr, vous pouvez spécifier une période d’attente infinie. Cependant, si le document contient un script avec une boucle sans fin, vous attendrez indéfiniment. L’exemple ci-dessous montre comment utiliser le paramètre timeout :

// Render HTML to PDF with timeout settings using C#

// Prepare HTML code
string 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 HTMLDocument 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 PdfDevice device = new PdfDevice(savePath);

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

Dans cet exemple, nous créons un document HTML qui ajoute un nouvel élément <div> toutes les secondes avec un numéro séquentiel et le message “Hello, World !!” Nous utilisons le paramètre TimeSpan dans la méthode Render(device, timeout, document) pour définir le timeout. Ce paramètre spécifie le temps maximum que le moteur de rendu passera à rendre le document. Dans ce cas, le temps total est fixé à 5 secondes. Si le moteur de rendu n’a pas généré de document dans le délai spécifié, il s’arrêtera et rendra un document partiellement rendu. En exécutant cet exemple, vous obtiendrez un document contenant cinq lignes de “Hello, World ! Je sais comment utiliser les moteurs de rendu”, comme suit :

Vous pouvez télécharger les exemples C# complets et les fichiers de données sur GitHub.

Aspose.HTML propose des Convertisseurs gratuits en ligne qui permettent de convertir des fichiers HTML, XHTML, MHTML, EPUB, XML et Markdown dans toute une série de formats populaires. Vous pouvez facilement convertir vos documents HTML en PDF, XPS, DOCX, JPG, PNG, GIF, TIFF et autres. Il vous suffit de sélectionner un fichier, de choisir le format à convertir et le tour est joué. Cerise sur le gâteau, c’est entièrement gratuit !