aspose.words.saving module

The aspose.words.saving module provides classes and enumerations that allow to specify additional options for saving or converting documents.

Classes

ClassDescription
BookmarksOutlineLevelCollectionA collection of individual bookmarks outline level. To learn more, visit the Working with Bookmarks documentation article.
CssSavingArgsProvides data for the ICssSavingCallback.css_saving() event. To learn more, visit the Save a Document documentation article.
DocSaveOptionsCan be used to specify additional options when saving a document into the SaveFormat.DOC or SaveFormat.DOT format. To learn more, visit the Specify Save Options documentation article.
DocumentPartSavingArgsProvides data for the IDocumentPartSavingCallback.document_part_saving() callback. To learn more, visit the Save a Document documentation article.
DocumentSavingArgsAn argument passed into IDocumentSavingCallback.notify(). To learn more, visit the Save a Document documentation article.
DownsampleOptionsAllows to specify downsample options. To learn more, visit the Save a Document documentation article.
FixedPageSaveOptionsContains common options that can be specified when saving a document into fixed page formats (PDF, XPS, images etc). To learn more, visit the Specify Save Options documentation article.
FontSavingArgsProvides data for the IFontSavingCallback.font_saving() event. To learn more, visit the Save a Document documentation article.
HtmlFixedSaveOptionsCan be used to specify additional options when saving a document into the SaveFormat.HTML_FIXED format. To learn more, visit the Specify Save Options documentation article.
HtmlSaveOptionsCan be used to specify additional options when saving a document into the SaveFormat.HTML, SaveFormat.MHTML, SaveFormat.EPUB, SaveFormat.AZW3 or SaveFormat.MOBI format. To learn more, visit the Specify Save Options documentation article.
ICssSavingCallbackImplement this interface if you want to control how Aspose.Words saves CSS (Cascading Style Sheet) when saving a document to HTML.
IDocumentPartSavingCallbackImplement this interface if you want to receive notifications and control how Aspose.Words saves document parts when exporting a document to SaveFormat.HTML or SaveFormat.EPUB format.
IDocumentSavingCallbackImplement this interface if you want to have your own custom method called during saving a document.
IFontSavingCallbackImplement this interface if you want to receive notifications and control how Aspose.Words saves fonts when exporting a document to HTML format.
IImageSavingCallbackImplement this interface if you want to control how Aspose.Words saves images when saving a document to HTML. May be used by other formats.
IPageSavingCallbackImplement this interface if you want to control how Aspose.Words saves separate pages when saving a document to fixed page formats.
IResourceSavingCallbackImplement this interface if you want to control how Aspose.Words saves external resources (images, fonts and css) when saving a document to fixed page HTML or SVG.
ImageSaveOptionsAllows to specify additional options when rendering document pages or shapes to images. To learn more, visit the Specify Save Options documentation article.
ImageSavingArgsProvides data for the IImageSavingCallback.image_saving() event. To learn more, visit the Save a Document documentation article.
MarkdownSaveOptionsClass to specify additional options when saving a document into the SaveFormat.MARKDOWN format. To learn more, visit the Specify Save Options documentation article.
MetafileRenderingOptionsAllows to specify additional metafile rendering options. To learn more, visit the Handling Windows Metafiles documentation article.
OdtSaveOptionsCan be used to specify additional options when saving a document into the SaveFormat.ODT or SaveFormat.OTT format. To learn more, visit the Specify Save Options documentation article.
OoxmlSaveOptionsCan be used to specify additional options when saving a document into the SaveFormat.DOCX, SaveFormat.DOCM, SaveFormat.DOTX, SaveFormat.DOTM or SaveFormat.FLAT_OPC format. To learn more, visit the Specify Save Options documentation article.
OutlineOptionsAllows to specify outline options. To learn more, visit the Save a Document documentation article.
PageRangeRepresents a continuous range of pages. To learn more, visit the Programming with Documents documentation article.
PageSavingArgsProvides data for the IPageSavingCallback.page_saving() event. To learn more, visit the Programming with Documents documentation article.
PageSetDescribes a random set of pages. To learn more, visit the Programming with Documents documentation article.
PclSaveOptionsCan be used to specify additional options when saving a document into the SaveFormat.PCL format. To learn more, visit the Specify Save Options documentation article.
PdfDigitalSignatureDetailsContains details for signing a PDF document with a digital signature.
PdfDigitalSignatureTimestampSettingsContains settings of the digital signature timestamp. To learn more, visit the Work with Digital Signatures documentation article.
PdfEncryptionDetailsContains details for encrypting and access permissions for a PDF document. To learn more, visit the Protect or Encrypt a Document documentation article.
PdfSaveOptionsCan be used to specify additional options when saving a document into the SaveFormat.PDF format. To learn more, visit the Specify Save Options documentation article.
PsSaveOptionsCan be used to specify additional options when saving a document into the SaveFormat.PS format. To learn more, visit the Specify Save Options documentation article.
ResourceSavingArgsProvides data for the IResourceSavingCallback.resource_saving() event. To learn more, visit the Save a Document documentation article.
RtfSaveOptionsCan be used to specify additional options when saving a document into the SaveFormat.RTF format. To learn more, visit the Specify Save Options documentation article.
SaveOptionsThis is an abstract base class for classes that allow the user to specify additional options when saving a document into a particular format. To learn more, visit the Specify Save Options documentation article.
SaveOutputParametersThis object is returned to the caller after a document is saved and contains additional information that has been generated or calculated during the save operation. The caller can use or ignore this object. To learn more, visit the Save a Document documentation article.
SvgSaveOptionsCan be used to specify additional options when saving a document into the SaveFormat.SVG format. To learn more, visit the Specify Save Options documentation article.
TxtListIndentationSpecifies how list levels are indented when document is exporting to SaveFormat.TEXT format. To learn more, visit the Save a Document documentation article.
TxtSaveOptionsCan be used to specify additional options when saving a document into the SaveFormat.TEXT format. To learn more, visit the Specify Save Options documentation article.
TxtSaveOptionsBaseThe base class for specifying additional options when saving a document into a text based formats. To learn more, visit the Specify Save Options documentation article.
WordML2003SaveOptionsCan be used to specify additional options when saving a document into the SaveFormat.WORD_ML format. To learn more, visit the Specify Save Options documentation article.
XamlFixedSaveOptionsCan be used to specify additional options when saving a document into the SaveFormat.XAML_FIXED format. To learn more, visit the Specify Save Options documentation article.
XamlFlowSaveOptionsCan be used to specify additional options when saving a document into the SaveFormat.XAML_FLOW or SaveFormat.XAML_FLOW_PACK format. To learn more, visit the Specify Save Options documentation article.
XlsxSaveOptionsCan be used to specify additional options when saving a document into the SaveFormat.XLSX format. To learn more, visit the Specify Save Options documentation article.
XpsSaveOptionsCan be used to specify additional options when saving a document into the SaveFormat.XPS format. To learn more, visit the Specify Save Options documentation article.

