HtmlSaveOptions

HtmlSaveOptions class

Kann verwendet werden, um beim Speichern eines Dokuments im zusätzliche Optionen anzugeben.Html ,Mhtml ,Epub , Azw3 oderMobi format.

Um mehr zu erfahren, besuchen Sie dieGeben Sie Speicheroptionen an Dokumentationsartikel.

public class HtmlSaveOptions : SaveOptions

Konstrukteure

NameBeschreibung
HtmlSaveOptions()Initialisiert eine neue Instanz dieser Klasse, die zum Speichern eines Dokuments im verwendet werden kannHtml format.
HtmlSaveOptions(SaveFormat)Initialisiert eine neue Instanz dieser Klasse, die zum Speichern eines Dokuments im verwendet werden kannHtml ,Mhtml ,Epub , Azw3 oderMobi format.

Eigenschaften

NameBeschreibung
AllowEmbeddingPostScriptFonts { get; set; }Ruft einen booleschen Wert ab oder legt diesen fest, der angibt, ob das Einbetten von Schriftarten mit PostScript-Umrissen zulässig ist , wenn TrueType-Schriftarten in ein Dokument eingebettet werden, sobald es gespeichert wird. Der Standardwert istFALSCH .
AllowNegativeIndent { get; set; }Gibt an, ob negative linke und rechte Einzüge von Absätzen beim Speichern in HTML, MHTML oder EPUB normalisiert werden. Der Standardwert istFALSCH .
CssClassNamePrefix { get; set; }Gibt ein Präfix an, das allen CSS-Klassennamen hinzugefügt wird. Der Standardwert ist eine leere Zeichenfolge und generierte CSS-Klassennamen haben kein gemeinsames Präfix.
CssSavingCallback { get; set; }Ermöglicht die Steuerung, wie CSS-Stile gespeichert werden, wenn ein Dokument in HTML, MHTML oder EPUB gespeichert wird.
CssStyleSheetFileName { get; set; }Gibt den Pfad und den Namen der Cascading Style Sheet (CSS)-Datei an, die geschrieben wird, wenn ein Dokument nach HTML exportiert wird. Standard ist eine leere Zeichenfolge.
CssStyleSheetType { get; set; }Gibt an, wie CSS-Stile (Cascading Style Sheet) nach HTML, MHTML oder EPUB exportiert werden. Der Standardwert istInline für HTML/MHTML und External für EPUB.
CustomTimeZoneInfo { get; set; }Ruft die benutzerdefinierte lokale Zeitzone ab, die für Datums-/Uhrzeitfelder verwendet wird, oder legt diese fest.
DefaultTemplate { get; set; }Ruft den Pfad zur Standardvorlage (einschließlich Dateiname) ab oder legt diesen fest. Der Standardwert für diese Eigenschaft istleerer String (Empty).
Dml3DEffectsRenderingMode { get; set; }Ruft einen Wert ab oder legt diesen fest, der bestimmt, wie 3D-Effekte gerendert werden.
virtual DmlEffectsRenderingMode { get; set; }Ruft einen Wert ab oder legt diesen fest, der bestimmt, wie DrawingML-Effekte gerendert werden.
DmlRenderingMode { get; set; }Ruft einen Wert ab oder legt diesen fest, der bestimmt, wie DrawingML-Formen gerendert werden.
DocumentPartSavingCallback { get; set; }Ermöglicht die Steuerung, wie Dokumentteile gespeichert werden, wenn ein Dokument im HTML- oder EPUB-Format gespeichert wird.
DocumentSplitCriteria { get; set; }Gibt an, wie das Dokument beim Speichern aufgeteilt werden sollHtml , Epub oderAzw3 Format. Standard istNone für HTML und HeadingParagraph für EPUB und AZW3.
DocumentSplitHeadingLevel { get; set; }Gibt die maximale Überschriftenebene an, auf der das Dokument geteilt werden soll. Der Standardwert ist2 .
Encoding { get; set; }Gibt die beim Exportieren nach HTML, MHTML oder EPUB zu verwendende Codierung an. Der Standardwert istneue UTF8Encoding(false) (UTF-8 ohne Stückliste).
ExportCidUrlsForMhtmlResources { get; set; }Gibt an, ob CID-URLs (Content-ID) zum Verweisen auf Ressourcen (Bilder, Schriftarten, CSS) verwendet werden sollen, die in MHTML -Dokumenten enthalten sind. Der Standardwert istFALSCH .
ExportDocumentProperties { get; set; }Gibt an, ob integrierte und benutzerdefinierte Dokumenteigenschaften nach HTML, MHTML oder EPUB exportiert werden sollen. Der Standardwert istFALSCH .
ExportDropDownFormFieldAsText { get; set; }Steuert, wie Dropdown-Formularfelder in HTML oder MHTML gespeichert werden. Der Standardwert istFALSCH .
ExportFontResources { get; set; }Gibt an, ob Schriftartressourcen nach HTML, MHTML oder EPUB exportiert werden sollen. Die Standardeinstellung istFALSCH .
ExportFontsAsBase64 { get; set; }Gibt an, ob Schriftartressourcen in Base64-Kodierung in HTML eingebettet werden sollen. Die Standardeinstellung istFALSCH .
ExportGeneratorName { get; set; }WannWAHR , bewirkt, dass der Name und die Version von Aspose.Words in erzeugte Dateien eingebettet werden. Der Standardwert istWAHR .
ExportHeadersFootersMode { get; set; }Gibt an, wie Kopf- und Fußzeilen in HTML, MHTML oder EPUB ausgegeben werden. Der Standardwert istPerSection für HTML/MHTML undNone für EPUB.
ExportImagesAsBase64 { get; set; }Gibt an, ob Bilder im Base64-Format in der Ausgabe-HTML, MHTML oder EPUB gespeichert werden. Standard istFALSCH .
ExportLanguageInformation { get; set; }Gibt an, ob Sprachinformationen nach HTML, MHTML oder EPUB exportiert werden. Standard istFALSCH .
ExportListLabels { get; set; }Steuert, wie Listenbeschriftungen in HTML, MHTML oder EPUB ausgegeben werden. Der Standardwert istAuto .
ExportOriginalUrlForLinkedImages { get; set; }Gibt an, ob die Original-URL als URL der verknüpften Bilder verwendet werden soll. Der Standardwert istFALSCH .
ExportPageMargins { get; set; }Gibt an, ob Seitenränder nach HTML, MHTML oder EPUB exportiert werden. Die Standardeinstellung istFALSCH .
ExportPageSetup { get; set; }Gibt an, ob die Seiteneinrichtung nach HTML, MHTML oder EPUB exportiert wird. Die Standardeinstellung istFALSCH .
ExportRelativeFontSize { get; set; }Gibt an, ob Schriftgrößen beim Speichern in HTML, MHTML oder EPUB in relativen Einheiten ausgegeben werden sollen. Standard istFALSCH .
ExportRoundtripInformation { get; set; }Gibt an, ob die Roundtrip-Informationen beim Speichern in HTML, MHTML oder EPUB geschrieben werden sollen. Der Standardwert istWAHR für HTML undFALSCH für MHTML und EPUB.
ExportShapesAsSvg { get; set; }Steuert, obShapeKnoten werden beim Speichern in HTML, MHTML, EPUB oder AZW3 in SVG-Bilder konvertiert. Der Standardwert istFALSCH .
ExportTextInputFormFieldAsText { get; set; }Steuert, wie Texteingabeformularfelder in HTML oder MHTML gespeichert werden. Der Standardwert istFALSCH .
ExportTocPageNumbers { get; set; }Gibt an, ob beim Speichern von HTML, MHTML und EPUB Seitenzahlen in das Inhaltsverzeichnis geschrieben werden sollen. Der Standardwert istFALSCH .
ExportXhtmlTransitional { get; set; }Gibt an, ob die DOCTYPE-Deklaration beim Speichern in HTML oder MHTML geschrieben werden soll. WannWAHR , schreibt eine DOCTYPE-Deklaration in das Dokument vor dem Wurzelelement. Der Standardwert istFALSCH. Beim Speichern in EPUB oder HTML5 (Html5 ) Die DOCTYPE -Deklaration wird immer geschrieben.
FontResourcesSubsettingSizeThreshold { get; set; }Steuert, welche Schriftartressourcen beim Speichern in HTML, MHTML oder EPUB untergeordnet werden müssen. Die Standardeinstellung ist0 .
FontSavingCallback { get; set; }Ermöglicht die Steuerung, wie Schriftarten gespeichert werden, wenn ein Dokument in HTML, MHTML oder EPUB gespeichert wird.
FontsFolder { get; set; }Gibt den physischen Ordner an, in dem Schriftarten gespeichert werden, wenn ein Dokument nach HTML exportiert wird. Der Standardwert ist eine leere Zeichenfolge.
FontsFolderAlias { get; set; }Gibt den Namen des Ordners an, der zum Erstellen von Schriftart-URIs verwendet wird, die in ein HTML-Dokument geschrieben werden. Der Standardwert ist eine leere Zeichenfolge.
HtmlVersion { get; set; }Gibt die Version des HTML-Standards an, die beim Speichern des Dokuments in HTML oder MHTML verwendet werden soll. Der Standardwert istXhtml .
ImageResolution { get; set; }Gibt die Ausgabeauflösung für Bilder beim Exportieren nach HTML, MHTML oder EPUB an. Die Standardeinstellung ist96 dpi .
ImageSavingCallback { get; set; }Ermöglicht die Steuerung, wie Bilder gespeichert werden, wenn ein Dokument in HTML, MHTML oder EPUB gespeichert wird.
ImagesFolder { get; set; }Gibt den physischen Ordner an, in dem Bilder gespeichert werden, wenn ein Dokument in das HTML-Format exportiert wird. Der Standardwert ist eine leere Zeichenfolge.
ImagesFolderAlias { get; set; }Gibt den Namen des Ordners an, der zum Erstellen von Bild-URIs verwendet wird, die in ein HTML-Dokument geschrieben werden. Der Standardwert ist eine leere Zeichenfolge.
ImlRenderingMode { get; set; }Ruft einen Wert ab oder legt diesen fest, der bestimmt, wie Ink-Objekte (InkML) gerendert werden.
MemoryOptimization { get; set; }Ruft einen Wert ab oder legt diesen fest, der bestimmt, ob vor dem Speichern des Dokuments eine Speicheroptimierung durchgeführt werden soll. Der Standardwert für diese Eigenschaft istFALSCH .
MetafileFormat { get; set; }Gibt an, in welchem Format Metadateien beim Exportieren nach HTML, MHTML oder EPUB gespeichert werden. Der Standardwert istPng , was bedeutet, dass Metadateien in Raster-PNG-Bilder gerendert werden.
NavigationMapLevel { get; set; }Gibt die maximale Anzahl von Überschriften an, die beim Export in die Formate EPUB, MOBI oder AZW3 in die Navigationskarte eingefügt werden. Der Standardwert ist3 .
OfficeMathOutputMode { get; set; }Steuert, wie OfficeMath-Objekte nach HTML, MHTML oder EPUB exportiert werden. Der Standardwert istImage .
PrettyFormat { get; set; }WannWAHR hübsche Ausgabeformate, sofern zutreffend. Der Standardwert istFALSCH .
ProgressCallback { get; set; }Wird beim Speichern eines Dokuments aufgerufen und akzeptiert Daten über den Speicherfortschritt.
ResolveFontNames { get; set; }Gibt an, ob im Dokument verwendete Schriftfamiliennamen gemäß aufgelöst und ersetzt werden.FontSettings beim Schreiben in HTML-basierte Formate.
ResourceFolder { get; set; }Gibt einen physischen Ordner an, in dem alle Ressourcen wie Bilder, Schriftarten und externes CSS gespeichert werden, wenn ein Dokument nach HTML exportiert wird. Standard ist eine leere Zeichenfolge.
ResourceFolderAlias { get; set; }Gibt den Namen des Ordners an, der zum Erstellen der URIs aller in ein HTML-Dokument geschriebenen Ressourcen verwendet wird. Der Standardwert ist eine leere Zeichenfolge.
override SaveFormat { get; set; }Gibt das Format an, in dem das Dokument gespeichert wird, wenn dieses Speicheroptionsobjekt verwendet wird. Kann seinHtml ,Mhtml ,Epub , Azw3 oderMobi .
ScaleImageToShapeSize { get; set; }Gibt an, ob Bilder beim Exportieren nach HTML, MHTML oder EPUB von Aspose.Words auf die Größe der Begrenzungsform skaliert werden. Der Standardwert istWAHR .
TableWidthOutputMode { get; set; }Steuert, wie Tabellen-, Zeilen- und Zellenbreiten nach HTML, MHTML oder EPUB exportiert werden. Der Standardwert istAll .
TempFolder { get; set; }Gibt den Ordner für temporäre Dateien an, die beim Speichern in einer DOC- oder DOCX-Datei verwendet werden. Standardmäßig ist diese EigenschaftNull und es werden keine temporären Dateien verwendet.
UpdateCreatedTimeProperty { get; set; }Ruft einen Wert ab oder legt ihn fest, der bestimmt, ob dieCreatedTime Die Eigenschaft wird vor dem Speichern aktualisiert. Der Standardwert istFALSCH ;
UpdateFields { get; set; }Ruft einen Wert ab oder legt diesen fest, der bestimmt, ob Felder bestimmter Typen aktualisiert werden sollen, bevor das Dokument in einem festen Seitenformat gespeichert wird. Der Standardwert für diese Eigenschaft istWAHR .
UpdateLastPrintedProperty { get; set; }Ruft einen Wert ab oder legt ihn fest, der bestimmt, ob dieLastPrinted Eigenschaft wird vor dem Speichern aktualisiert.
UpdateLastSavedTimeProperty { get; set; }Ruft einen Wert ab oder legt ihn fest, der bestimmt, ob dieLastSavedTime Eigenschaft wird vor dem Speichern aktualisiert.
UseAntiAliasing { get; set; }Ruft einen Wert ab oder legt diesen fest, der bestimmt, ob Anti-Aliasing für das Rendering verwendet werden soll oder nicht.
UseHighQualityRendering { get; set; }Ruft einen Wert ab oder legt diesen fest, der bestimmt, ob hochwertige (d. h. langsame) Rendering-Algorithmen verwendet werden sollen oder nicht.

