HtmlSaveOptions

HtmlSaveOptions class

Se puede utilizar para especificar opciones adicionales al guardar un documento en Html ,Mhtml ,Epub , Azw3 oMobi formato.

Para obtener más información, visite elEspecificar opciones de guardar artículo de documentación.

public class HtmlSaveOptions : SaveOptions

Constructores

NombreDescripción
HtmlSaveOptions()Inicializa una nueva instancia de esta clase que se puede utilizar para guardar un documento en elHtml formato.
HtmlSaveOptions(SaveFormat)Inicializa una nueva instancia de esta clase que se puede utilizar para guardar un documento en elHtml ,Mhtml ,Epub , Azw3 oMobi formato.

Propiedades

NombreDescripción
AllowEmbeddingPostScriptFonts { get; set; }Obtiene o establece un valor booleano que indica si se permite incrustar fuentes con contornos PostScript al incrustar fuentes TrueType en un documento una vez guardado. El valor predeterminado esFALSO .
AllowNegativeIndent { get; set; }Especifica si las sangrías negativas izquierda y derecha de los párrafos se normalizan al guardar en HTML, MHTML o EPUB. El valor predeterminado esFALSO .
CssClassNamePrefix { get; set; }Especifica un prefijo que se agrega a todos los nombres de clases CSS. El valor predeterminado es una cadena vacía y los nombres de clases CSS generados no tienen un prefijo común.
CssSavingCallback { get; set; }Permite controlar cómo se guardan los estilos CSS cuando un documento se guarda en HTML, MHTML o EPUB.
CssStyleSheetFileName { get; set; }Especifica la ruta y el nombre del archivo de hoja de estilos en cascada (CSS) escrito cuando un documento se exporta a HTML. El valor predeterminado es una cadena vacía.
CssStyleSheetType { get; set; }Especifica cómo se exportan los estilos CSS (Hoja de estilos en cascada) a HTML, MHTML o EPUB. El valor predeterminado esInline para HTML/MHTML y External para EPUB.
CustomTimeZoneInfo { get; set; }Obtiene o establece la zona horaria local personalizada utilizada para los campos de fecha/hora.
DefaultTemplate { get; set; }Obtiene o establece la ruta a la plantilla predeterminada (incluido el nombre del archivo). El valor predeterminado para esta propiedad escuerda vacía (Empty).
Dml3DEffectsRenderingMode { get; set; }Obtiene o establece un valor que determina cómo se representan los efectos 3D.
virtual DmlEffectsRenderingMode { get; set; }Obtiene o establece un valor que determina cómo se representan los efectos de DrawingML.
DmlRenderingMode { get; set; }Obtiene o establece un valor que determina cómo se representan las formas de DrawingML.
DocumentPartSavingCallback { get; set; }Permite controlar cómo se guardan las partes del documento cuando un documento se guarda en HTML o EPUB.
DocumentSplitCriteria { get; set; }Especifica cómo se debe dividir el documento al guardarlo enHtml , Epub oAzw3 formato. El valor predeterminado esNone para HTML y HeadingParagraph para EPUB y AZW3.
DocumentSplitHeadingLevel { get; set; }Especifica el nivel máximo de encabezados en los que dividir el documento. El valor predeterminado es2 .
Encoding { get; set; }Especifica la codificación que se utilizará al exportar a HTML, MHTML o EPUB. El valor predeterminado esnueva codificación UTF8 (falso) (UTF-8 sin lista de materiales).
ExportCidUrlsForMhtmlResources { get; set; }Especifica si se utilizan URL CID (ID de contenido) para hacer referencia a recursos (imágenes, fuentes, CSS) incluidos en documentos MHTML . El valor predeterminado esFALSO .
ExportDocumentProperties { get; set; }Especifica si se exportan las propiedades integradas y personalizadas del documento a HTML, MHTML o EPUB. El valor predeterminado esFALSO .
ExportDropDownFormFieldAsText { get; set; }Controla cómo se guardan los campos del formulario desplegable en HTML o MHTML. El valor predeterminado esFALSO .
ExportFontResources { get; set; }Especifica si los recursos de fuentes deben exportarse a HTML, MHTML o EPUB. El valor predeterminado esFALSO .
ExportFontsAsBase64 { get; set; }Especifica si los recursos de fuentes deben incrustarse en HTML en codificación Base64. El valor predeterminado esFALSO .
ExportGeneratorName { get; set; }cuandoverdadero , hace que el nombre y la versión de Aspose.Words se incrusten en los archivos producidos. El valor predeterminado esverdadero .
ExportHeadersFootersMode { get; set; }Especifica cómo se envían los encabezados y pies de página a HTML, MHTML o EPUB. El valor predeterminado esPerSection para HTML/MHTML yNone para EPUB.
ExportImagesAsBase64 { get; set; }Especifica si las imágenes se guardan en formato Base64 en el HTML, MHTML o EPUB de salida. El valor predeterminado esFALSO .
ExportLanguageInformation { get; set; }Especifica si la información del idioma se exporta a HTML, MHTML o EPUB. El valor predeterminado esFALSO .
ExportListLabels { get; set; }Controla cómo se envían las etiquetas de la lista a HTML, MHTML o EPUB. El valor predeterminado esAuto .
ExportOriginalUrlForLinkedImages { get; set; }Especifica si la URL original debe usarse como la URL de las imágenes vinculadas. El valor predeterminado esFALSO .
ExportPageMargins { get; set; }Especifica si los márgenes de la página se exportan a HTML, MHTML o EPUB. El valor predeterminado esFALSO .
ExportPageSetup { get; set; }Especifica si la configuración de la página se exporta a HTML, MHTML o EPUB. El valor predeterminado esFALSO .
ExportRelativeFontSize { get; set; }Especifica si los tamaños de fuente deben generarse en unidades relativas al guardar en HTML, MHTML o EPUB. El valor predeterminado esFALSO .
ExportRoundtripInformation { get; set; }Especifica si se escribe la información de ida y vuelta al guardar en HTML, MHTML o EPUB. El valor predeterminado esverdadero para HTML yFALSO para MHTML y EPUB.
ExportShapesAsSvg { get; set; }Controla siShapeLos nodos se convierten a imágenes SVG al guardar en HTML, MHTML, EPUB o AZW3. El valor predeterminado esFALSO .
ExportTextInputFormFieldAsText { get; set; }Controla cómo se guardan los campos del formulario de entrada de texto en HTML o MHTML. El valor predeterminado esFALSO .
ExportTocPageNumbers { get; set; }Especifica si se escriben los números de página en la tabla de contenido al guardar HTML, MHTML y EPUB. El valor predeterminado esFALSO .
ExportXhtmlTransitional { get; set; }Especifica si se escribe la declaración DOCTYPE al guardar en HTML o MHTML. Cuandoverdadero , escribe una declaración DOCTYPE en el documento antes del elemento raíz. El valor predeterminado esFALSO. Al guardar en EPUB o HTML5 (Html5 ) la declaración DOCTYPE siempre se escribe.
FontResourcesSubsettingSizeThreshold { get; set; }Controla qué recursos de fuentes necesitan subconjuntos al guardar en HTML, MHTML o EPUB. El valor predeterminado es0 .
FontSavingCallback { get; set; }Permite controlar cómo se guardan las fuentes cuando un documento se guarda en HTML, MHTML o EPUB.
FontsFolder { get; set; }Especifica la carpeta física donde se guardan las fuentes al exportar un documento a HTML. El valor predeterminado es una cadena vacía.
FontsFolderAlias { get; set; }Especifica el nombre de la carpeta utilizada para construir URI de fuentes escritas en un documento HTML. El valor predeterminado es una cadena vacía.
HtmlVersion { get; set; }Especifica la versión del estándar HTML que se debe usar al guardar el documento en HTML o MHTML. El valor predeterminado esXhtml .
ImageResolution { get; set; }Especifica la resolución de salida de las imágenes al exportar a HTML, MHTML o EPUB. El valor predeterminado es96 ppp .
ImageSavingCallback { get; set; }Permite controlar cómo se guardan las imágenes cuando un documento se guarda en HTML, MHTML o EPUB.
ImagesFolder { get; set; }Especifica la carpeta física donde se guardan las imágenes al exportar un documento a formato HTML. El valor predeterminado es una cadena vacía.
ImagesFolderAlias { get; set; }Especifica el nombre de la carpeta utilizada para construir URI de imágenes escritas en un documento HTML. El valor predeterminado es una cadena vacía.
ImlRenderingMode { get; set; }Obtiene o establece un valor que determina cómo se representan los objetos de tinta (InkML).
MemoryOptimization { get; set; }Obtiene o establece el valor que determina si se debe realizar la optimización de la memoria antes de guardar el documento. El valor predeterminado para esta propiedad esFALSO .
MetafileFormat { get; set; }Especifica en qué formato se guardan los metarchivos al exportar a HTML, MHTML o EPUB. El valor predeterminado esPng , lo que significa que los metarchivos se representan en imágenes PNG rasterizadas.
NavigationMapLevel { get; set; }Especifica el nivel máximo de encabezados completados en el mapa de navegación al exportar a formatos EPUB, MOBI o AZW3 . El valor predeterminado es3 .
OfficeMathOutputMode { get; set; }Controla cómo se exportan los objetos de OfficeMath a HTML, MHTML o EPUB. El valor predeterminado esImage .
PrettyFormat { get; set; }cuandoverdadero salida con bonitos formatos cuando corresponda. El valor predeterminado esFALSO .
ProgressCallback { get; set; }Se llama durante el guardado de un documento y acepta datos sobre el progreso del guardado.
ResolveFontNames { get; set; }Especifica si los nombres de familias de fuentes utilizados en el documento se resuelven y sustituyen de acuerdo con FontSettings cuando se escribe en formatos basados en HTML.
ResourceFolder { get; set; }Especifica una carpeta física donde se guardan todos los recursos como imágenes, fuentes y CSS externo cuando se exporta un documento a HTML. El valor predeterminado es una cadena vacía.
ResourceFolderAlias { get; set; }Especifica el nombre de la carpeta utilizada para construir los URI de todos los recursos escritos en un documento HTML. El valor predeterminado es una cadena vacía.
override SaveFormat { get; set; }Especifica el formato en el que se guardará el documento si se utiliza este objeto de opciones de guardado. Puede serHtml ,Mhtml ,Epub , Azw3 oMobi .
ScaleImageToShapeSize { get; set; }Especifica si Aspose.Words escala las imágenes al tamaño de la forma delimitadora al exportar a HTML, MHTML o EPUB. El valor predeterminado esverdadero .
TableWidthOutputMode { get; set; }Controla cómo se exportan los anchos de tablas, filas y celdas a HTML, MHTML o EPUB. El valor predeterminado esAll .
TempFolder { get; set; }Especifica la carpeta para archivos temporales utilizados al guardar en un archivo DOC o DOCX. De forma predeterminada, esta propiedad esnulo y no se utilizan archivos temporales.
UpdateCreatedTimeProperty { get; set; }Obtiene o establece un valor que determina si elCreatedTime La propiedad se actualiza antes de guardar. El valor predeterminado esFALSO ;
UpdateFields { get; set; }Obtiene o establece un valor que determina si los campos de ciertos tipos deben actualizarse antes de guardar el documento en un formato de página fijo. El valor predeterminado para esta propiedad esverdadero .
UpdateLastPrintedProperty { get; set; }Obtiene o establece un valor que determina si elLastPrinted la propiedad se actualiza antes de guardar.
UpdateLastSavedTimeProperty { get; set; }Obtiene o establece un valor que determina si elLastSavedTime la propiedad se actualiza antes de guardar.
UseAntiAliasing { get; set; }Obtiene o establece un valor que determina si se utiliza o no el suavizado para la representación.
UseHighQualityRendering { get; set; }Obtiene o establece un valor que determina si se utilizan o no algoritmos de renderizado de alta calidad (es decir, lentos).

