Renderer – Rendern von HTML, MHTML, EPUB und SVG in C#

Renderer

Der Aspose.Html.Rendering Namespace besteht aus zahlreichen Renderer-Objekten und entsprechenden Low-Level Options-Klassen, die für das Rendering von Dokumenten in der IDevice Implementierung verantwortlich sind. Aspose.HTML for .NET API bietet die folgende Realisierung von Renderern: HtmlRenderer, SvgRenderer, MhtmlRenderer, und EpubRenderer, die zum Rendern von HTML-, SVG-, MHTML- bzw. EPUB-Dokumenten verwendet werden.

Während die Methode RenderTo() der Dokumentenklasse Ihnen die Möglichkeit gibt, ein einzelnes Dokument an das Ausgaberendergerät zu senden, können Sie mit den Renderer Instanzen direkt mehrere Dateien auf einmal senden. So können Sie HTML, MHTML-, EPUB- und SVG-Dokumente zusammenführen und Rendering-Optionen anwenden, um die Ausgabedatei zu drehen.

Der aktuelle Artikel beschreibt unterstützte Szenarien für die Konvertierung und Zusammenführung von HTML-basierten Dateien in andere gängige Formate unter Verwendung der Render()-Methoden der Klasse Renderer.

HtmlRenderer

Die Verwendung der Klasse HtmlRenderer zum Rendern von HTML-Dateien in andere gängige Formate ist eine weitere Möglichkeit, HTML zu konvertieren, indem man die Rendering-Optionen anpasst und die Ausgabe des Rendering-Prozesses kontrolliert. Sehen wir uns die Verwendung der Klasse HtmlRenderer zum Rendern von HTML in PDF mit benutzerdefinierten Rendering-Optionen an:

1. Initialisieren Sie ein HTML-Dokument. Verwenden Sie einen der HTMLDocument() Konstruktoren, um eine HTMLDocument-Instanz zu erstellen.
2. Erstellen Sie ein neues HtmlRenderer-Objekt.
3. Erstellen Sie die Instanz von PdfRenderingOptions und legen Sie benutzerdefinierte Optionen für das PDF-Ausgabedokument fest. Im Beispiel geben wir die Eigenschaft AnyPage der Klasse PageSetup an, die ein neues Page-Objekt mit einer Seitengröße von 600 x 200 Pixeln festlegt, sowie die Eigenschaft Encryption, die die Passwörter von Benutzer und Eigentümer, die zulässigen Berechtigungen und den Verschlüsselungsalgorithmus für die PDF-Ausgabedatei angibt.
4. Verwenden Sie den PdfDevice(options, savePath) Konstruktor, um ein Objekt der Klasse PdfDevice zu erstellen.
5. Und schließlich rufen Sie die Methode Render(device, document) auf, um das HTML-Dokument mit den angegebenen Rendering-Optionen in die PDF-Ausgabedatei zu übertragen.

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

Rendering-Optionen geben Ihnen zusätzliche Kontrolle über den Rendering-Prozess. Um mehr über sie zu erfahren, lesen Sie bitte den Artikel Rendering-Optionen.

Um mehr über den Rendering-Prozess zu erfahren, lesen Sie bitte den Artikel Rendering Device.

Wenn Sie daran interessiert sind, wie Sie die Rendering-Optionen nutzen können, um die Größe der Dokumentseiten an die Größe des Inhalts anzupassen und umgekehrt, lesen Sie bitte den Artikel Wie kann man die Größe eines Dokuments bei der Konvertierung von HTML ändern?

SvgRenderer

Mit dem SvgRenderer können Sie SVG-Dateien in andere Dateiformate wie PDF, XPS, DOCX und Bildformate rendern. Dabei können Sie die Ausgabedatei mit verschiedenen Rendering-Optionen anpassen. Das folgende Beispiel zeigt, wie die Klasse SvgRenderer verwendet wird, um SVG-Dateien in PDF-Dateien mit einer benutzerdefinierten Seitengröße zu rendern:

1. Initialisieren Sie ein SVG-Dokument. Verwenden Sie einen der SVGDocument() Konstruktoren, um eine SVGDocument-Instanz zu erstellen.
2. Erstellen Sie ein neues SvgRenderer-Objekt.
3. Erstellen Sie eine Instanz von PdfRenderingOptions und legen Sie benutzerdefinierte Optionen für das PDF-Ausgabedokument fest. Im Beispiel geben wir die Eigenschaft PageSetup.AnyPage an, die ein neues Seitenobjekt mit einer Seitengröße von 600x500 Pixeln festlegt.
4. Verwenden Sie den PdfDevice(options, savePath) Konstruktor, um ein Objekt der Klasse PdfDevice zu erstellen.
5. Und schließlich rufen Sie die Methode Render(device, document) auf, um das SVG-Dokument mit den angegebenen Rendering-Optionen in die PDF-Ausgabedatei zu übertragen.

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

