HtmlSaveOptions

HtmlSaveOptions class

Peut être utilisé pour spécifier des options supplémentaires lors de l’enregistrement d’un document dans le Html ,Mhtml ,Epub , Azw3 ouMobi format.

Pour en savoir plus, visitez leSpécifier les options d’enregistrement article documentaire.

public class HtmlSaveOptions : SaveOptions

Constructeurs

NomLa description
HtmlSaveOptions()Initialise une nouvelle instance de cette classe qui peut être utilisée pour enregistrer un document dans leHtml format.
HtmlSaveOptions(SaveFormat)Initialise une nouvelle instance de cette classe qui peut être utilisée pour enregistrer un document dans leHtml ,Mhtml ,Epub , Azw3 ouMobi format.

Propriétés

NomLa description
AllowEmbeddingPostScriptFonts { get; set; }Obtient ou définit une valeur booléenne indiquant s’il faut autoriser l’incorporation de polices avec des contours PostScript lors de l’incorporation de polices TrueType dans un document lors de son enregistrement. La valeur par défaut estFAUX .
AllowNegativeIndent { get; set; }Spécifie si les retraits négatifs gauche et droit des paragraphes sont normalisés lors de l’enregistrement au format HTML, MHTML ou EPUB. La valeur par défaut estFAUX .
CssClassNamePrefix { get; set; }Spécifie un préfixe qui est ajouté à tous les noms de classe CSS. La valeur par défaut est une chaîne vide et les noms de classe CSS générés n’ont pas de préfixe commun.
CssSavingCallback { get; set; }Permet de contrôler la façon dont les styles CSS sont enregistrés lorsqu’un document est enregistré au format HTML, MHTML ou EPUB.
CssStyleSheetFileName { get; set; }Spécifie le chemin et le nom du fichier CSS (Cascading Style Sheet) écrit lorsqu’un document est exporté au format HTML. La valeur par défaut est une chaîne vide.
CssStyleSheetType { get; set; }Spécifie comment les styles CSS (Cascading Style Sheet) sont exportés vers HTML, MHTML ou EPUB. La valeur par défaut estInline pour HTML/MHTML et External pour EPUB.
CustomTimeZoneInfo { get; set; }Obtient ou définit le fuseau horaire local personnalisé utilisé pour les champs de date/heure.
DefaultTemplate { get; set; }Obtient ou définit le chemin d’accès au modèle par défaut (y compris le nom de fichier). La valeur par défaut de cette propriété estchaîne vide (Empty).
Dml3DEffectsRenderingMode { get; set; }Obtient ou définit une valeur déterminant la manière dont les effets 3D sont rendus.
virtual DmlEffectsRenderingMode { get; set; }Obtient ou définit une valeur déterminant la façon dont les effets DrawingML sont rendus.
DmlRenderingMode { get; set; }Obtient ou définit une valeur déterminant la façon dont les formes DrawingML sont rendues.
DocumentPartSavingCallback { get; set; }Permet de contrôler la manière dont les parties du document sont enregistrées lorsqu’un document est enregistré au format HTML ou EPUB.
DocumentSplitCriteria { get; set; }Spécifie comment le document doit être divisé lors de l’enregistrement surHtml , Epub ouAzw3 format. La valeur par défaut estNone pour HTML et HeadingParagraph pour EPUB et AZW3.
DocumentSplitHeadingLevel { get; set; }Spécifie le niveau maximum de titres auquel diviser le document. La valeur par défaut est2 .
Encoding { get; set; }Spécifie l’encodage à utiliser lors de l’exportation au format HTML, MHTML ou EPUB. La valeur par défaut estnouveau codage UTF8 (faux) (UTF-8 sans nomenclature).
ExportCidUrlsForMhtmlResources { get; set; }Spécifie s’il faut utiliser les URL CID (Content-ID) pour référencer les ressources (images, polices, CSS) incluses dans les documents MHTML . La valeur par défaut estFAUX .
ExportDocumentProperties { get; set; }Spécifie s’il faut exporter les propriétés du document intégré et personnalisé au format HTML, MHTML ou EPUB. La valeur par défaut estFAUX .
ExportDropDownFormFieldAsText { get; set; }Contrôle la façon dont les champs du formulaire déroulant sont enregistrés au format HTML ou MHTML. La valeur par défaut estFAUX .
ExportFontResources { get; set; }Spécifie si les ressources de polices doivent être exportées au format HTML, MHTML ou EPUB. La valeur par défaut estFAUX .
ExportFontsAsBase64 { get; set; }Spécifie si les ressources de polices doivent être intégrées au HTML dans l’encodage Base64. La valeur par défaut estFAUX .
ExportGeneratorName { get; set; }Quandvrai , entraîne l’intégration du nom et de la version d’Aspose.Words dans les fichiers produits. La valeur par défaut estvrai .
ExportHeadersFootersMode { get; set; }Spécifie comment les en-têtes et les pieds de page sont générés au format HTML, MHTML ou EPUB. La valeur par défaut estPerSection pour HTML/MHTML etNone pour EPUB.
ExportImagesAsBase64 { get; set; }Spécifie si les images sont enregistrées au format Base64 dans la sortie HTML, MHTML ou EPUB. La valeur par défaut estFAUX .
ExportLanguageInformation { get; set; }Spécifie si les informations de langue sont exportées au format HTML, MHTML ou EPUB. La valeur par défaut estFAUX .
ExportListLabels { get; set; }Contrôle la façon dont les étiquettes de liste sont sorties au format HTML, MHTML ou EPUB. La valeur par défaut estAuto .
ExportOriginalUrlForLinkedImages { get; set; }Spécifie si l’URL d’origine doit être utilisée comme URL des images liées. La valeur par défaut estFAUX .
ExportPageMargins { get; set; }Spécifie si les marges de la page sont exportées au format HTML, MHTML ou EPUB. La valeur par défaut estFAUX .
ExportPageSetup { get; set; }Spécifie si la mise en page est exportée au format HTML, MHTML ou EPUB. La valeur par défaut estFAUX .
ExportRelativeFontSize { get; set; }Spécifie si les tailles de police doivent être affichées en unités relatives lors de l’enregistrement au format HTML, MHTML ou EPUB. La valeur par défaut estFAUX .
ExportRoundtripInformation { get; set; }Spécifie s’il faut écrire les informations aller-retour lors de l’enregistrement au format HTML, MHTML ou EPUB. La valeur par défaut estvrai pour HTML etFAUX pour MHTML et EPUB.
ExportShapesAsSvg { get; set; }Contrôle siShapeles nœuds sont convertis en images SVG lors de la sauvegarde de au format HTML, MHTML, EPUB ou AZW3. La valeur par défaut estFAUX .
ExportTextInputFormFieldAsText { get; set; }Contrôle la façon dont les champs du formulaire de saisie de texte sont enregistrés au format HTML ou MHTML. La valeur par défaut estFAUX .
ExportTocPageNumbers { get; set; }Spécifie s’il faut écrire les numéros de page dans la table des matières lors de l’enregistrement HTML, MHTML et EPUB. La valeur par défaut estFAUX .
ExportXhtmlTransitional { get; set; }Spécifie s’il faut écrire la déclaration DOCTYPE lors de l’enregistrement au format HTML ou MHTML. Quandvrai , écrit une déclaration DOCTYPE dans le document avant l’élément racine. La valeur par défaut estFAUX. Lors de l’enregistrement au format EPUB ou HTML5 (Html5 ) la déclaration DOCTYPE est toujours écrite.
FontResourcesSubsettingSizeThreshold { get; set; }Contrôle quelles ressources de police nécessitent des sous-ensembles lors de l’enregistrement au format HTML, MHTML ou EPUB. La valeur par défaut est0 .
FontSavingCallback { get; set; }Permet de contrôler la façon dont les polices sont enregistrées lorsqu’un document est enregistré au format HTML, MHTML ou EPUB.
FontsFolder { get; set; }Spécifie le dossier physique dans lequel les polices sont enregistrées lors de l’exportation d’un document au format HTML. La valeur par défaut est une chaîne vide.
FontsFolderAlias { get; set; }Spécifie le nom du dossier utilisé pour construire les URI de police écrits dans un document HTML. La valeur par défaut est une chaîne vide.
HtmlVersion { get; set; }Spécifie la version du standard HTML qui doit être utilisée lors de l’enregistrement du document au format HTML ou MHTML. La valeur par défaut estXhtml .
ImageResolution { get; set; }Spécifie la résolution de sortie des images lors de l’exportation au format HTML, MHTML ou EPUB. La valeur par défaut est96 ppp .
ImageSavingCallback { get; set; }Permet de contrôler la façon dont les images sont enregistrées lorsqu’un document est enregistré au format HTML, MHTML ou EPUB.
ImagesFolder { get; set; }Spécifie le dossier physique dans lequel les images sont enregistrées lors de l’exportation d’un document au format HTML. La valeur par défaut est une chaîne vide.
ImagesFolderAlias { get; set; }Spécifie le nom du dossier utilisé pour construire les URI d’image écrits dans un document HTML. La valeur par défaut est une chaîne vide.
ImlRenderingMode { get; set; }Obtient ou définit une valeur déterminant la manière dont les objets Ink (InkML) sont rendus.
MemoryOptimization { get; set; }Obtient ou définit la valeur déterminant si l’optimisation de la mémoire doit être effectuée avant d’enregistrer le document. La valeur par défaut de cette propriété estFAUX .
MetafileFormat { get; set; }Spécifie dans quel format les métafichiers sont enregistrés lors de l’exportation au format HTML, MHTML ou EPUB. La valeur par défaut estPng , ce qui signifie que les métafichiers sont rendus sous forme d’images PNG raster.
NavigationMapLevel { get; set; }Spécifie le niveau maximum de titres renseignés sur la carte de navigation lors de l’exportation aux formats EPUB, MOBI ou AZW3 . La valeur par défaut est3 .
OfficeMathOutputMode { get; set; }Contrôle la manière dont les objets OfficeMath sont exportés au format HTML, MHTML ou EPUB. La valeur par défaut estImage .
PrettyFormat { get; set; }Quandvrai jolis formats de sortie le cas échéant. La valeur par défaut estFAUX .
ProgressCallback { get; set; }Appelé lors de l’enregistrement d’un document et accepte les données sur la progression de l’enregistrement.
ResolveFontNames { get; set; }Spécifie si les noms de familles de polices utilisés dans le document sont résolus et remplacés conformément à FontSettings lors de l’écriture dans des formats HTML.
ResourceFolder { get; set; }Spécifie un dossier physique dans lequel toutes les ressources telles que les images, les polices et les CSS externes sont enregistrées lorsqu’un document est exporté au format HTML. La valeur par défaut est une chaîne vide.
ResourceFolderAlias { get; set; }Spécifie le nom du dossier utilisé pour construire les URI de toutes les ressources écrites dans un document HTML. La valeur par défaut est une chaîne vide.
override SaveFormat { get; set; }Spécifie le format dans lequel le document sera enregistré si cet objet d’options de sauvegarde est utilisé. Peut êtreHtml ,Mhtml ,Epub , Azw3 ouMobi .
ScaleImageToShapeSize { get; set; }Spécifie si les images sont mises à l’échelle par Aspose.Words à la taille de la forme englobante lors de l’exportation au format HTML, MHTML ou EPUB. La valeur par défaut estvrai .
TableWidthOutputMode { get; set; }Contrôle la façon dont les largeurs des tableaux, des lignes et des cellules sont exportées au format HTML, MHTML ou EPUB. La valeur par défaut estAll .
TempFolder { get; set; }Spécifie le dossier des fichiers temporaires utilisé lors de l’enregistrement dans un fichier DOC ou DOCX. Par défaut, cette propriété estnul et aucun fichier temporaire n’est utilisé.
UpdateCreatedTimeProperty { get; set; }Obtient ou définit une valeur déterminant si leCreatedTime la propriété est mise à jour avant l’enregistrement. La valeur par défaut estFAUX ;
UpdateFields { get; set; }Obtient ou définit une valeur déterminant si les champs de certains types doivent être mis à jour avant d’enregistrer le document dans un format de page fixe. La valeur par défaut de cette propriété estvrai .
UpdateLastPrintedProperty { get; set; }Obtient ou définit une valeur déterminant si leLastPrinted la propriété est mise à jour avant l’enregistrement.
UpdateLastSavedTimeProperty { get; set; }Obtient ou définit une valeur déterminant si leLastSavedTime la propriété est mise à jour avant l’enregistrement.
UseAntiAliasing { get; set; }Obtient ou définit une valeur déterminant s’il faut ou non utiliser l’anticrénelage pour le rendu.
UseHighQualityRendering { get; set; }Obtient ou définit une valeur déterminant s’il faut ou non utiliser des algorithmes de rendu de haute qualité (c’est-à-dire lents).

