HtmlSaveOptions

HtmlSaveOptions class

Может использоваться для указания дополнительных параметров при сохранении документа в .Html ,Mhtml ,Epub , Azw3 илиMobi формат.

Чтобы узнать больше, посетитеУкажите параметры сохранения статья документации.

public class HtmlSaveOptions : SaveOptions

Конструкторы

Имя	Описание
HtmlSaveOptions()	Инициализирует новый экземпляр этого класса, который можно использовать для сохранения документа document вHtml формат.
HtmlSaveOptions(SaveFormat)	Инициализирует новый экземпляр этого класса, который можно использовать для сохранения документа document вHtml ,Mhtml ,Epub , Azw3 илиMobi формат.

Характеристики

Имя	Описание
AllowEmbeddingPostScriptFonts { get; set; }	Получает или задает логическое значение, указывающее, разрешено ли встраивание шрифтов PostScript в контуры PostScript при встраивании шрифтов TrueType в документ после его сохранения. Значение по умолчанию:ЛОЖЬ .
AllowNegativeIndent { get; set; }	Указывает, нормализуются ли отрицательные отступы слева и справа от абзацев при сохранении в HTML, MHTML или EPUB. Значение по умолчанию:ЛОЖЬ .
CssClassNamePrefix { get; set; }	Указывает префикс, который добавляется ко всем именам классов CSS. Значение по умолчанию — пустая строка, а сгенерированные имена классов CSS не имеют общего префикса.
CssSavingCallback { get; set; }	Позволяет контролировать сохранение стилей CSS при сохранении документа в HTML, MHTML или EPUB.
CssStyleSheetFileName { get; set; }	Указывает путь и имя файла каскадной таблицы стилей (CSS), записываемого при экспорте документа в HTML. По умолчанию — пустая строка.
CssStyleSheetType { get; set; }	Указывает, как стили CSS (каскадная таблица стилей) экспортируются в HTML, MHTML или EPUB. Значение по умолчанию:Inline для HTML/MHTML и External для EPUB.
CustomTimeZoneInfo { get; set; }	Получает или задает пользовательский часовой пояс, используемый для полей даты и времени.
DefaultTemplate { get; set; }	Получает или задает путь к шаблону по умолчанию (включая имя файла). Значение по умолчанию для этого свойства:пустая строка (Empty).
Dml3DEffectsRenderingMode { get; set; }	Получает или задает значение, определяющее способ визуализации 3D-эффектов.
virtual DmlEffectsRenderingMode { get; set; }	Получает или задает значение, определяющее способ визуализации эффектов DrawingML.
DmlRenderingMode { get; set; }	Получает или задает значение, определяющее способ отрисовки фигур DrawingML.
DocumentPartSavingCallback { get; set; }	Позволяет контролировать сохранение частей документа при сохранении документа в формате HTML или EPUB.
DocumentSplitCriteria { get; set; }	Указывает, как документ должен быть разделен при сохранении вHtml , Epub илиAzw3 формат. По умолчаниюNone для HTML и HeadingParagraph для EPUB и AZW3.
DocumentSplitHeadingLevel { get; set; }	Указывает максимальный уровень заголовков, по которому можно разделить документ. Значение по умолчанию:2 .
Encoding { get; set; }	Указывает кодировку, которая будет использоваться при экспорте в HTML, MHTML или EPUB. Значение по умолчанию:новая кодировка UTF8(ложь) (UTF-8 без спецификации).
ExportCidUrlsForMhtmlResources { get; set; }	Указывает, следует ли использовать URL-адреса CID (Content-ID) для ссылки на ресурсы (изображения, шрифты, CSS), включенные в документы MHTML . Значение по умолчанию:ЛОЖЬ .
ExportDocumentProperties { get; set; }	Указывает, экспортировать ли встроенные и пользовательские свойства документа в HTML, MHTML или EPUB. Значение по умолчанию:ЛОЖЬ .
ExportDropDownFormFieldAsText { get; set; }	Управляет сохранением полей раскрывающейся формы в формате HTML или MHTML. Значение по умолчанию:ЛОЖЬ .
ExportFontResources { get; set; }	Указывает, следует ли экспортировать ресурсы шрифтов в HTML, MHTML или EPUB. Значение по умолчанию:ЛОЖЬ .
ExportFontsAsBase64 { get; set; }	Указывает, должны ли ресурсы шрифтов быть встроены в HTML в кодировке Base64. Значение по умолчанию:ЛОЖЬ .
ExportGeneratorName { get; set; }	Когдаистинный , приводит к внедрению имени и версии Aspose.Words в создаваемые файлы. Значение по умолчанию:истинный .
ExportHeadersFootersMode { get; set; }	Указывает, как верхние и нижние колонтитулы выводятся в HTML, MHTML или EPUB. Значение по умолчанию:PerSection для HTML/MHTML иNone для EPUB.
ExportImagesAsBase64 { get; set; }	Указывает, сохраняются ли изображения в формате Base64 в выходной HTML, MHTML или EPUB. Значение по умолчанию:ЛОЖЬ .
ExportLanguageInformation { get; set; }	Указывает, экспортируется ли языковая информация в HTML, MHTML или EPUB. Значение по умолчанию:ЛОЖЬ .
ExportListLabels { get; set; }	Управляет выводом меток списка в HTML, MHTML или EPUB. Значение по умолчанию:Auto .
ExportOriginalUrlForLinkedImages { get; set; }	Указывает, следует ли использовать исходный URL-адрес в качестве URL-адреса связанных изображений. Значение по умолчанию:ЛОЖЬ .
ExportPageMargins { get; set; }	Указывает, экспортируются ли поля страницы в HTML, MHTML или EPUB. Значение по умолчанию:ЛОЖЬ .
ExportPageSetup { get; set; }	Указывает, экспортируются ли настройки страницы в HTML, MHTML или EPUB. Значение по умолчанию:ЛОЖЬ .
ExportRelativeFontSize { get; set; }	Указывает, должны ли размеры шрифта выводиться в относительных единицах при сохранении в HTML, MHTML или EPUB. Значение по умолчанию:ЛОЖЬ .
ExportRoundtripInformation { get; set; }	Указывает, следует ли записывать двустороннюю информацию при сохранении в HTML, MHTML или EPUB. Значение по умолчанию:истинный для HTML иЛОЖЬ для MHTML и EPUB.
ExportShapesAsSvg { get; set; }	Контролирует,Shapeузлы преобразуются в изображения SVG при сохранении в HTML, MHTML, EPUB или AZW3. Значение по умолчанию:ЛОЖЬ .
ExportTextInputFormFieldAsText { get; set; }	Управляет сохранением полей формы ввода текста в формате HTML или MHTML. Значение по умолчанию:ЛОЖЬ .
ExportTocPageNumbers { get; set; }	Указывает, записывать ли номера страниц в оглавление при сохранении HTML, MHTML и EPUB. Значение по умолчанию:ЛОЖЬ .
ExportXhtmlTransitional { get; set; }	Указывает, следует ли записывать объявление DOCTYPE при сохранении в HTML или MHTML. Когдаистинный , записывает объявление DOCTYPE в документ перед корневым элементом. Значение по умолчанию:ЛОЖЬ. При сохранении в EPUB или HTML5 (Html5 ) объявление DOCTYPE всегда записывается.
FontResourcesSubsettingSizeThreshold { get; set; }	Управляет тем, какие ресурсы шрифтов необходимо подмножество при сохранении в HTML, MHTML или EPUB. Значение по умолчанию:0 .
FontSavingCallback { get; set; }	Позволяет контролировать сохранение шрифтов при сохранении документа в формате HTML, MHTML или EPUB.
FontsFolder { get; set; }	Указывает физическую папку, в которой сохраняются шрифты при экспорте документа в HTML. По умолчанию — пустая строка.
FontsFolderAlias { get; set; }	Указывает имя папки, используемой для создания URI шрифтов, записанных в HTML-документ. По умолчанию — пустая строка.
HtmlVersion { get; set; }	Указывает версию стандарта HTML, которую следует использовать при сохранении документа в формате HTML или MHTML. Значение по умолчанию:Xhtml .
ImageResolution { get; set; }	Указывает выходное разрешение изображений при экспорте в HTML, MHTML или EPUB. Значение по умолчанию:96 точек на дюйм .
ImageSavingCallback { get; set; }	Позволяет контролировать сохранение изображений при сохранении документа в формате HTML, MHTML или EPUB.
ImagesFolder { get; set; }	Указывает физическую папку, в которой сохраняются изображения при экспорте документа в формат HTML. По умолчанию — пустая строка.
ImagesFolderAlias { get; set; }	Указывает имя папки, используемой для создания URI изображений, записанных в HTML-документ. По умолчанию — пустая строка.
ImlRenderingMode { get; set; }	Получает или задает значение, определяющее способ визуализации объектов рукописного ввода (InkML).
MemoryOptimization { get; set; }	Получает или задает значение, определяющее, следует ли выполнять оптимизацию памяти перед сохранением документа. Значение по умолчанию для этого свойства:ЛОЖЬ .
MetafileFormat { get; set; }	Указывает, в каком формате метафайлы сохраняются при экспорте в HTML, MHTML или EPUB. Значение по умолчанию:Png , что означает, что метафайлы преобразуются в растровые изображения PNG.
NavigationMapLevel { get; set; }	Указывает максимальный уровень заголовков, заполняемых на навигационной карте при экспорте в форматы EPUB, MOBI или AZW3 . Значение по умолчанию:3 .
OfficeMathOutputMode { get; set; }	Управляет экспортом объектов OfficeMath в HTML, MHTML или EPUB. Значение по умолчанию:Image .
PrettyFormat { get; set; }	Когдаистинный вывод в красивых форматах, где это применимо. Значение по умолчанию:ЛОЖЬ .
ProgressCallback { get; set; }	Вызывается при сохранении документа и принимает данные о ходе сохранения.
ResolveFontNames { get; set; }	Указывает, разрешаются ли и заменяются ли имена семейств шрифтов, используемые в документе, в соответствии с .FontSettings при записи в форматы на основе HTML.
ResourceFolder { get; set; }	Указывает физическую папку, в которой сохраняются все ресурсы, такие как изображения, шрифты и внешний CSS, когда document экспортируется в HTML. По умолчанию — пустая строка.
ResourceFolderAlias { get; set; }	Указывает имя папки, используемой для создания URI всех ресурсов, записанных в HTML-документ. Значение по умолчанию — пустая строка.
override SaveFormat { get; set; }	Указывает формат, в котором документ будет сохранен, если используется этот объект параметров сохранения. Может бытьHtml ,Mhtml ,Epub , Azw3 илиMobi .
ScaleImageToShapeSize { get; set; }	Указывает, масштабируются ли изображения с помощью Aspose.Words до размера ограничивающей фигуры при экспорте в HTML, MHTML или EPUB. Значение по умолчанию:истинный .
TableWidthOutputMode { get; set; }	Управляет экспортом ширины таблицы, строк и ячеек в HTML, MHTML или EPUB. Значение по умолчанию:All .
TempFolder { get; set; }	Указывает папку для временных файлов, используемых при сохранении в файл DOC или DOCX. По умолчанию это свойство имеет значениенулевой и никакие временные файлы не используются.
UpdateCreatedTimeProperty { get; set; }	Получает или задает значение, определяющее, будет лиCreatedTime свойство обновляется перед сохранением. Значение по умолчанию:ЛОЖЬ ;
UpdateFields { get; set; }	Получает или задает значение, определяющее, следует ли обновлять поля определенных типов перед сохранением документа в фиксированном формате страницы. Значение по умолчанию для этого свойства:истинный .
UpdateLastPrintedProperty { get; set; }	Получает или задает значение, определяющее, будет лиLastPrinted свойство обновляется перед сохранением.
UpdateLastSavedTimeProperty { get; set; }	Получает или задает значение, определяющее, будет лиLastSavedTime свойство обновляется перед сохранением.
UseAntiAliasing { get; set; }	Получает или задает значение, определяющее, использовать ли сглаживание для рендеринга.
UseHighQualityRendering { get; set; }	Получает или задает значение, определяющее, следует ли использовать алгоритмы высококачественного (т. е. медленного) рендеринга.

