HtmlSaveOptions
Overview
HtmlSaveOptions is a class in Aspose.Words FOSS for .NET.
Inherits from: SaveOptions.
Can be used to specify additional options when saving a document into the Html, Mhtml, Epub, Azw3 or Mobi format.
This class provides 3 methods for working with HtmlSaveOptions objects in .NET programs.
Available methods include: CreateSaveOptions, HtmlSaveOptions.
All public members are accessible to any .NET application after installing the Aspose.Words FOSS for .NET package.
Properties: AllowEmbeddingPostScriptFonts, AllowNegativeIndent, CssClassNamePrefix, CssSavingCallback, CssStyleSheetFileName, CssStyleSheetType, and 60 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
SaveFormat | SaveFormat | Read/Write | Specifies the format in which the document will be saved if this save options object is used. |
AllowNegativeIndent | bool | Read/Write | Specifies whether negative left and right indents of paragraphs are normalized when saving to HTML, MHTML or EPUB. |
CssStyleSheetFileName | string | Read/Write | Specifies the path and the name of the Cascading Style Sheet (CSS) file written when a document is exported to HTML. |
CssStyleSheetType | CssStyleSheetType | Read/Write | Specifies how CSS (Cascading Style Sheet) styles are exported to HTML, MHTML or EPUB. |
CssClassNamePrefix | string | Read/Write | Specifies a prefix which is added to all CSS class names. |
DocumentPartSavingCallback | IDocumentPartSavingCallback | Read/Write | Allows to control how document parts are saved when a document is saved to HTML or EPUB. |
CssSavingCallback | ICssSavingCallback | Read/Write | Allows to control how CSS styles are saved when a document is saved to HTML, MHTML or EPUB. |
DocumentSplitCriteria | DocumentSplitCriteria | Read/Write | Specifies how the document should be split when saving to Html, Epub or Azw3 format. |
DocumentSplitHeadingLevel | int | Read/Write | Specifies the maximum level of headings at which to split the document. |
Encoding | Encoding | Read/Write | Specifies the encoding to use when exporting to HTML, MHTML or EPUB. |
NavigationMapLevel | int | Read/Write | Specifies the maximum level of headings populated to the navigation map when exporting to EPUB, MOBI, or AZW3 formats. |
ExportDocumentProperties | bool | Read/Write | Specifies whether to export built-in and custom document properties to HTML, MHTML or EPUB. |
ExportFontResources | bool | Read/Write | Specifies whether font resources should be exported to HTML, MHTML or EPUB. |
ExportFontsAsBase64 | bool | Read/Write | Specifies whether fonts resources should be embedded to HTML in Base64 encoding. |
ExportHeadersFootersMode | ExportHeadersFootersMode | Read/Write | Specifies how headers and footers are output to HTML, MHTML or EPUB. |
ExportImagesAsBase64 | bool | Read/Write | Specifies whether images are saved in Base64 format to the output HTML, MHTML or EPUB. |
ExportLanguageInformation | bool | Read/Write | Specifies whether language information is exported to HTML, MHTML or EPUB. |
ExportListLabels | ExportListLabels | Read/Write | Controls how list labels are output to HTML, MHTML or EPUB. |
MetafileFormat | HtmlMetafileFormat | Read/Write | Specifies in what format metafiles are saved when exporting to HTML, MHTML, or EPUB. |
ExportPageSetup | bool | Read/Write | Specifies whether page setup is exported to HTML, MHTML or EPUB. |
ExportPageMargins | bool | Read/Write | Specifies whether page margins is exported to HTML, MHTML or EPUB. |
ExportRelativeFontSize | bool | Read/Write | Specifies whether font sizes should be output in relative units when saving to HTML, MHTML or EPUB. |
ExportTextInputFormFieldAsText | bool | Read/Write | Controls how text input form fields are saved to HTML or MHTML. |
ExportShapesAsSvg | bool | Read/Write | Controls whether Shape nodes are converted to SVG images when saving to HTML, MHTML, EPUB or AZW3. |
ExportDropDownFormFieldAsText | bool | Read/Write | Controls how drop-down form fields are saved to HTML or MHTML. |
ExportTocPageNumbers | bool | Read/Write | Specifies whether to write page numbers to table of contents when saving HTML, MHTML and EPUB. |
ExportXhtmlTransitional | bool | Read/Write | Specifies whether to write the DOCTYPE declaration when saving to HTML or MHTML. |
HtmlVersion | HtmlVersion | Read/Write | Specifies version of HTML standard that should be used when saving the document to HTML or MHTML. |
ExportRoundtripInformation | bool | Read/Write | Specifies whether to write the roundtrip information when saving to HTML, MHTML or EPUB. |
ResourceFolder | string | Read/Write | Specifies a physical folder where all resources like images, fonts, and external CSS are saved when a document is exported to HTML. |
ResourceFolderAlias | string | Read/Write | Specifies the name of the folder used to construct URIs of all resources written into an HTML document. |
FontsFolder | string | Read/Write | Specifies the physical folder where fonts are saved when exporting a document to HTML. |
FontsFolderAlias | string | Read/Write | Specifies the name of the folder used to construct font URIs written into an HTML document. |
FontResourcesSubsettingSizeThreshold | int | Read/Write | Controls which font resources need subsetting when saving to HTML, MHTML or EPUB. |
ImagesFolder | string | Read/Write | Specifies the physical folder where images are saved when exporting a document to HTML format. |
ImagesFolderAlias | string | Read/Write | Specifies the name of the folder used to construct image URIs written into an HTML document. |
ImageResolution | int | Read/Write | Specifies the output resolution for images when exporting to HTML, MHTML or EPUB. |
ImageSavingCallback | IImageSavingCallback | Read/Write | Allows to control how images are saved when a document is saved to HTML, MHTML or EPUB. |
ScaleImageToShapeSize | bool | Read/Write | Specifies whether images are scaled by Aspose.Words to the bounding shape size when exporting to HTML, MHTML or EPUB. |
TableWidthOutputMode | HtmlElementSizeOutputMode | Read/Write | Controls how table, row and cell widths are exported to HTML, MHTML or EPUB. |
OfficeMathOutputMode | HtmlOfficeMathOutputMode | Read/Write | Controls how OfficeMath objects are exported to HTML, MHTML or EPUB. |
ExportOriginalUrlForLinkedImages | bool | Read/Write | Specifies whether original URL should be used as the URL of the linked images. |
ExportCidUrlsForMhtmlResources | bool | Read/Write | Specifies whether to use CID (Content-ID) URLs to reference resources (images, fonts, CSS) included in MHTML documents. |
ResolveFontNames | bool | Read/Write | Specifies whether font family names used in the document are resolved and substituted according to FontSettings when being written into HTML-based formats. |
ReplaceBackslashWithYenSign | bool | Read/Write | Specifies whether backslash characters should be replaced with yen signs. |
RemoveJavaScriptFromLinks | bool | Read/Write | Specifies whether JavaScript will be removed from links. |
ExportGeneratorName | bool | Read/Write | When true, causes the name and version of Aspose.Words to be embedded into produced files. |
TempFolder | string | Read/Write | Specifies the folder for temporary files used when saving to a DOC or DOCX file. |
UpdateOleControlImages | bool | Read/Write | Gets or sets a value determining whether OLE controls presentation image will be updated. |
PrettyFormat | bool | Read/Write | When true, pretty formats output where applicable. |
UseAntiAliasing | bool | Read/Write | Gets or sets a value determining whether or not to use anti-aliasing for rendering. |
UseHighQualityRendering | bool | Read/Write | Gets or sets a value determining whether or not to use high quality (i.e. |
DmlRenderingMode | DmlRenderingMode | Read/Write | Gets or sets a value determining how DrawingML shapes are rendered. |
DmlEffectsRenderingMode | DmlEffectsRenderingMode | Read/Write | Gets or sets a value determining how DrawingML effects are rendered. |
ImlRenderingMode | ImlRenderingMode | Read/Write | Gets or sets a value determining how ink (InkML) objects are rendered. |
DefaultTemplate | string | Read/Write | Gets or sets path to default template (including filename). |
UpdateFields | bool | Read/Write | Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. |
UpdateLastSavedTimeProperty | bool | Read/Write | Gets or sets a value determining whether the LastSavedTime property is updated before saving. |
UpdateLastPrintedProperty | bool | Read/Write | Gets or sets a value determining whether the LastPrinted property is updated before saving. |
UpdateCreatedTimeProperty | bool | Read/Write | Gets or sets a value determining whether the CreatedTime property is updated before saving. |
MemoryOptimization | bool | Read/Write | Gets or sets value determining if memory optimization should be performed before saving the document. |
UpdateAmbiguousTextFont | bool | Read/Write | Determines whether the font attributes will be changed according to the character code being used. |
Dml3DEffectsRenderingMode | Dml3DEffectsRenderingMode | Read/Write | Gets or sets a value determining how 3D effects are rendered. |
ProgressCallback | IDocumentSavingCallback | Read/Write | Called during saving a document and accepts data about saving progress. |
AllowEmbeddingPostScriptFonts | bool | Read/Write | Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. |
CustomTimeZoneInfo | TimeZoneInfo | Read/Write | Gets or sets custom local time zone used for date/time fields. |
Methods
| Signature | Description |
|---|---|
HtmlSaveOptions() | Initializes a new instance of this class that can be used to save a document in the Html format. |
HtmlSaveOptions(saveFormat: SaveFormat) | Initializes a new instance of this class that can be used to save a document in the Html, Mhtml, Epub, Azw3 or Mobi format. |
CreateSaveOptions(saveFormat: SaveFormat) | Creates a save options object of a correct class. |