Beispiele

Zeigt, wie der Ordner zum Speichern verknüpfter Bilder nach dem Speichern im HTML-Format angegeben wird.

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

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

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

Directory.CreateDirectory(imagesDir);

// Legen Sie eine Option fest, um Formularfelder als einfachen Text statt als HTML-Eingabeelemente zu exportieren.
HtmlSaveOptions options = new HtmlSaveOptions(SaveFormat.Html)
{
    ExportTextInputFormFieldAsText = true, 
    ImagesFolder = imagesDir
};

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

Zeigt, wie beim Speichern eines Dokuments im .epub-Format eine bestimmte Kodierung verwendet wird.

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

// Verwenden Sie ein SaveOptions-Objekt, um die Codierung für ein Dokument anzugeben, das wir speichern möchten.
HtmlSaveOptions saveOptions = new HtmlSaveOptions();
saveOptions.SaveFormat = SaveFormat.Epub;
saveOptions.Encoding = Encoding.UTF8;

// Standardmäßig enthält ein .epub-Ausgabedokument seinen gesamten Inhalt in einem HTML-Teil.
// Ein Split-Kriterium ermöglicht es uns, das Dokument in mehrere HTML-Teile zu segmentieren.
// Wir legen die Kriterien fest, um das Dokument in Überschriftenabsätze aufzuteilen.
// Dies ist nützlich für Leser, die keine HTML-Dateien lesen können, die größer als eine bestimmte Größe sind.
saveOptions.DocumentSplitCriteria = DocumentSplitCriteria.HeadingParagraph;

