HtmlSaveOptions

HtmlSaveOptions class

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

Um mehr zu erfahren, besuchen Sie dieSpeicheroptionen festlegen Dokumentationsartikel.

public class HtmlSaveOptions : SaveOptions

Konstrukteure

Name	Beschreibung
HtmlSaveOptions()	Initialisiert eine neue Instanz dieser Klasse, die zum Speichern eines Dokuments imHtml format.
HtmlSaveOptions(SaveFormat)	Initialisiert eine neue Instanz dieser Klasse, die zum Speichern eines Dokuments imHtml ,Mhtml ,Epub , Azw3 oderMobi format.

Eigenschaften

Name	Beschreibung
AllowEmbeddingPostScriptFonts { get; set; }	Ruft einen booleschen Wert ab oder legt ihn fest, der angibt, ob das Einbetten von Schriftarten mit PostScript-Konturen beim Einbetten von TrueType-Schriftarten in ein Dokument beim Speichern zulässig ist. Der Standardwert ist`FALSCH` .
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 ist`FALSCH` .
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 im HTML-, MHTML- oder EPUB-Format 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. Der Standardwert ist eine leere Zeichenfolge.
CssStyleSheetType { get; set; }	Gibt an, wie CSS-Stile (Cascading Style Sheet) in 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 ab oder legt ihn fest (einschließlich Dateiname). Der Standardwert für diese Eigenschaft istleere Zeichenfolge (Empty ).
Dml3DEffectsRenderingMode { get; set; }	Ruft einen Wert ab oder legt ihn fest, der bestimmt, wie 3D-Effekte gerendert werden.
virtual DmlEffectsRenderingMode { get; set; }	Ruft einen Wert ab oder legt einen Wert fest, der bestimmt, wie DrawingML-Effekte gerendert werden.
DmlRenderingMode { get; set; }	Ruft einen Wert ab oder legt einen Wert 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 soll.Html , Epub oderAzw3 format. Standard istNone für HTML und HeadingParagraph für EPUB und AZW3.
DocumentSplitHeadingLevel { get; set; }	Gibt die maximale Überschriftenebene an, bei der das Dokument aufgeteilt werden soll. Der Standardwert ist`2` .
Encoding { get; set; }	Gibt die Kodierung an, die beim Exportieren in HTML, MHTML oder EPUB verwendet werden soll. Der Standardwert ist`neue UTF8-Kodierung (falsch)` (UTF-8 ohne BOM).
ExportCidUrlsForMhtmlResources { get; set; }	Gibt an, ob CID-URLs (Content-ID) zum Verweisen auf Ressourcen (Bilder, Schriftarten, CSS) in MHTML -Dokumenten verwendet werden sollen. Der Standardwert ist`FALSCH` .
ExportDocumentProperties { get; set; }	Gibt an, ob integrierte und benutzerdefinierte Dokumenteigenschaften in HTML, MHTML oder EPUB exportiert werden sollen. Der Standardwert ist`FALSCH` .
ExportDropDownFormFieldAsText { get; set; }	Steuert, wie Dropdown-Formularfelder in HTML oder MHTML gespeichert werden. Der Standardwert ist`FALSCH` .
ExportFontResources { get; set; }	Gibt an, ob Schriftressourcen in HTML, MHTML oder EPUB exportiert werden sollen. Standard ist`FALSCH` .
ExportFontsAsBase64 { get; set; }	Gibt an, ob Schriftartenressourcen in Base64-Kodierung in HTML eingebettet werden sollen. Standard ist`FALSCH` .
ExportGeneratorName { get; set; }	Wann`WAHR` , bewirkt, dass der Name und die Version von Aspose.Words in die erstellten Dateien eingebettet werden. Der Standardwert ist`WAHR` .
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 den Ausgabeformaten HTML, MHTML oder EPUB gespeichert werden. Standard ist`FALSCH` .
ExportLanguageInformation { get; set; }	Gibt an, ob Sprachinformationen in HTML, MHTML oder EPUB exportiert werden. Standard ist`FALSCH` .
ExportListLabels { get; set; }	Steuert, wie Listenbeschriftungen in HTML, MHTML oder EPUB ausgegeben werden. Der Standardwert istAuto .
ExportOriginalUrlForLinkedImages { get; set; }	Gibt an, ob die ursprüngliche URL als URL der verknüpften Bilder verwendet werden soll. Der Standardwert ist`FALSCH` .
ExportPageMargins { get; set; }	Gibt an, ob Seitenränder in HTML, MHTML oder EPUB exportiert werden. Standard ist`FALSCH` .
ExportPageSetup { get; set; }	Gibt an, ob die Seiteneinrichtung in HTML, MHTML oder EPUB exportiert wird. Standard ist`FALSCH` .
ExportRelativeFontSize { get; set; }	Gibt an, ob Schriftgrößen beim Speichern in HTML, MHTML oder EPUB in relativen Einheiten ausgegeben werden sollen. Standard ist`FALSCH` .
ExportRoundtripInformation { get; set; }	Gibt an, ob die Roundtrip-Informationen beim Speichern in HTML, MHTML oder EPUB geschrieben werden sollen. Der Standardwert ist`WAHR` für HTML und`FALSCH` für MHTML und EPUB.
ExportShapesAsSvg { get; set; }	Steuert, ob`Shape`Knoten werden beim Speichern in HTML, MHTML, EPUB oder AZW3 in SVG-Bilder konvertiert. Der Standardwert ist`FALSCH` .
ExportTextInputFormFieldAsText { get; set; }	Steuert, wie Texteingabeformularfelder in HTML oder MHTML gespeichert werden. Der Standardwert ist`FALSCH` .
ExportTocPageNumbers { get; set; }	Gibt an, ob beim Speichern von HTML, MHTML und EPUB Seitenzahlen in das Inhaltsverzeichnis geschrieben werden sollen. Der Standardwert ist`FALSCH` .
ExportXhtmlTransitional { get; set; }	Gibt an, ob die DOCTYPE-Deklaration beim Speichern in HTML oder MHTML geschrieben werden soll. Wenn`WAHR` , schreibt eine DOCTYPE-Deklaration in das Dokument vor dem Stammelement. Der Standardwert ist`FALSCH`. Beim Speichern im EPUB- oder HTML5-Format (Html5 ) wird immer die DOCTYPE -Deklaration geschrieben.
FontResourcesSubsettingSizeThreshold { get; set; }	Steuert, welche Schriftartressourcen beim Speichern in HTML, MHTML oder EPUB untergeordnet werden müssen. Standard ist`0` .
FontSavingCallback { get; set; }	Ermöglicht die Steuerung, wie Schriftarten gespeichert werden, wenn ein Dokument im HTML-, MHTML- oder EPUB-Format gespeichert wird.
FontsFolder { get; set; }	Gibt den physischen Ordner an, in dem Schriftarten beim Exportieren eines Dokuments nach HTML gespeichert werden. 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 im HTML- oder MHTML-Format verwendet werden soll. Der Standardwert istXhtml .
ImageResolution { get; set; }	Gibt die Ausgabeauflösung für Bilder beim Exportieren in HTML, MHTML oder EPUB an. Standard ist`96 dpi` .
ImageSavingCallback { get; set; }	Ermöglicht die Steuerung, wie Bilder gespeichert werden, wenn ein Dokument im HTML-, MHTML- oder EPUB-Format gespeichert wird.
ImagesFolder { get; set; }	Gibt den physischen Ordner an, in dem Bilder beim Exportieren eines Dokuments in das HTML-Format gespeichert werden. 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 einen Wert fest, der bestimmt, wie InkML-Objekte gerendert werden.
MemoryOptimization { get; set; }	Ruft einen Wert ab oder legt ihn fest, der bestimmt, ob vor dem Speichern des Dokuments eine Speicheroptimierung durchgeführt werden soll. Der Standardwert für diese Eigenschaft ist`FALSCH` .
MetafileFormat { get; set; }	Gibt an, in welchem Format Metadateien beim Exportieren in 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 Überschriftenebene an, die beim Export in die Formate EPUB, MOBI oder AZW3 in die Navigationskarte eingefügt wird. Der Standardwert ist`3` .
OfficeMathOutputMode { get; set; }	Steuert, wie OfficeMath-Objekte in HTML, MHTML oder EPUB exportiert werden. Der Standardwert istImage .
PrettyFormat { get; set; }	Wann`WAHR` , formatiert die Ausgabe, wo anwendbar. Der Standardwert ist`FALSCH` .
ProgressCallback { get; set; }	Wird beim Speichern eines Dokuments aufgerufen und akzeptiert Daten zum Speicherfortschritt.
RemoveJavaScriptFromLinks { get; set; }	Gibt an, ob JavaScript aus Links entfernt wird. Standard ist`FALSCH` .
ReplaceBackslashWithYenSign { get; set; }	Gibt an, ob Backslash-Zeichen durch Yen-Zeichen ersetzt werden sollen. Der Standardwert ist`FALSCH` .
ResolveFontNames { get; set; }	Gibt an, ob die im Dokument verwendeten Schriftfamiliennamen aufgelöst und ersetzt werden gemäß `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. Der Standardwert 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 von Aspose.Words beim Exportieren in HTML, MHTML oder EPUB auf die Größe der Begrenzungsform skaliert werden. Der Standardwert ist`WAHR` .
TableWidthOutputMode { get; set; }	Steuert, wie Tabellen-, Zeilen- und Zellenbreiten in HTML, MHTML oder EPUB exportiert werden. Der Standardwert istAll .
TempFolder { get; set; }	Gibt den Ordner für temporäre Dateien an, der beim Speichern in eine DOC- oder DOCX-Datei verwendet wird. Standardmäßig ist diese Eigenschaft`null` und es werden keine temporären Dateien verwendet.
UpdateAmbiguousTextFont { get; set; }	Bestimmt, ob die Schriftattribute entsprechend dem verwendeten Zeichencode geändert werden.
UpdateCreatedTimeProperty { get; set; }	Ruft einen Wert ab oder legt ihn fest, der bestimmt, ob die`CreatedTime` Eigenschaft wird vor dem Speichern aktualisiert. Der Standardwert ist`FALSCH` ;
UpdateFields { get; set; }	Ruft einen Wert ab oder legt einen Wert 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 ist`WAHR` .
UpdateLastPrintedProperty { get; set; }	Ruft einen Wert ab oder legt ihn fest, der bestimmt, ob die`LastPrinted` Eigenschaft wird vor dem Speichern aktualisiert.
UpdateLastSavedTimeProperty { get; set; }	Ruft einen Wert ab oder legt ihn fest, der bestimmt, ob die`LastSavedTime` Eigenschaft wird vor dem Speichern aktualisiert.
UseAntiAliasing { get; set; }	Ruft einen Wert ab oder legt einen Wert fest, der bestimmt, ob Anti-Aliasing zum Rendern verwendet werden soll oder nicht.
UseHighQualityRendering { get; set; }	Ruft einen Wert ab oder legt ihn fest, der bestimmt, ob qualitativ 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 Kodierung 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 Ausgabedokument im EPUB-Format 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 eine bestimmte Größe überschreiten.
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 ein Dokument in Teile aufgeteilt und gespeichert wird.

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 eine Ausgabe-HTML
    // Dokument mit dem gesamten Inhalt des Quelldokuments.
    // Setzen Sie die Eigenschaft "DocumentSplitCriteria" auf "DocumentSplitCriteria.SectionBreak" auf
    // 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 beim Speichern ein Dokument aufgeteilt wird.
/// </summary>
private class SavedDocumentPartRename : IDocumentPartSavingCallback
{
    public SavedDocumentPartRename(string outFileName, DocumentSplitCriteria documentSplitCriteria)
    {
        mOutFileName = outFileName;
        mDocumentSplitCriteria = documentSplitCriteria;
    }

    void IDocumentPartSavingCallback.DocumentPartSaving(DocumentPartSavingArgs args)
    {
        // Über die Eigenschaft „Dokument“ 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)}";

        // Unten finden Sie zwei Möglichkeiten, anzugeben, wo Aspose.Words jeden Teil des Dokuments speichern soll.
        // 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)}";

        // Unten finden Sie zwei Möglichkeiten, anzugeben, wo Aspose.Words jeden Teil des Dokuments speichern soll.
        // 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

HtmlOfficeMathOutputMode Enum HtmlVersion Enum