Configuración del entorno – C#

A menudo resulta útil tener diferentes configuraciones según el entorno donde se ejecuta la aplicación. Por ejemplo, es posible que desee configurar la política de secuencias de comandos, anular el estilo del documento aplicando una hoja de estilo de usuario personalizada o manejar cualquier solicitud web desde la aplicación. Aspose.HTML for .NET proporciona la clase Configuration que se puede usar exactamente para estos propósitos.

Zona de arena – Sandbox

Un conjunto de banderas de espacio aislado es un conjunto de cero o más banderas, que se utilizan para restringir las capacidades de recursos potencialmente no confiables. El atributo Sandbox le permite establecer una serie de restricciones sobre el contenido cargado en el marco, por ejemplo, bloquear formularios y scripts. Esto mejora la seguridad del documento actual, especialmente cuando un documento se carga en el marco desde una fuente no verificada.

El siguiente ejemplo demuestra cómo marcar Scripts como un recurso que no es de confianza. Como resultado, los Scripts se desactivarán durante la ejecución de la aplicación.

// Prepare HTML code and save it to a file
var 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 (var configuration = new Configuration())
{
    // Mark 'scripts' as an untrusted resource
    configuration.Security |= Sandbox.Scripts;

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

Servicios – Services

Todas las funciones importantes se agrupan en servicios separados por motivos de usabilidad y se ubican en el espacio de nombres Aspose.Html.Services.

Servicio de agente de usuario – User Agent Service

El User Agent Service le permite especificar una hoja de estilo de usuario personalizada, un conjunto de caracteres principal para el documento, el idioma y la configuración de fuentes. Puede especificar su información de estilo personalizada para un documento en particular y proporcionar tantos o tan pequeños cambios de configuración del entorno como sea necesario. La interfaz IUserAgentService describe un entorno de agente de usuario.

Hoja de estilo de usuario – User Style Sheet

El usuario puede especificar información de estilo personalizada para un documento en particular. Esta información se aplica al documento de acuerdo con las cascading rules y puede afectar la presentación del documento. El siguiente fragmento de código muestra cómo utilizar la propiedad UserStyleSheet:

// Prepare HTML code and save it to a file
var 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 (var configuration = new Configuration())
{
    // Get the IUserAgentService
    var 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 (var 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"));
    }
}

Conjunto de caracteres – Character Set

La propiedad CharSet establece el juego de caracteres principal de un documento. Para analizar y mostrar un documento HTML correctamente, la aplicación debe saber qué conjunto de caracteres (codificación) se utiliza para el documento. Si la codificación de caracteres no se especifica directamente en el encabezado del documento, Aspose.HTML for .NET usa UTF-8, que se define como el valor predeterminado para la especificación HTML5. Sin embargo, si está seguro de que su documento HTML está escrito con una codificación diferente a la UTF-8, puede especificarla manualmente, como se indica a continuación.

// Prepare HTML code and save it to a file
var 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 (var configuration = new Configuration())
{
    // Get the IUserAgentService
    var 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 (var 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"));
    }
}

En el ejemplo anterior, hemos utilizado las propiedades CharSet y UserStyleSheet para configurar la codificación ISO-8859-1 y un estilo de usuario.

Instalar carpeta de fuentes

Aspose.HTML for .NET es una potente biblioteca para trabajar con documentos HTML en aplicaciones .NET. Proporciona una amplia gama de funciones que permiten a los desarrolladores representar documentos HTML en varios formatos de salida, como PDF, XPS, DOCX e imágenes. Una de las características clave de Aspose.HTML es su capacidad para trabajar con fuentes personalizadas, lo que permite a los desarrolladores agregar sus propias fuentes al proceso de renderizado.

La propiedad FontsSettings se utiliza para la configuración del manejo de fuentes. Para una situación en la que necesite utilizar fuentes personalizadas en lugar de las fuentes instaladas en el sistema operativo, puede establecer la ruta a su carpeta personalizada, como se muestra en el siguiente fragmento de código:

// Prepare HTML code and save it to a file
var 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 (var configuration = new Configuration())
{
    // Get the IUserAgentService
    var 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 (var 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"));
    }
}

Para configurar la carpeta de fuentes usando la biblioteca Aspose.HTML for .NET, usamos el método SetFontsLookupFolder() de la clase FontsSettings. Este método le permite especificar la carpeta donde se encuentran las fuentes personalizadas. Al configurar la carpeta de fuentes, Aspose.HTML buscará fuentes en la carpeta especificada al representar el documento HTML.

La figura ilustra el resultado de las propiedades FontsSettings y UserStyleSheet aplicando (b) al archivo fuente “user-agent-fontsetting.html” (a).

Servicio de tiempo de ejecución – Runtime Service

Este servicio le brinda control sobre la vida útil de los procesos internos. Por ejemplo, utilizando IRuntimeService puede especificar tiempos de espera para JavaScripts. Es importante tener dicho tiempo de espera en caso de que un script contenga un bucle sin fin. El siguiente fragmento de código demuestra cómo utilizar los tiempos de espera.

// Prepare an HTML code and save it to a file
var 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 (var configuration = new Configuration())
{
    // Limit JS execution time to 5 seconds
    var runtimeService = configuration.GetService<IRuntimeService>();
    runtimeService.JavaScriptTimeout = TimeSpan.FromSeconds(5);

    // Initialize an HTML document with specified configuration
    using (var 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"));
    }
}

Servicio de red – Network Service

Aspose.HTML for .NET ofrece INetworkService que le permite controlar todo el tráfico entrante/saliente e implementar sus controladores de mensajes personalizados. Se puede utilizar para diferentes propósitos, tales como: crear un mecanismo de almacenamiento en caché personalizado, mensajes de solicitud de seguimiento/registro, etc.

Controladores de mensajes – Message Handlers

El siguiente ejemplo demuestra cómo crear un controlador de mensajes personalizado (LogMessageHandler) para registrar información sobre recursos inaccesibles:

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

El siguiente fragmento de código demuestra cómo utilizar la clase LogMessageHandler creada en el ejemplo anterior para registrar información sobre recursos no disponibles.

// Prepare HTML code and save it to a file
var 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 (var configuration = new Configuration())
{
    // Add the LogMessageHandler to the chain of existing message handlers
    var networkService = configuration.GetService<INetworkService>();

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

    // Initialize an HTML document with specified configuration
    using (var 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);
        }
    }               
}

Después de ejecutar el ejemplo:

• el archivo creado network-service.html se convertirá a PNG. Sólo hay una imagen en el archivo PNG;
• Se imprimirá la Lista de mensajes de error:

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

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