DoclingSaveOptions class
DoclingSaveOptions class
Can be used to specify additional options when saving a document into the SaveFormat.DOCLING format. To learn more, visit the Specify Save Options documentation article.
Inheritance: DoclingSaveOptions → SaveOptions
Constructors
| Name | Description |
|---|---|
| DoclingSaveOptions() | The default constructor. |
Properties
| Name | Description |
|---|---|
| allow_embedding_post_script_fonts | 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. The default value is False.(Inherited from SaveOptions) |
| default_template | Gets or sets path to default template (including filename). Default value for this property is empty string (). (Inherited from SaveOptions) |
| dml_3d_effects_rendering_mode | Gets or sets a value determining how 3D effects are rendered. (Inherited from SaveOptions) |
| dml_effects_rendering_mode | Gets or sets a value determining how DrawingML effects are rendered. (Inherited from SaveOptions) |
| dml_rendering_mode | Gets or sets a value determining how DrawingML shapes are rendered. (Inherited from SaveOptions) |
| export_generator_name | When True, causes the name and version of Aspose.Words to be embedded into produced files. Default value is True.(Inherited from SaveOptions) |
| iml_rendering_mode | Gets or sets a value determining how ink (InkML) objects are rendered. (Inherited from SaveOptions) |
| memory_optimization | Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is False.(Inherited from SaveOptions) |
| pretty_format | When True, pretty formats output where applicable. Default value is False.(Inherited from SaveOptions) |
| progress_callback | Called during saving a document and accepts data about saving progress. (Inherited from SaveOptions) |
| render_non_image_shapes | Gets or sets a value indicating whether non-image shapes should be rendered and written to the output Docling JSON document. |
| save_format | Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.DOCLING. |
| temp_folder | Specifies 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_ambiguous_text_font | Determines whether the font attributes will be changed according to the character code being used. (Inherited from SaveOptions) |
| update_created_time_property | Gets or sets a value determining whether the BuiltInDocumentProperties.created_time property is updated before saving. Default value is False;(Inherited from SaveOptions) |
| update_fields | Gets 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_property | Gets or sets a value determining whether the BuiltInDocumentProperties.last_printed property is updated before saving. (Inherited from SaveOptions) |
| update_last_saved_time_property | Gets or sets a value determining whether the BuiltInDocumentProperties.last_saved_time property is updated before saving. (Inherited from SaveOptions) |
| update_ole_control_images | Gets or sets a value determining whether OLE controls presentation image will be updated. (Inherited from SaveOptions) |
| use_anti_aliasing | Gets or sets a value determining whether or not to use anti-aliasing for rendering. (Inherited from SaveOptions) |
| use_high_quality_rendering | Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. (Inherited from SaveOptions) |
Methods
| Name | Description |
|---|---|
| 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) |
Examples
Shows how to save a document into a Docling JSON format.
doc = aw.Document(file_name=MY_DIR + 'Rendering.docx')
save_options = aw.saving.DoclingSaveOptions()
save_options.save_format = aw.SaveFormat.DOCLING
# Set to true to render non-image shapes and include them in the output.
# Set to false (default) to exclude non-image shapes from the output.
save_options.render_non_image_shapes = True
doc.save(file_name=ARTIFACTS_DIR + 'DoclingSaveOptions.DoclingJson.json', save_options=save_options)
See Also
- module aspose.words.saving
- class SaveOptions