HtmlFixedSaveOptions class

HtmlFixedSaveOptions class

Can be used to specify additional options when saving a document into the SaveFormat.HtmlFixed format. To learn more, visit the Specify Save Options documentation article.

Inheritance: HtmlFixedSaveOptionsFixedPageSaveOptionsSaveOptions

Constructors

NameDescription
HtmlFixedSaveOptions()The default constructor.

Properties

NameDescription
allowEmbeddingPostScriptFontsGets 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. The default value is false.
(Inherited from SaveOptions)
colorModeGets or sets a value determining how colors are rendered.
(Inherited from FixedPageSaveOptions)
cssClassNamesPrefixSpecifies prefix which is added to all class names in style.css file. Default value is "aw".
defaultTemplateGets or sets path to default template (including filename). Default value for this property is empty string ().
(Inherited from SaveOptions)
dml3DEffectsRenderingModeGets or sets a value determining how 3D effects are rendered.
(Inherited from SaveOptions)
dmlEffectsRenderingModeGets or sets a value determining how DrawingML effects are rendered.
(Inherited from SaveOptions)
dmlRenderingModeGets or sets a value determining how DrawingML shapes are rendered.
(Inherited from SaveOptions)
encodingSpecifies the encoding to use when exporting to HTML. Default value is new UTF8Encoding(true) (UTF-8 with BOM).
exportEmbeddedCssSpecifies whether the CSS (Cascading Style Sheet) should be embedded into Html document.
exportEmbeddedFontsSpecifies whether fonts should be embedded into Html document in Base64 format. Note setting this flag can significantly increase size of output Html file.
exportEmbeddedImagesSpecifies whether images should be embedded into Html document in Base64 format. Note setting this flag can significantly increase size of output Html file.
exportEmbeddedSvgSpecifies whether SVG resources should be embedded into Html document. Default value is true.
exportFormFieldsGets or sets indication of whether form fields are exported as interactive items (as ‘input’ tag) rather than converted to text or graphics.
exportGeneratorNameWhen true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true.
(Inherited from SaveOptions)
fontFormatGets or sets ExportFontFormat used for font exporting. Default value is ExportFontFormat.Woff.
idPrefixSpecifies a prefix that is prepended to all generated element IDs in the output document. Default value is null and no prefix is prepended.
imlRenderingModeGets or sets a value determining how ink (InkML) objects are rendered.
(Inherited from SaveOptions)
jpegQualityGets or sets a value determining the quality of the JPEG images inside Html document.
(Inherited from FixedPageSaveOptions)
memoryOptimizationGets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.
(Inherited from SaveOptions)
metafileRenderingOptionsAllows to specify metafile rendering options.
(Inherited from FixedPageSaveOptions)
numeralFormatGets or sets NumeralFormat used for rendering of numerals. European numerals are used by default.
(Inherited from FixedPageSaveOptions)
optimizeOutputFlag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formating are concatenated. Note: The accuracy of the content display may be affected if this property is set to true.
pageHorizontalAlignmentSpecifies the horizontal alignment of pages in an HTML document. Default value is HtmlFixedPageHorizontalAlignment.Center.
pageMarginsSpecifies the margins around pages in an HTML document. The margins value is measured in points and should be equal to or greater than 0. Default value is 10 points.
pageSavingCallbackAllows to control how separate pages are saved when a document is exported to fixed page format.
(Inherited from FixedPageSaveOptions)
pageSetGets or sets the pages to render. Default is all the pages in the document.
(Inherited from FixedPageSaveOptions)
prettyFormatWhen true, pretty formats output where applicable. Default value is false.
(Inherited from SaveOptions)
progressCallbackCalled during saving a document and accepts data about saving progress.
(Inherited from SaveOptions)
removeJavaScriptFromLinksSpecifies whether JavaScript will be removed from links. Default is false. If this option is enabled, all links containing JavaScript will be replaced with “javascript:void(0)”.
resourceSavingCallbackAllows to control how resources (images, fonts and css) are saved when a document is exported to fixed page Html format.
resourcesFolderSpecifies the physical folder where resources (images, fonts, css) are saved when exporting a document to Html format. Default is null.
resourcesFolderAliasSpecifies the name of the folder used to construct image URIs written into an Html document. Default is null.
saveFontFaceCssSeparatelyFlag indicates whether “@font-face” CSS rules should be placed into a separate file “fontFaces.css” when a document is being saved with external stylesheet (that is, when HtmlFixedSaveOptions.exportEmbeddedCss is false). Default value is false, all CSS rules are written into single file “styles.css”.
saveFormatSpecifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.HtmlFixed.
showPageBorderSpecifies whether border around pages should be shown. Default is true.
tempFolderSpecifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is null and no temporary files are used.
(Inherited from SaveOptions)
updateAmbiguousTextFontDetermines whether the font attributes will be changed according to the character code being used.
(Inherited from SaveOptions)
updateCreatedTimePropertyGets or sets a value determining whether the BuiltInDocumentProperties.createdTime property is updated before saving. Default value is false;
(Inherited from SaveOptions)
updateFieldsGets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true.
(Inherited from SaveOptions)
updateLastPrintedPropertyGets or sets a value determining whether the BuiltInDocumentProperties.lastPrinted property is updated before saving.
(Inherited from SaveOptions)
updateLastSavedTimePropertyGets or sets a value determining whether the BuiltInDocumentProperties.lastSavedTime property is updated before saving.
(Inherited from SaveOptions)
useAntiAliasingGets or sets a value determining whether or not to use anti-aliasing for rendering.
(Inherited from SaveOptions)
useHighQualityRenderingGets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
(Inherited from SaveOptions)
useTargetMachineFontsFlag indicates whether fonts from target machine must be used to display the document. If this flag is set to true, HtmlFixedSaveOptions.fontFormat and HtmlFixedSaveOptions.exportEmbeddedFonts properties do not have effect, also HtmlFixedSaveOptions.resourceSavingCallback is not fired for fonts. Default is false.

Methods

NameDescription
createSaveOptions(saveFormat)Creates a save options object of a class suitable for the specified save format.
(Inherited from SaveOptions)
createSaveOptions(fileName)Creates a save options object of a class suitable for the file extension specified in the given file name.
(Inherited from SaveOptions)

See Also