// Geben Sie an, dass wir Dokumenteigenschaften exportieren möchten.
saveOptions.ExportDocumentProperties = true;

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

Zeigt, wie man ein Dokument in Teile aufteilt und diese speichert.

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

    // Erstellen Sie ein „HtmlFixedSaveOptions“-Objekt, das wir an die „Save“-Methode des Dokuments übergeben können
    // um zu ändern, wie wir das Dokument in HTML konvertieren.
    HtmlSaveOptions options = new HtmlSaveOptions();

    // Wenn wir das Dokument normal speichern, gibt es ein Ausgabe-HTML
    // Dokument mit dem gesamten Inhalt des Quelldokuments.
    // Setzen Sie die Eigenschaft „DocumentSplitCriteria“ auf „DocumentSplitCriteria.SectionBreak“.
    // unser Dokument in mehreren HTML-Dateien speichern: eine für jeden Abschnitt.
    options.DocumentSplitCriteria = DocumentSplitCriteria.SectionBreak;

    // Weisen Sie der Eigenschaft „DocumentPartSavingCallback“ einen benutzerdefinierten Rückruf zu, um die Logik zum Speichern von Dokumentteilen zu ändern.
    options.DocumentPartSavingCallback = new SavedDocumentPartRename(outFileName, options.DocumentSplitCriteria);

    // Wenn wir ein Dokument, das Bilder enthält, in HTML konvertieren, erhalten wir am Ende eine HTML-Datei, die auf mehrere Bilder verweist.
    // Jedes Bild liegt in Form einer Datei im lokalen Dateisystem vor.
    // Es gibt auch einen Rückruf, mit dem der Name und der Dateisystemspeicherort jedes Bildes angepasst werden können.
    options.ImageSavingCallback = new SavedImageRename(outFileName);

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

