Configuration de l'environnement – C#

Il est souvent utile de disposer de différentes configurations en fonction de l’environnement dans lequel l’application est exécutée. Par exemple, vous pouvez souhaiter configurer la politique des scripts, remplacer le style du document en appliquant une feuille de style utilisateur personnalisée ou gérer toutes les requêtes web de l’application. Aspose.HTML for .NET fournit la classe Configuration qui peut être utilisée exactement à ces fins.

Bac à sable – Sandbox

Un ensemble de drapeaux de sandboxing est un ensemble de zéro ou plusieurs drapeaux, qui sont utilisés pour restreindre les capacités des ressources potentiellement non fiables. L’attribut sandbox vous permet de définir un certain nombre de restrictions sur le contenu chargé dans le cadre, par exemple, de bloquer les formulaires et les scripts. Cela permet d’améliorer la sécurité du document actuel, en particulier lorsqu’un document est chargé dans le cadre à partir d’une source non vérifiée.

L’exemple suivant montre comment marquer Scripts comme une ressource non fiable. En conséquence, Scripts sera désactivé pendant l’exécution de l’application.

// Enable sandboxing to restrict script execution when loading HTML

// Prepare HTML code and save it to a file
string code = "<span>Hello, World!!</span> " +
              "<script>document.write('Have a nice day!');</script>";

File.WriteAllText(Path.Combine(OutputDir, "sandboxing.html"), code);

// Create an instance of Configuration
using (Configuration configuration = new Configuration())
{
    // Mark 'scripts' as an untrusted resource
    configuration.Security |= Sandbox.Scripts;

    // Initialize an HTML document with specified configuration
    using (HTMLDocument document = new HTMLDocument(Path.Combine(OutputDir, "sandboxing.html"), configuration))
    {
        // Convert HTML to PDF
        Converter.ConvertHTML(document, new PdfSaveOptions(), Path.Combine(OutputDir, "sandboxing_out.pdf"));
    }
}

Services

Toutes les fonctions importantes sont regroupées dans des services distincts à des fins de convivialité et situées dans l’espace de noms Aspose.Html.Services.

Service d’agent utilisateur – User Agent Service

Le Service de l’agent utilisateur vous permet de spécifier une feuille de style utilisateur personnalisée, un jeu de caractères principal pour le document, des paramètres de langue et de polices. Vous pouvez spécifier vos informations de style personnalisées pour un document particulier et modifier la configuration de l’environnement autant ou aussi peu que nécessaire. L’interface IUserAgentService décrit un environnement d’agent utilisateur.

Feuille de style de l’utilisateur – User Style Sheet

L’utilisateur peut spécifier des informations de style personnalisées pour un document particulier. Ces informations s’appliquent au document conformément aux règles de cascade et peuvent affecter la présentation du document. L’extrait de code suivant montre comment utiliser la propriété UserStyleSheet :

// Apply custom CSS via user agent service during HTML processing in C#

// Prepare HTML code and save it to a file
string code = "<h1>User Agent Service </h1>\r\n" +
              "<p>The User Agent Service allows you to specify a custom user stylesheet, a primary character set for the document, language and fonts settings.</p>\r\n";

File.WriteAllText(Path.Combine(OutputDir, "user-agent-stylesheet.html"), code);

// Create an instance of Configuration
using (Configuration configuration = new Configuration())
{
    // Get the IUserAgentService
    IUserAgentService userAgentService = configuration.GetService<IUserAgentService>();

    // Set the custom style parameters for the <h1> and <p> elements
    userAgentService.UserStyleSheet = "h1 { color:#a52a2a;; font-size:2em;}\r\n" +
                                      "p { background-color:GhostWhite; color:SlateGrey; font-size:1.2em; }\r\n";

    // Initialize the HTML document with specified configuration
    using (HTMLDocument document = new HTMLDocument(Path.Combine(OutputDir, "user-agent-stylesheet.html"), configuration))
    {
        // Convert HTML to PDF
        Converter.ConvertHTML(document, new PdfSaveOptions(), Path.Combine(OutputDir, "user-agent-stylesheet_out.pdf"));
    }
}

Jeu de caractères – Character Set