Ejemplos

Muestra cómo especificar la carpeta para almacenar imágenes vinculadas después de guardarlas en .html.

Document doc = new Document(MyDir + "Rendering.docx");

string imagesDir = Path.Combine(ArtifactsDir, "SaveHtmlWithOptions");

if (Directory.Exists(imagesDir))
    Directory.Delete(imagesDir, true);

Directory.CreateDirectory(imagesDir);

// Establece una opción para exportar campos de formulario como texto sin formato en lugar de elementos de entrada HTML.
HtmlSaveOptions options = new HtmlSaveOptions(SaveFormat.Html)
{
    ExportTextInputFormFieldAsText = true, 
    ImagesFolder = imagesDir
};

doc.Save(ArtifactsDir + "HtmlSaveOptions.SaveHtmlWithOptions.html", options);

Muestra cómo utilizar una codificación específica al guardar un documento en .epub.

Document doc = new Document(MyDir + "Rendering.docx");

// Utilice un objeto SaveOptions para especificar la codificación de un documento que guardaremos.
HtmlSaveOptions saveOptions = new HtmlSaveOptions();
saveOptions.SaveFormat = SaveFormat.Epub;
saveOptions.Encoding = Encoding.UTF8;

// De forma predeterminada, un documento .epub de salida tendrá todo su contenido en una parte HTML.
// Un criterio de división nos permite segmentar el documento en varias partes HTML.
// Estableceremos los criterios para dividir el documento en párrafos de encabezado.
// Esto es útil para lectores que no pueden leer archivos HTML más grandes que un tamaño específico.
saveOptions.DocumentSplitCriteria = DocumentSplitCriteria.HeadingParagraph;