/// <summary>
/// Legt benutzerdefinierte Dateinamen für Ausgabedokumente fest, in die der Speichervorgang ein Dokument aufteilt.
/// </summary>
private class SavedDocumentPartRename : IDocumentPartSavingCallback
{
    public SavedDocumentPartRename(string outFileName, DocumentSplitCriteria documentSplitCriteria)
    {
        mOutFileName = outFileName;
        mDocumentSplitCriteria = documentSplitCriteria;
    }

    void IDocumentPartSavingCallback.DocumentPartSaving(DocumentPartSavingArgs args)
    {
        // Über die Eigenschaft „Document“ können wir auf das gesamte Quelldokument zugreifen.
        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)}";

        // Nachfolgend finden Sie zwei Möglichkeiten, anzugeben, wo Aspose.Words jeden Teil des Dokuments speichert.
        // 1 – Legen Sie einen Dateinamen für die Ausgabeteildatei fest:
        args.DocumentPartFileName = partFileName;

        // 2 – Erstellen Sie einen benutzerdefinierten Stream für die Ausgabeteildatei:
        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>
/// Legt benutzerdefinierte Dateinamen für Bilddateien fest, die bei einer HTML-Konvertierung erstellt werden.
/// </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)}";

        // Nachfolgend finden Sie zwei Möglichkeiten, anzugeben, wo Aspose.Words jeden Teil des Dokuments speichert.
        // 1 – Legen Sie einen Dateinamen für die Ausgabebilddatei fest:
        args.ImageFileName = imageFileName;

        // 2 – Erstellen Sie einen benutzerdefinierten Stream für die Ausgabebilddatei:
        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;
}

Siehe auch