Aspose::Words::Saving::HtmlSaveOptions class

HtmlSaveOptions class

Можно использовать для указания дополнительных параметров при сохранении документа в форматы Html, Mhtml, Epub, Azw3 или Mobi. Чтобы узнать больше, посетите статью документации Specify Save Options.

class HtmlSaveOptions : public Aspose::Words::Saving::SaveOptions

Методы

МетодОписание
static CreateSaveOptions(Aspose::Words::SaveFormat)Создаёт объект параметров сохранения класса, подходящего для указанного формата сохранения.
static CreateSaveOptions(const System::String&)Создаёт объект параметров сохранения класса, подходящего для расширения файла, указанного в данном имени файла.
get_AllowEmbeddingPostScriptFonts() constПолучает или задаёт логическое значение, указывающее, разрешено ли встраивание шрифтов с контурами PostScript при встраивании TrueType‑шрифтов в документ при его сохранении. Значение по умолчанию — false.
get_AllowNegativeIndent() constУказывает, нормализуются ли отрицательные левый и правый отступы абзацев при сохранении в форматы HTML, MHTML или EPUB. Значение по умолчанию — false.
get_CssClassNamePrefix() constУказывает префикс, который добавляется ко всем именам CSS‑классов. Значение по умолчанию — пустая строка, и сгенерированные имена CSS‑классов не имеют общего префикса.
get_CssSavingCallback() constПозволяет управлять тем, как сохраняются стили CSS при сохранении документа в HTML, MHTML или EPUB.
get_CssStyleSheetFileName() constУказывает путь и имя каскадного Style листа (CSS), записываемого при экспорте документа в HTML. По умолчанию — пустая строка.
get_CssStyleSheetType() constУказывает, как стили CSS (каскадный Style лист) экспортируются в HTML, MHTML или EPUB. Значение по умолчанию — Inline для HTML/MHTML и External для EPUB.
get_CustomTimeZoneInfo() constПолучает или задает пользовательский локальный часовой пояс, используемый для полей даты/времени.
get_DefaultTemplate() constПолучает или задает путь к шаблону по умолчанию (включая имя файла). Значение по умолчанию для этого свойства — empty string.
get_Dml3DEffectsRenderingMode() constПолучает значение, определяющее, как рендерятся 3D‑эффекты.
virtual get_DmlEffectsRenderingMode()Получает или задает значение, определяющее, как рендерятся эффекты DrawingML.
get_DmlRenderingMode() constПолучает или задает значение, определяющее, как рендерятся фигуры DrawingML.
get_DocumentPartSavingCallback() constПозволяет управлять тем, как части документа сохраняются при сохранении документа в HTML или EPUB.
get_DocumentSplitCriteria() constУказывает, как документ должен быть разбит при сохранении в формат Html, Epub или Azw3. По умолчанию — None для HTML и HeadingParagraph для EPUB и AZW3.
get_DocumentSplitHeadingLevel() constУказывает максимальный уровень заголовков, при котором документ разбивается. Значение по умолчанию — %2.
get_Encoding() constУказывает кодировку, используемую при экспорте в HTML, MHTML или EPUB. Значение по умолчанию — new UTF8Encoding(false) (UTF‑8 без BOM).
get_ExportCidUrlsForMhtmlResources() constУказывает, следует ли использовать CID (Content-ID) URL для ссылки на ресурсы (изображения, шрифты, CSS), включённые в документы MHTML. Значение по умолчанию — false.
get_ExportDocumentProperties() constУказывает, следует ли экспортировать встроенные и пользовательские свойства документа в HTML, MHTML или EPUB. Значение по умолчанию — false.
get_ExportDropDownFormFieldAsText() constУправляет тем, как выпадающие поля формы сохраняются в HTML или MHTML. Значение по умолчанию — false.
get_ExportFontResources() constУказывает, следует ли экспортировать ресурсы шрифтов в HTML, MHTML или EPUB. По умолчанию — false.
get_ExportFontsAsBase64() constУказывает, следует ли внедрять ресурсы шрифтов в HTML в кодировке Base64. По умолчанию — false.
get_ExportGeneratorName() constКогда true, имя и версия Aspose.Words встраиваются в создаваемые файлы. Значение по умолчанию — true.
get_ExportHeadersFootersMode() constУказывает, как заголовки и колонтитулы выводятся в HTML, MHTML или EPUB. Значение по умолчанию — PerSection для HTML/MHTML и None для EPUB.
get_ExportImagesAsBase64() constУказывает, сохраняются ли изображения в формате Base64 в результирующий HTML, MHTML или EPUB. По умолчанию — false.
get_ExportLanguageInformation() constУказывает, экспортируется ли информация о языке в HTML, MHTML или EPUB. По умолчанию — false.
get_ExportListLabels() constУправляет тем, как метки списков выводятся в HTML, MHTML или EPUB. Значение по умолчанию — Auto.
get_ExportOriginalUrlForLinkedImages() constУказывает, следует ли использовать оригинальный URL в качестве URL связанных изображений. Значение по умолчанию — false.
get_ExportPageMargins() constУказывает, экспортируются ли поля страницы в HTML, MHTML или EPUB. По умолчанию — false.
get_ExportPageSetup() constУказывает, экспортируется ли настройка страницы в HTML, MHTML или EPUB. По умолчанию false.
get_ExportRelativeFontSize() constУказывает, должны ли размеры шрифтов выводиться в относительных единицах при сохранении в HTML, MHTML или EPUB. По умолчанию false.
get_ExportRoundtripInformation() constУказывает, следует ли записывать информацию о круговом проходе при сохранении в HTML, MHTML или EPUB. Значение по умолчанию true для HTML и false для MHTML и EPUB.
get_ExportShapesAsSvg() constУправляет тем, преобразуются ли узлы Shape в SVG‑изображения при сохранении в HTML, MHTML, EPUB или AZW3. Значение по умолчанию false.
get_ExportTextInputFormFieldAsText() constУправляет тем, как текстовые поля формы сохраняются в HTML или MHTML. Значение по умолчанию false.
get_ExportTocPageNumbers() constУказывает, следует ли записывать номера страниц в оглавление при сохранении в HTML, MHTML и EPUB. Значение по умолчанию false.
get_ExportXhtmlTransitional() constУказывает, следует ли записывать объявление DOCTYPE при сохранении в HTML или MHTML. Когда true, в документ до корневого элемента записывается объявление DOCTYPE. Значение по умолчанию false. При сохранении в EPUB или HTML5 (Html5) объявление DOCTYPE всегда записывается.
get_FontResourcesSubsettingSizeThreshold() constУправляет тем, какие ресурсы шрифтов требуют субсеттинга при сохранении в HTML, MHTML или EPUB. По умолчанию %0.
get_FontSavingCallback() constПозволяет управлять тем, как шрифты сохраняются при сохранении документа в HTML, MHTML или EPUB.
get_FontsFolder() constУказывает физическую папку, в которой шрифты сохраняются при экспорте документа в HTML. По умолчанию пустая строка.
get_FontsFolderAlias() constУказывает имя папки, используемой для построения URI шрифтов, записываемых в HTML‑документ. По умолчанию пустая строка.
get_HtmlVersion() constУказывает версию стандарта HTML, которая должна использоваться при сохранении документа в HTML или MHTML. Значение по умолчанию — Xhtml.
get_ImageResolution() constУказывает разрешение вывода изображений при экспорте в HTML, MHTML или EPUB. По умолчанию %96 dpi.
get_ImageSavingCallback() constПозволяет управлять тем, как изображения сохраняются при сохранении документа в HTML, MHTML или EPUB.
get_ImagesFolder() constУказывает физическую папку, в которой изображения сохраняются при экспорте документа в формат HTML. По умолчанию пустая строка.
get_ImagesFolderAlias() constУказывает имя папки, используемой для построения URI изображений, записываемых в HTML‑документ. По умолчанию пустая строка.
get_ImlRenderingMode() constПолучает или задает значение, определяющее, как отображаются объекты чернил (InkML).
get_MemoryOptimization() constПолучает значение, определяющее, следует ли выполнять оптимизацию памяти перед сохранением документа. Значение по умолчанию для этого свойства false.
get_MetafileFormat() constУказывает, в каком формате сохраняются метафайлы при экспорте в HTML, MHTML или EPUB. Значение по умолчанию — Png, что означает, что метафайлы рендерятся в растровые PNG‑изображения.
get_NavigationMapLevel() constУказывает максимальный уровень заголовков, включаемых в навигационную карту при экспорте в форматы EPUB, MOBI или AZW3. Значение по умолчанию %3.
get_OfficeMathOutputMode() constУправляет тем, как объекты OfficeMath экспортируются в HTML, MHTML или EPUB. Значение по умолчанию — Image.
get_PrettyFormat() constКогда true, вывод форматируется красиво, где это применимо. Значение по умолчанию false.
get_ProgressCallback() constВызывается во время сохранения документа и принимает данные о прогрессе сохранения.
get_RemoveJavaScriptFromLinks() constУказывает, будет ли JavaScript удалён из ссылок. По умолчанию false.
get_ReplaceBackslashWithYenSign() constУказывает, должны ли символы обратного слеша заменяться на знаки иены. Значение по умолчанию false.
get_ResolveFontNames() constУказывает, следует ли разрешать и заменять имена семейств шрифтов, используемых в документе, согласно FontSettings при записи в форматы на основе HTML.
get_ResourceFolder() constУказывает физическую папку, в которой сохраняются все ресурсы, такие как изображения, шрифты и внешние CSS, при экспорте документа в HTML. По умолчанию это пустая строка.
get_ResourceFolderAlias() constУказывает имя папки, используемой для построения URI всех ресурсов, записываемых в HTML‑документ. По умолчанию это пустая строка.
get_SaveFormat() overrideУказывает формат, в котором будет сохранён документ, если используется этот объект параметров сохранения. Может быть Html, Mhtml, Epub, Azw3 или Mobi.
get_ScaleImageToShapeSize() constУказывает, масштабируются ли изображения Aspose.Words до размеров ограничивающей формы при экспорте в HTML, MHTML или EPUB. Значение по умолчанию — true.
get_TableWidthOutputMode() constУправляет тем, как экспортируются ширины таблиц, строк и ячеек в HTML, MHTML или EPUB. Значение по умолчанию — All.
get_TempFolder() constУказывает папку для временных файлов, используемых при сохранении в файл DOC или DOCX. По умолчанию это свойство равно null, и временные файлы не используются.
get_UpdateAmbiguousTextFont() constОпределяет, будут ли атрибуты шрифта изменяться в соответствии с используемым кодом символа.
get_UpdateCreatedTimeProperty() constПолучает или задаёт значение, определяющее, будет ли свойство CreatedTime обновлено перед сохранением. Значение по умолчанию — false;.
get_UpdateFields() constПолучает значение, определяющее, следует ли обновлять поля определённых типов перед сохранением документа в фиксированный формат страниц. Значение по умолчанию для этого свойства — true.
get_UpdateLastPrintedProperty() constПолучает или задаёт значение, определяющее, будет ли свойство LastPrinted обновлено перед сохранением.
get_UpdateLastSavedTimeProperty() constПолучает или задаёт значение, определяющее, будет ли свойство LastSavedTime обновлено перед сохранением.
get_UpdateOleControlImages() constПолучает значение, определяющее, будет ли обновлено изображение представления OLE‑элементов.
get_UseAntiAliasing() constПолучает или задаёт значение, определяющее, использовать ли сглаживание при рендеринге.
get_UseHighQualityRendering() constПолучает или задаёт значение, определяющее, использовать ли высококачественные (т.е. медленные) алгоритмы рендеринга.
GetType() const override
HtmlSaveOptions()Инициализирует новый экземпляр этого класса, который можно использовать для сохранения документа в формате Html.
HtmlSaveOptions(Aspose::Words::SaveFormat)Инициализирует новый экземпляр этого класса, который можно использовать для сохранения документа в формате Html, Mhtml, Epub, Azw3 или Mobi.
Is(const System::TypeInfo&) const override
set_AllowEmbeddingPostScriptFonts(bool)Сеттер для Aspose::Words::Saving::SaveOptions::get_AllowEmbeddingPostScriptFonts.
set_AllowNegativeIndent(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_AllowNegativeIndent.
set_CssClassNamePrefix(const System::String&)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_CssClassNamePrefix.
set_CssSavingCallback(const System::SharedPtr<Aspose::Words::Saving::ICssSavingCallback>&)Позволяет управлять тем, как сохраняются стили CSS при сохранении документа в HTML, MHTML или EPUB.
set_CssStyleSheetFileName(const System::String&)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_CssStyleSheetFileName.
set_CssStyleSheetType(Aspose::Words::Saving::CssStyleSheetType)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_CssStyleSheetType.
set_CustomTimeZoneInfo(const System::SharedPtr<System::TimeZoneInfo>&)Сеттер для Aspose::Words::Saving::SaveOptions::get_CustomTimeZoneInfo.
set_DefaultTemplate(const System::String&)Сеттер для Aspose::Words::Saving::SaveOptions::get_DefaultTemplate.
set_Dml3DEffectsRenderingMode(Aspose::Words::Saving::Dml3DEffectsRenderingMode)Устанавливает значение, определяющее, как рендерятся 3D‑эффекты.
virtual set_DmlEffectsRenderingMode(Aspose::Words::Saving::DmlEffectsRenderingMode)Сеттер для Aspose::Words::Saving::SaveOptions::get_DmlEffectsRenderingMode.
set_DmlRenderingMode(Aspose::Words::Saving::DmlRenderingMode)Сеттер для Aspose::Words::Saving::SaveOptions::get_DmlRenderingMode.
set_DocumentPartSavingCallback(const System::SharedPtr<Aspose::Words::Saving::IDocumentPartSavingCallback>&)Позволяет управлять тем, как части документа сохраняются при сохранении документа в HTML или EPUB.
set_DocumentSplitCriteria(Aspose::Words::Saving::DocumentSplitCriteria)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_DocumentSplitCriteria.
set_DocumentSplitHeadingLevel(int32_t)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_DocumentSplitHeadingLevel.
set_Encoding(const System::SharedPtr<System::Text::Encoding>&)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_Encoding.
set_ExportCidUrlsForMhtmlResources(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ExportCidUrlsForMhtmlResources.
set_ExportDocumentProperties(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ExportDocumentProperties.
set_ExportDropDownFormFieldAsText(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ExportDropDownFormFieldAsText.
set_ExportFontResources(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ExportFontResources.
set_ExportFontsAsBase64(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ExportFontsAsBase64.
set_ExportGeneratorName(bool)Сеттер для Aspose::Words::Saving::SaveOptions::get_ExportGeneratorName.
set_ExportHeadersFootersMode(Aspose::Words::Saving::ExportHeadersFootersMode)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ExportHeadersFootersMode.
set_ExportImagesAsBase64(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ExportImagesAsBase64.
set_ExportLanguageInformation(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ExportLanguageInformation.
set_ExportListLabels(Aspose::Words::Saving::ExportListLabels)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ExportListLabels.
set_ExportOriginalUrlForLinkedImages(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ExportOriginalUrlForLinkedImages.
set_ExportPageMargins(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ExportPageMargins.
set_ExportPageSetup(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ExportPageSetup.
set_ExportRelativeFontSize(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ExportRelativeFontSize.
set_ExportRoundtripInformation(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ExportRoundtripInformation.
set_ExportShapesAsSvg(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ExportShapesAsSvg.
set_ExportTextInputFormFieldAsText(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ExportTextInputFormFieldAsText.
set_ExportTocPageNumbers(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ExportTocPageNumbers.
set_ExportXhtmlTransitional(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ExportXhtmlTransitional.
set_FontResourcesSubsettingSizeThreshold(int32_t)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_FontResourcesSubsettingSizeThreshold.
set_FontSavingCallback(const System::SharedPtr<Aspose::Words::Saving::IFontSavingCallback>&)Позволяет управлять тем, как шрифты сохраняются при сохранении документа в HTML, MHTML или EPUB.
set_FontsFolder(const System::String&)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_FontsFolder.
set_FontsFolderAlias(const System::String&)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_FontsFolderAlias.
set_HtmlVersion(Aspose::Words::Saving::HtmlVersion)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_HtmlVersion.
set_ImageResolution(int32_t)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ImageResolution.
set_ImageSavingCallback(const System::SharedPtr<Aspose::Words::Saving::IImageSavingCallback>&)Позволяет управлять тем, как изображения сохраняются при сохранении документа в HTML, MHTML или EPUB.
set_ImagesFolder(const System::String&)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ImagesFolder.
set_ImagesFolderAlias(const System::String&)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ImagesFolderAlias.
set_ImlRenderingMode(Aspose::Words::Saving::ImlRenderingMode)Сеттер для Aspose::Words::Saving::SaveOptions::get_ImlRenderingMode.
set_MemoryOptimization(bool)Устанавливает значение, определяющее, следует ли выполнять оптимизацию памяти перед сохранением документа. Значение по умолчанию для этого свойства — false.
set_MetafileFormat(Aspose::Words::Saving::HtmlMetafileFormat)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_MetafileFormat.
set_NavigationMapLevel(int32_t)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_NavigationMapLevel.
set_OfficeMathOutputMode(Aspose::Words::Saving::HtmlOfficeMathOutputMode)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_OfficeMathOutputMode.
set_PrettyFormat(bool)Сеттер для Aspose::Words::Saving::SaveOptions::get_PrettyFormat.
set_ProgressCallback(const System::SharedPtr<Aspose::Words::Saving::IDocumentSavingCallback>&)Сеттер для Aspose::Words::Saving::SaveOptions::get_ProgressCallback.
set_RemoveJavaScriptFromLinks(bool)Указывает, будет ли JavaScript удалён из ссылок. По умолчанию false.
set_ReplaceBackslashWithYenSign(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ReplaceBackslashWithYenSign.
set_ResolveFontNames(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ResolveFontNames.
set_ResourceFolder(const System::String&)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ResourceFolder.
set_ResourceFolderAlias(const System::String&)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ResourceFolderAlias.
set_SaveFormat(Aspose::Words::SaveFormat) overrideСеттер для Aspose::Words::Saving::HtmlSaveOptions::get_SaveFormat.
set_ScaleImageToShapeSize(bool)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_ScaleImageToShapeSize.
set_TableWidthOutputMode(Aspose::Words::Saving::HtmlElementSizeOutputMode)Сеттер для Aspose::Words::Saving::HtmlSaveOptions::get_TableWidthOutputMode.
set_TempFolder(const System::String&)Сеттер для Aspose::Words::Saving::SaveOptions::get_TempFolder.
set_UpdateAmbiguousTextFont(bool)Сеттер для Aspose::Words::Saving::SaveOptions::get_UpdateAmbiguousTextFont.
set_UpdateCreatedTimeProperty(bool)Сеттер для Aspose::Words::Saving::SaveOptions::get_UpdateCreatedTimeProperty.
set_UpdateFields(bool)Устанавливает значение, определяющее, следует ли обновлять поля определённых типов перед сохранением документа в фиксированный формат страниц. Значение по умолчанию для этого свойства — true.
set_UpdateLastPrintedProperty(bool)Сеттер для Aspose::Words::Saving::SaveOptions::get_UpdateLastPrintedProperty.
set_UpdateLastSavedTimeProperty(bool)Сеттер для Aspose::Words::Saving::SaveOptions::get_UpdateLastSavedTimeProperty.
set_UpdateOleControlImages(bool)Устанавливает значение, определяющее, будет ли обновлено изображение представления OLE‑элементов управления.
set_UseAntiAliasing(bool)Сеттер для Aspose::Words::Saving::SaveOptions::get_UseAntiAliasing.
set_UseHighQualityRendering(bool)Сеттер для Aspose::Words::Saving::SaveOptions::get_UseHighQualityRendering.
static Type()

Примеры

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

auto doc = System::MakeObject<Aspose::Words::Document>(get_MyDir() + u"Rendering.docx");

// Используйте объект SaveOptions, чтобы указать кодировку для документа, который мы будем сохранять.
auto saveOptions = System::MakeObject<Aspose::Words::Saving::HtmlSaveOptions>();
saveOptions->set_SaveFormat(Aspose::Words::SaveFormat::Epub);
saveOptions->set_Encoding(System::Text::Encoding::get_UTF8());

// По умолчанию выходной документ .epub будет содержать всё своё содержимое в одной HTML‑части.
// Критерий разбиения позволяет разделить документ на несколько HTML‑частей.
// Мы установим критерий разбиения документа на абзацы заголовков.
// Это полезно для читателей, которые не могут открывать HTML‑файлы, превышающие определённый размер.
saveOptions->set_DocumentSplitCriteria(Aspose::Words::Saving::DocumentSplitCriteria::HeadingParagraph);

// Укажите, что мы хотим экспортировать свойства документа.
saveOptions->set_ExportDocumentProperties(true);

doc->Save(get_ArtifactsDir() + u"HtmlSaveOptions.Doc2EpubSaveOptions.epub", saveOptions);

Показывает, как указать папку для хранения связанных изображений после сохранения в .html.

auto doc = System::MakeObject<Aspose::Words::Document>(get_MyDir() + u"Rendering.docx");

System::String imagesDir = System::IO::Path::Combine(get_ArtifactsDir(), u"SaveHtmlWithOptions");

if (System::IO::Directory::Exists(imagesDir))
{
    System::IO::Directory::Delete(imagesDir, true);
}

System::IO::Directory::CreateDirectory_(imagesDir);

// Установите параметр для экспорта полей формы как обычный текст вместо HTML‑элементов ввода.
auto options = System::MakeObject<Aspose::Words::Saving::HtmlSaveOptions>(Aspose::Words::SaveFormat::Html);
options->set_ExportTextInputFormFieldAsText(true);
options->set_ImagesFolder(imagesDir);

doc->Save(get_ArtifactsDir() + u"HtmlSaveOptions.SaveHtmlWithOptions.html", options);

См. также