La propriété CharSet définit le jeu de caractères primaire d’un document. Pour analyser et afficher correctement un document HTML, l’application doit connaître le jeu de caractères (encodage) utilisé pour le document. Si l’encodage des caractères n’est pas directement spécifié dans l’en-tête du document, Aspose.HTML for .NET utilise UTF-8, qui est défini par défaut dans la spécification HTML5. Cependant, si vous êtes sûr que votre document HTML est écrit en utilisant un encodage différent de UTF-8, vous pouvez le spécifier manuellement, comme suit.

// Set character encoding and custom styles for HTML to PDF conversion in C#

// Prepare HTML code and save it to a file
string code = "<h1>Character Set</h1>\r\n" +
              "<p>The <b>CharSet</b> property sets the primary character-set for a document.</p>\r\n";

File.WriteAllText(Path.Combine(OutputDir, "user-agent-charset.html"), code);

// Create an instance of Configuration
using (Configuration configuration = new Configuration())
{
    // Get the IUserAgentService
    IUserAgentService userAgentService = configuration.GetService<IUserAgentService>();

    // Set the custom style parameters for the <h1> and <p> elements
    userAgentService.UserStyleSheet = "h1 { color:salmon; }\r\n" +
                                      "p { background-color:#f0f0f0; color:DarkCyan; font-size:1.2em; }\r\n";

    // Set ISO-8859-1 encoding to parse the document
    userAgentService.CharSet = "ISO-8859-1";

    // Initialize the HTML document with specified configuration
    using (HTMLDocument document = new HTMLDocument(Path.Combine(OutputDir, "user-agent-charset.html"), configuration))
    {
        // Convert HTML to PDF
        Converter.ConvertHTML(document, new PdfSaveOptions(), Path.Combine(OutputDir, "user-agent-charset_out.pdf"));
    }
}

Dans l’exemple ci-dessus, nous avons utilisé les propriétés CharSet et UserStyleSheet pour un encodage ISO-8859-1 et un style utilisateur.

Installer le dossier de polices

Aspose.HTML for .NET est une puissante bibliothèque permettant de travailler avec des documents HTML dans des applications .NET. Elle offre un large éventail de fonctionnalités permettant aux développeurs de rendre des documents HTML dans différents formats de sortie, tels que PDF, XPS, DOCX et images. L’une des principales caractéristiques d’Aspose.HTML est sa capacité à travailler avec des polices personnalisées, ce qui permet aux développeurs d’ajouter leurs propres polices au processus de rendu.

La propriété FontsSettings est utilisée pour la configuration de la gestion des polices. Dans le cas où vous avez besoin d’utiliser des polices personnalisées au lieu des polices installées sur le système d’exploitation, vous pouvez définir le chemin d’accès à votre dossier personnalisé, comme le montre l’extrait de code suivant :

// Set font folder for HTML to PDF conversion using C#

// Prepare HTML code and save it to a file
string code = "<h1>FontsSettings property</h1>\r\n" +
              "<p>The FontsSettings property is used for configuration of fonts handling.</p>\r\n";

File.WriteAllText(Path.Combine(OutputDir, "user-agent-fontsetting.html"), code);

// Create an instance of Configuration
using (Configuration configuration = new Configuration())
{
    // Get the IUserAgentService
    IUserAgentService userAgentService = configuration.GetService<IUserAgentService>();

    // Set the custom style parameters for the <h1> and <p> elements
    userAgentService.UserStyleSheet = "h1 { color:#a52a2a; }\r\n" +
                                      "p { color:grey; }\r\n";

    // Set a custom font folder path
    userAgentService.FontsSettings.SetFontsLookupFolder(Path.Combine(DataDir + "fonts"));

    // Initialize the HTML document with specified configuration
    using (HTMLDocument document = new HTMLDocument(Path.Combine(OutputDir, "user-agent-fontsetting.html"), configuration))
    {
        // Convert HTML to PDF
        Converter.ConvertHTML(document, new PdfSaveOptions(), Path.Combine(OutputDir, "user-agent-fontsetting_out.pdf"));
    }
}

Pour définir le dossier des polices à l’aide de la bibliothèque Aspose.HTML for .NET, nous utilisons la méthode SetFontsLookupFolder() de la classe FontsSettings. Cette méthode vous permet de spécifier le dossier dans lequel se trouvent les polices personnalisées. En définissant le dossier des polices, Aspose.HTML recherchera les polices dans le dossier spécifié lors du rendu du document HTML.

La figure illustre le résultat de l’application des propriétés FontsSettings et UserStyleSheet (b) au fichier source “user-agent-fontsetting.html” (a).

Service d’exécution – Runtime Service