// Especificamos que queremos exportar las propiedades del documento.
saveOptions.ExportDocumentProperties = true;

doc.Save(ArtifactsDir + "HtmlSaveOptions.Doc2EpubSaveOptions.epub", saveOptions);

Muestra cómo dividir un documento en partes y guardarlas.

public void DocumentPartsFileNames()
{
    Document doc = new Document(MyDir + "Rendering.docx");
    string outFileName = "SavingCallback.DocumentPartsFileNames.html";

    // Crea un objeto "HtmlFixedSaveOptions", que podemos pasar al método "Guardar" del documento
    // para modificar cómo convertimos el documento a HTML.
    HtmlSaveOptions options = new HtmlSaveOptions();

    // Si guardamos el documento normalmente, habrá un HTML de salida
    // documento con todo el contenido del documento fuente.
    // Establece la propiedad "DocumentSplitCriteria" en "DocumentSplitCriteria.SectionBreak" para
    // guarda nuestro documento en varios archivos HTML: uno para cada sección.
    options.DocumentSplitCriteria = DocumentSplitCriteria.SectionBreak;

    // Asigne una devolución de llamada personalizada a la propiedad "DocumentPartSavingCallback" para modificar la lógica de guardado de partes del documento.
    options.DocumentPartSavingCallback = new SavedDocumentPartRename(outFileName, options.DocumentSplitCriteria);

    // Si convertimos un documento que contiene imágenes a html, terminaremos con un archivo html que enlaza con varias imágenes.
    // Cada imagen tendrá la forma de un archivo en el sistema de archivos local.
    // También hay una devolución de llamada que puede personalizar el nombre y la ubicación del sistema de archivos de cada imagen.
    options.ImageSavingCallback = new SavedImageRename(outFileName);

    doc.Save(ArtifactsDir + outFileName, options);
}