Примеры

Показывает, как указать папку для хранения связанных изображений после сохранения в .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);

// Установите опцию для экспорта полей формы в виде обычного текста вместо элементов ввода HTML.
HtmlSaveOptions options = new HtmlSaveOptions(SaveFormat.Html)
{
    ExportTextInputFormFieldAsText = true, 
    ImagesFolder = imagesDir
};

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

Показывает, как использовать определенную кодировку при сохранении документа в формате .epub.

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

// Используйте объект SaveOptions, чтобы указать кодировку документа, который мы сохраним.
HtmlSaveOptions saveOptions = new HtmlSaveOptions();
saveOptions.SaveFormat = SaveFormat.Epub;
saveOptions.Encoding = Encoding.UTF8;

// По умолчанию выходной документ .epub будет содержать все свое содержимое в одной HTML-части.
// Критерий разделения позволяет нам сегментировать документ на несколько частей HTML.
// Мы установим критерии для разделения документа на абзацы заголовков.
// Это полезно для читателей, которые не могут читать HTML-файлы, размер которых превышает определенный размер.
saveOptions.DocumentSplitCriteria = DocumentSplitCriteria.HeadingParagraph;

// Указываем, что хотим экспортировать свойства документа.
saveOptions.ExportDocumentProperties = true;

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