Exemples

Montre comment spécifier le dossier dans lequel stocker les images liées après leur enregistrement au format .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);

// Définissez une option pour exporter les champs de formulaire sous forme de texte brut au lieu d'éléments d'entrée HTML.
HtmlSaveOptions options = new HtmlSaveOptions(SaveFormat.Html)
{
    ExportTextInputFormFieldAsText = true, 
    ImagesFolder = imagesDir
};

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

Montre comment utiliser un encodage spécifique lors de l’enregistrement d’un document au format .epub.

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

// Utilisez un objet SaveOptions pour spécifier l'encodage d'un document que nous allons enregistrer.
HtmlSaveOptions saveOptions = new HtmlSaveOptions();
saveOptions.SaveFormat = SaveFormat.Epub;
saveOptions.Encoding = Encoding.UTF8;

// Par défaut, un document de sortie .epub aura tout son contenu dans une seule partie HTML.
// Un critère de split permet de segmenter le document en plusieurs parties HTML.
// Nous définirons les critères pour diviser le document en paragraphes de titre.
// Ceci est utile pour les lecteurs qui ne peuvent pas lire des fichiers HTML d'une taille supérieure à une taille spécifique.
saveOptions.DocumentSplitCriteria = DocumentSplitCriteria.HeadingParagraph;