/// <summary>
/// Establece nombres de archivos personalizados para los documentos de salida en los que la operación de guardado divide un documento.
/// </summary>
private class SavedDocumentPartRename : IDocumentPartSavingCallback
{
    public SavedDocumentPartRename(string outFileName, DocumentSplitCriteria documentSplitCriteria)
    {
        mOutFileName = outFileName;
        mDocumentSplitCriteria = documentSplitCriteria;
    }

    void IDocumentPartSavingCallback.DocumentPartSaving(DocumentPartSavingArgs args)
    {
        // Podemos acceder al documento fuente completo a través de la propiedad "Documento".
        Assert.True(args.Document.OriginalFileName.EndsWith("Rendering.docx"));

        string partType = string.Empty;

        switch (mDocumentSplitCriteria)
        {
            case DocumentSplitCriteria.PageBreak:
                partType = "Page";
                break;
            case DocumentSplitCriteria.ColumnBreak:
                partType = "Column";
                break;
            case DocumentSplitCriteria.SectionBreak:
                partType = "Section";
                break;
            case DocumentSplitCriteria.HeadingParagraph:
                partType = "Paragraph from heading";
                break;
        }

        string partFileName = $"{mOutFileName} part {++mCount}, of type {partType}{Path.GetExtension(args.DocumentPartFileName)}";

        // A continuación se muestran dos formas de especificar dónde Aspose.Words guardará cada parte del documento.
        // 1 - Establece un nombre de archivo para el archivo de pieza de salida:
        args.DocumentPartFileName = partFileName;

        // 2 - Crea una secuencia personalizada para el archivo de pieza de salida:
        args.DocumentPartStream = new FileStream(ArtifactsDir + partFileName, FileMode.Create);

        Assert.True(args.DocumentPartStream.CanWrite);
        Assert.False(args.KeepDocumentPartStreamOpen);
    }

    private int mCount;
    private readonly string mOutFileName;
    private readonly DocumentSplitCriteria mDocumentSplitCriteria;
}

/// <summary>
/// Establece nombres de archivos personalizados para los archivos de imagen que crea una conversión HTML.
/// </summary>
public class SavedImageRename : IImageSavingCallback
{
    public SavedImageRename(string outFileName)
    {
        mOutFileName = outFileName;
    }

    void IImageSavingCallback.ImageSaving(ImageSavingArgs args)
    {
        string imageFileName = $"{mOutFileName} shape {++mCount}, of type {args.CurrentShape.ShapeType}{Path.GetExtension(args.ImageFileName)}";

        // A continuación se muestran dos formas de especificar dónde Aspose.Words guardará cada parte del documento.
        // 1 - Establece un nombre de archivo para el archivo de imagen de salida:
        args.ImageFileName = imageFileName;

        // 2 - Crea una secuencia personalizada para el archivo de imagen de salida:
        args.ImageStream = new FileStream(ArtifactsDir + imageFileName, FileMode.Create);

        Assert.True(args.ImageStream.CanWrite);
        Assert.True(args.IsImageAvailable);
        Assert.False(args.KeepImageStreamOpen);
    }

    private int mCount;
    private readonly string mOutFileName;
}

Ver también