Показывает, как разделить документ на части и сохранить их.

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

    // Создаем объект HtmlFixedSaveOptions, который мы можем передать методу Save документа.
    // чтобы изменить способ преобразования документа в HTML.
    HtmlSaveOptions options = new HtmlSaveOptions();

    // Если мы сохраним документ как обычно, будет один выходной HTML
    // документ со всем содержимым исходного документа.
    // Установите для свойства DocumentSplitCriteria значение DocumentSplitCriteria.SectionBreak, чтобы
    // сохраняем наш документ в несколько HTML-файлов: по одному на каждый раздел.
    options.DocumentSplitCriteria = DocumentSplitCriteria.SectionBreak;

    // Назначаем пользовательский обратный вызов свойству «DocumentPartSavingCallback», чтобы изменить логику сохранения части документа.
    options.DocumentPartSavingCallback = new SavedDocumentPartRename(outFileName, options.DocumentSplitCriteria);

    // Если мы преобразуем документ, содержащий изображения, в HTML, мы получим один HTML-файл, который ссылается на несколько изображений.
    // Каждое изображение будет в виде файла в локальной файловой системе.
    // Существует также обратный вызов, который может настроить имя и расположение файловой системы каждого изображения.
    options.ImageSavingCallback = new SavedImageRename(outFileName);

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