Das folgende Beispiel zeigt, wie MHTML in PDF konvertiert wird, wobei die Rendering-Optionen mit der Klasse MhtmlRenderer angegeben werden:

1. Öffnen Sie ein vorhandenes MHTML-Dokument.
2. Erstellen Sie eine Instanz von MhtmlRenderer mit dem MhtmlRenderer() Konstruktor.
3. Initialisieren Sie die Klasse PdfRenderingOptions und legen Sie Rendering-Optionen fest.
4. Erstellen Sie eine Instanz der Klasse PdfDevice.
5. Rufen Sie die Methode Render(device, stream) auf, um MHTML in PDF umzuwandeln.

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

Mit der Klasse EpubRenderer können Sie EPUB-Dateien in andere Formate wie PDF, XPS, DOCX und Bilder konvertieren. Das folgende C#-Beispiel zeigt, wie Sie EPUB in DOCX mit einer benutzerdefinierten Seitengrößeneinstellung konvertieren:

1. Öffnen Sie eine vorhandene EPUB-Datei.
2. Erstellen Sie eine Instanz der EpubRenderer-Klasse.
3. Initialisieren Sie die Klasse DocRenderingOptions und legen Sie Rendering-Optionen fest.
4. Erstellen Sie eine Instanz der Klasse DocDevice.
5. Rufen Sie die Methode Render(device, stream) auf, um EPUB in DOCX zu rendern.

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

HTML zusammenführen

die Aspose.HTML for .NET API bietet die Klasse Renderer zum Rendern und Zusammenführen von HTML-, MHTML-, EPUB- und SVG-Dokumenten in gängigen Formaten. Während die Methode RenderTo() Ihnen die Möglichkeit gibt, ein einzelnes Dokument an das Ausgaberendergerät zu senden, können Sie durch die direkte Verwendung der Renderer-Instanzen mehrere Dateien auf einmal senden. Die Verwendung der Implementierung von Renderern: HtmlRenderer, SvgRenderer, MhtmlRenderer und EpubRenderer, können Sie HTML-, SVG-, MHTML- bzw. EPUB-Dokumente zusammenführen. Das nächste Beispiel zeigt, wie Sie HtmlRenderer verwenden, um mehrere HTML-Dokumente zu rendern:

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

Zeitüberschreitung einstellen

Eine weitere wichtige Funktion, die für Renderer zur Verfügung steht, ist die Zeitüberschreitung. Damit können Sie angeben, wie lange Sie bereit sind zu warten, bis alle internen Prozesse im Zusammenhang mit dem Lebenszyklus eines Dokuments abgeschlossen sind, z. B. das Laden von Ressourcen, aktive Zeitgeber usw. Natürlich können Sie eine unendliche Wartezeit angeben. Wenn das Dokument jedoch ein Skript mit einer Endlosschleife enthält, werden Sie unendlich lange warten müssen. Das folgende Beispiel zeigt, wie Sie den Timeout-Parameter verwenden können:

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

In diesem Beispiel erstellen wir ein HTML-Dokument, das jede Sekunde ein neues <div>-Element mit einer fortlaufenden Nummer und der Nachricht “Hello, World!!” einfügt Wir verwenden den Parameter TimeSpan in der Methode Render(device, timeout, document), um die Zeitüberschreitung festzulegen. Diese Einstellung gibt die maximale Zeit an, die der Renderer für das Rendern des Dokuments benötigt. In diesem Fall wird die Gesamtzeit auf 5 Sekunden festgelegt. Wenn der Renderer innerhalb der angegebenen Zeit kein Dokument erzeugt hat, wird er anhalten und ein teilweise gerendertes Dokument rendern. Wenn Sie dieses Beispiel ausführen, erhalten Sie ein Dokument mit fünf Zeilen von “Hello, World!! I know how to use Renderers!"-Meldung, wie folgt:

Sie können die vollständigen C#-Beispiele und Datendateien von GitHub herunterladen.

Aspose.HTML bietet kostenlose Online- Konverter, die HTML-, XHTML-, MHTML-, EPUB-, XML- und Markdown-Dateien in eine Reihe von gängigen Formaten konvertieren können. Sie können Ihre HTML-basierten Dokumente ganz einfach in PDF, XPS, DOCX, JPG, PNG, GIF, TIFF und andere konvertieren. Wählen Sie einfach eine Datei aus, wählen Sie das zu konvertierende Format, und schon sind Sie fertig. Und das Beste daran: Es ist völlig kostenlos!