HtmlFixedSaveOptions class

HtmlFixedSaveOptions class

Can 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.

Inheritance: HtmlFixedSaveOptionsFixedPageSaveOptionsSaveOptions

Constructors

NameDescription
HtmlFixedSaveOptions()The default constructor.

Properties

NameDescription
allow_embedding_post_script_fontsGets 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)
color_modeGets or sets a value determining how colors are rendered.
(Inherited from FixedPageSaveOptions)
css_class_names_prefixSpecifies prefix which is added to all class names in style.css file. Default value is "aw".
default_templateGets or sets path to default template (including filename). Default value for this property is empty string ().
(Inherited from SaveOptions)
dml_3d_effects_rendering_modeGets or sets a value determining how 3D effects are rendered.
(Inherited from SaveOptions)
dml_effects_rendering_modeGets or sets a value determining how DrawingML effects are rendered.
(Inherited from SaveOptions)
dml_rendering_modeGets 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).
export_embedded_cssSpecifies whether the CSS (Cascading Style Sheet) should be embedded into Html document.
export_embedded_fontsSpecifies whether fonts should be embedded into Html document in Base64 format. Note setting this flag can significantly increase size of output Html file.
export_embedded_imagesSpecifies whether images should be embedded into Html document in Base64 format. Note setting this flag can significantly increase size of output Html file.
export_embedded_svgSpecifies whether SVG resources should be embedded into Html document. Default value is True.
export_form_fieldsGets or sets indication of whether form fields are exported as interactive items (as ‘input’ tag) rather than converted to text or graphics.
export_generator_nameWhen True, causes the name and version of Aspose.Words to be embedded into produced files. Default value is True.
(Inherited from SaveOptions)
font_formatGets or sets ExportFontFormat used for font exporting. Default value is ExportFontFormat.WOFF.
iml_rendering_modeGets or sets a value determining how ink (InkML) objects are rendered.
(Inherited from SaveOptions)
jpeg_qualityGets or sets a value determining the quality of the JPEG images inside Html document.
(Inherited from FixedPageSaveOptions)
memory_optimizationGets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is False.
(Inherited from SaveOptions)
metafile_rendering_optionsAllows to specify metafile rendering options.
(Inherited from FixedPageSaveOptions)
numeral_formatGets or sets NumeralFormat used for rendering of numerals. European numerals are used by default.
(Inherited from FixedPageSaveOptions)
optimize_outputFlag 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.
page_horizontal_alignmentSpecifies the horizontal alignment of pages in an HTML document. Default value is HtmlFixedPageHorizontalAlignment.CENTER.
page_marginsSpecifies 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.
page_saving_callbackAllows to control how separate pages are saved when a document is exported to fixed page format.
(Inherited from FixedPageSaveOptions)
page_setGets or sets the pages to render. Default is all the pages in the document.
(Inherited from FixedPageSaveOptions)
pretty_formatWhen True, pretty formats output where applicable. Default value is False.
(Inherited from SaveOptions)
progress_callbackCalled during saving a document and accepts data about saving progress.
(Inherited from SaveOptions)
resource_saving_callbackAllows to control how resources (images, fonts and css) are saved when a document is exported to fixed page Html format.
resources_folderSpecifies the physical folder where resources (images, fonts, css) are saved when exporting a document to Html format. Default is None.
resources_folder_aliasSpecifies the name of the folder used to construct image URIs written into an Html document. Default is None.
save_font_face_css_separatelyFlag 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.export_embedded_css is False). Default value is False, all CSS rules are written into single file “styles.css”.
save_formatSpecifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.HTML_FIXED.
show_page_borderSpecifies whether border around pages should be shown. Default is True.
temp_folderSpecifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is None and no temporary files are used.
(Inherited from SaveOptions)
update_created_time_propertyGets or sets a value determining whether the BuiltInDocumentProperties.created_time property is updated before saving. Default value is False;
(Inherited from SaveOptions)
update_fieldsGets 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)
update_last_printed_propertyGets or sets a value determining whether the BuiltInDocumentProperties.last_printed property is updated before saving.
(Inherited from SaveOptions)
update_last_saved_time_propertyGets or sets a value determining whether the BuiltInDocumentProperties.last_saved_time property is updated before saving.
(Inherited from SaveOptions)
use_anti_aliasingGets or sets a value determining whether or not to use anti-aliasing for rendering.
(Inherited from SaveOptions)
use_high_quality_renderingGets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
(Inherited from SaveOptions)
use_target_machine_fontsFlag indicates whether fonts from target machine must be used to display the document. If this flag is set to True, HtmlFixedSaveOptions.font_format and HtmlFixedSaveOptions.export_embedded_fonts properties do not have effect, also HtmlFixedSaveOptions.resource_saving_callback is not fired for fonts. Default is False.

Methods

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

See Also