/// <summary>
/// Устанавливает собственные имена файлов для выходных документов, на которые операция сохранения разбивает документ.
/// </summary>
private class SavedDocumentPartRename : IDocumentPartSavingCallback
{
    public SavedDocumentPartRename(string outFileName, DocumentSplitCriteria documentSplitCriteria)
    {
        mOutFileName = outFileName;
        mDocumentSplitCriteria = documentSplitCriteria;
    }

    void IDocumentPartSavingCallback.DocumentPartSaving(DocumentPartSavingArgs args)
    {
        // Мы можем получить доступ ко всему исходному документу через свойство «Документ».
        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)}";

        // Ниже приведены два способа указать, где Aspose.Words будет сохранять каждую часть документа.
        // 1 - Установить имя файла выходной части:
        args.DocumentPartFileName = partFileName;

        // 2 - Создать собственный поток для файла выходной части:
        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>
/// Устанавливает собственные имена файлов изображений, создаваемых преобразованием 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)}";

        // Ниже приведены два способа указать, где Aspose.Words будет сохранять каждую часть документа.
        // 1 - Установить имя файла выходного изображения:
        args.ImageFileName = imageFileName;

        // 2 — Создать собственный поток для выходного файла изображения:
        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;
}

Смотрите также

• class SaveOptions
• пространство имен Aspose.Words.Saving
• сборка Aspose.Words