// Spécifie que nous souhaitons exporter les propriétés du document.
saveOptions.ExportDocumentProperties = true;

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

Montre comment diviser un document en parties et les enregistrer.

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

    // Crée un objet "HtmlFixedSaveOptions", que l'on peut passer à la méthode "Save" du document
    // pour modifier la façon dont nous convertissons le document en HTML.
    HtmlSaveOptions options = new HtmlSaveOptions();

    // Si nous enregistrons le document normalement, il y aura une sortie HTML
    // document avec tout le contenu du document source.
    // Définissez la propriété "DocumentSplitCriteria" sur "DocumentSplitCriteria.SectionBreak" pour
    // enregistre notre document dans plusieurs fichiers HTML : un pour chaque section.
    options.DocumentSplitCriteria = DocumentSplitCriteria.SectionBreak;

    // Attribuez un rappel personnalisé à la propriété "DocumentPartSavingCallback" pour modifier la logique d'enregistrement des parties du document.
    options.DocumentPartSavingCallback = new SavedDocumentPartRename(outFileName, options.DocumentSplitCriteria);

    // Si nous convertissons un document contenant des images en HTML, nous nous retrouverons avec un fichier HTML qui renvoie à plusieurs images.
    // Chaque image sera sous la forme d'un fichier dans le système de fichiers local.
    // Il existe également un rappel qui permet de personnaliser le nom et l'emplacement du système de fichiers de chaque image.
    options.ImageSavingCallback = new SavedImageRename(outFileName);

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