Ce service vous permet de contrôler la durée de vie des processus internes. Par exemple, en utilisant IRuntimeService, vous pouvez spécifier des délais d’attente pour les JavaScripts. Il est important de disposer d’un tel délai au cas où un script contiendrait une boucle sans fin. L’extrait de code suivant montre comment utiliser les délais d’attente.

// Limit JavaScript execution time for HTML rendering using C#

// Prepare an HTML code and save it to a file
string code = "<h1>Runtime Service</h1>\r\n" +
              "<script> while(true) {} </script>\r\n" +
              "<p>The Runtime Service optimizes your system by helping it start apps and programs faster.</p>\r\n";

File.WriteAllText(Path.Combine(OutputDir, "runtime-service.html"), code);

// Create an instance of Configuration
using (Configuration configuration = new Configuration())
{
    // Limit JS execution time to 5 seconds
    IRuntimeService runtimeService = configuration.GetService<IRuntimeService>();
    runtimeService.JavaScriptTimeout = TimeSpan.FromSeconds(5);

    // Initialize an HTML document with specified configuration
    using (HTMLDocument document = new HTMLDocument(Path.Combine(OutputDir, "runtime-service.html"), configuration))
    {
        // Convert HTML to PNG
        Converter.ConvertHTML(document, new ImageSaveOptions(), Path.Combine(OutputDir, "runtime-service_out.png"));
    }
}

Service de réseau – Network Service

Aspose.HTML for .NET propose le INetworkService qui vous permet de contrôler tout le trafic entrant/sortant et de mettre en œuvre vos gestionnaires de messages personnalisés. Il peut être utilisé à différentes fins, telles que la création d’un mécanisme de mise en cache personnalisé, la traçabilité et l’enregistrement des messages de demande, etc.

Gestionnaires de messages – Message Handlers

L’exemple suivant montre comment créer un gestionnaire de messages personnalisé – LogMessageHandler – pour consigner des informations sur les ressources inaccessibles :

// Сustom network message handler to log HTTP errors during HTML processing

private class LogMessageHandler : MessageHandler
{
    private List<string> errors = new List<string>();

    public List<string> ErrorMessages
    {
        get { return errors; }
    }

    public override void Invoke(INetworkOperationContext context)
    {
        // Check whether response is OK
        if (context.Response.StatusCode != HttpStatusCode.OK)
        {
            // Set error information
            errors.Add(string.Format("File '{0}' Not Found", context.Request.RequestUri));
        }

        // Invoke the next message handler in the chain
        Next(context);
    }
}

L’extrait de code suivant montre comment utiliser la classe LogMessageHandler créée dans l’exemple précédent pour enregistrer des informations sur les ressources indisponibles.

// Log network errors during HTML processing using custom message handler in C#

// Prepare HTML code and save it to a file
string code = "<img src=\"https://docs.aspose.com/svg/net/drawing-basics/filters-and-gradients/park.jpg\" >\r\n" +
              "<img src=\"https://docs.aspose.com/html/net/missing1.jpg\" >\r\n" +
              "<img src=\"https://docs.aspose.com/html/net/missing2.jpg\" >\r\n";

File.WriteAllText(Path.Combine(OutputDir, "network-service.html"), code);

// Create an instance of Configuration
using (Configuration configuration = new Configuration())
{
    // Add the LogMessageHandler to the chain of existing message handlers
    INetworkService networkService = configuration.GetService<INetworkService>();

    LogMessageHandler logHandler = new LogMessageHandler();
    networkService.MessageHandlers.Add(logHandler);

    // Initialize an HTML document with specified configuration
    using (HTMLDocument document = new HTMLDocument(Path.Combine(OutputDir, "network-service.html"), configuration))
    {
        //Convert HTML to PNG
        Converter.ConvertHTML(document, new ImageSaveOptions(), Path.Combine(OutputDir, "network-service_out.png"));

        // Print the List of ErrorMessages
        foreach (string errorMessage in logHandler.ErrorMessages)
        {
            Console.WriteLine(errorMessage);
        }
    }
}

Après l’exécution de l’exemple :

• le fichier créé network-service.html sera converti en PNG. Le fichier PNG ne contient qu’une seule image ;
• la liste des messages d’erreur sera imprimée :

File 'https://docs.aspose.com/html/net/missing1.jpg' Not Found
File 'https://docs.aspose.com/html/net/missing2.jpg' Not Found

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