Enumerations

EnumerationDescription
ColorModeSpecifies how colors are rendered.
CompressionLevelCompression level for OOXML files. (DOCX and DOTX files are internally a ZIP-archive, this property controls the compression level of the archive.
CssStyleSheetTypeSpecifies how CSS (Cascading Style Sheet) styles are exported to HTML.
Dml3DEffectsRenderingModeSpecifies how 3D shape effects are rendered.
DmlEffectsRenderingModeSpecifies how DrawingML effects are rendered to fixed page formats.
DmlRenderingModeSpecifies how DrawingML shapes are rendered to fixed page formats.
DocumentSplitCriteriaSpecifies how the document is split into parts when saving to SaveFormat.HTML, SaveFormat.EPUB or SaveFormat.AZW3 format.
EmfPlusDualRenderingModeSpecifies how Aspose.Words should render EMF+ Dual metafiles.
ExportFontFormatIndicates the format that is used to export fonts while rendering to HTML fixed format.
ExportHeadersFootersModeSpecifies how headers and footers are exported to HTML, MHTML or EPUB.
ExportListLabelsSpecifies how list labels are exported to HTML, MHTML and EPUB.
HeaderFooterBookmarksExportModeSpecifies how bookmarks in headers/footers are exported.
HtmlElementSizeOutputModeSpecifies how Aspose.Words exports element widths and heights to HTML, MHTML and EPUB.
HtmlFixedPageHorizontalAlignmentSpecifies the horizontal alignment for pages in output HTML document.
HtmlMetafileFormatIndicates the format in which metafiles are saved to HTML documents.
HtmlOfficeMathOutputModeSpecifies how Aspose.Words exports OfficeMath to HTML, MHTML and EPUB.
HtmlVersionIndicates the version of HTML is used when saving the document to SaveFormat.HTML and SaveFormat.MHTML formats.
ImageBinarizationMethodSpecifies the method used to binarize image.
ImageColorModeSpecifies the color mode for the generated images of document pages.
ImagePixelFormatSpecifies the pixel format for the generated images of document pages.
ImlRenderingModeSpecifies how ink (InkML) objects are rendered to fixed page formats.
MarkdownLinkExportModeThe mode of exporting links to a target document.
MarkdownListExportModeSpecifies how lists are exported into Markdown.
MetafileRenderingModeSpecifies how Aspose.Words should render WMF and EMF metafiles.
NumeralFormatIndicates the symbol set that is used to represent numbers while rendering to fixed page formats.
OdtSaveMeasureUnitSpecified units of measure to apply to measurable document content such as shape, widths and other during saving.
OoxmlComplianceAllows to specify which OOXML specification will be used when saving in the DOCX format.
PdfComplianceSpecifies the PDF standards compliance level.
PdfCustomPropertiesExportSpecifies the way Document.custom_document_properties are exported to PDF file.
PdfDigitalSignatureHashAlgorithmSpecifies a digital hash algorithm used by a digital signature.
PdfFontEmbeddingModeSpecifies how Aspose.Words should embed fonts.
PdfImageColorSpaceExportModeSpecifies how the color space will be selected for the images in PDF document.
PdfImageCompressionSpecifies the type of compression applied to images in the PDF file.
PdfPageLayoutSpecifies the page layout to be used when the document is opened in a PDF reader.
PdfPageModeSpecifies how the PDF document should be displayed when opened in the PDF reader.
PdfPermissionsSpecifies the operations that are allowed to a user on an encrypted PDF document.
PdfTextCompressionSpecifies a type of compression applied to all content in the PDF file except images.
PdfZoomBehaviorSpecifies the type of zoom applied to a PDF document when it is opened in a PDF viewer.
SvgTextOutputModeAllows to specify how text inside a document should be rendered when saving in SVG format.
TableContentAlignmentAllows to specify the alignment of the content of the table to be used when exporting into Markdown format.
TiffCompressionSpecifies what type of compression to apply when saving page images into a TIFF file.
TxtExportHeadersFootersModeSpecifies the way headers and footers are exported to plain text format.
XlsxSectionModeSpecifies how sections are handled when saving a document in the XLSX format.
Zip64ModeSpecifies when to use ZIP64 format extensions for OOXML files.