/// <summary>
/// Définit des noms de fichiers personnalisés pour les documents de sortie dans lesquels l'opération d'enregistrement divise un document.
/// </summary>
private class SavedDocumentPartRename : IDocumentPartSavingCallback
{
    public SavedDocumentPartRename(string outFileName, DocumentSplitCriteria documentSplitCriteria)
    {
        mOutFileName = outFileName;
        mDocumentSplitCriteria = documentSplitCriteria;
    }

    void IDocumentPartSavingCallback.DocumentPartSaving(DocumentPartSavingArgs args)
    {
        // On peut accéder à l'intégralité du document source via la propriété "Document".
        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)}";

        // Vous trouverez ci-dessous deux manières de spécifier où Aspose.Words enregistrera chaque partie du document.
        // 1 - Définissez un nom de fichier pour le fichier pièce de sortie :
        args.DocumentPartFileName = partFileName;

        // 2 - Créez un flux personnalisé pour le fichier pièce de sortie :
        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>
/// Définit des noms de fichiers personnalisés pour les fichiers image créés par une conversion 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)}";

        // Vous trouverez ci-dessous deux manières de spécifier où Aspose.Words enregistrera chaque partie du document.
        // 1 - Définissez un nom de fichier pour le fichier image de sortie :
        args.ImageFileName = imageFileName;

        // 2 - Créez un flux personnalisé pour le fichier image de sortie :
        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;
}

Voir également