DoclingSaveOptions

DoclingSaveOptions class

Can be used to specify additional options when saving a document into the Docling format.

To learn more, visit the Specify Save Options documentation article.

public class DoclingSaveOptions : SaveOptions

Constructors

NameDescription
DoclingSaveOptions()The default constructor.

Properties

NameDescription
AllowEmbeddingPostScriptFonts { get; set; }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.
CustomTimeZoneInfo { get; set; }Gets or sets custom local time zone used for date/time fields.
DefaultTemplate { get; set; }Gets or sets path to default template (including filename). Default value for this property is empty string (Empty).
Dml3DEffectsRenderingMode { get; set; }Gets or sets a value determining how 3D effects are rendered.
virtual DmlEffectsRenderingMode { get; set; }Gets or sets a value determining how DrawingML effects are rendered.
DmlRenderingMode { get; set; }Gets or sets a value determining how DrawingML shapes are rendered.
ExportGeneratorName { get; set; }When true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true.
ImlRenderingMode { get; set; }Gets or sets a value determining how ink (InkML) objects are rendered.
MemoryOptimization { get; set; }Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.
PrettyFormat { get; set; }When true, pretty formats output where applicable. Default value is false.
ProgressCallback { get; set; }Called during saving a document and accepts data about saving progress.
RenderNonImageShapes { get; set; }Gets or sets a value indicating whether non-image shapes should be rendered and written to the output Docling JSON document.
override SaveFormat { get; set; }Specifies the format in which the document will be saved if this save options object is used. Can only be Docling.
TempFolder { get; set; }Specifies 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.
UpdateAmbiguousTextFont { get; set; }Determines whether the font attributes will be changed according to the character code being used.
UpdateCreatedTimeProperty { get; set; }Gets or sets a value determining whether the CreatedTime property is updated before saving. Default value is false;
UpdateFields { get; set; }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.
UpdateLastPrintedProperty { get; set; }Gets or sets a value determining whether the LastPrinted property is updated before saving.
UpdateLastSavedTimeProperty { get; set; }Gets or sets a value determining whether the LastSavedTime property is updated before saving.
UpdateOleControlImages { get; set; }Gets or sets a value determining whether OLE controls presentation image will be updated.
UseAntiAliasing { get; set; }Gets or sets a value determining whether or not to use anti-aliasing for rendering.
UseHighQualityRendering { get; set; }Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.

Examples

Shows how to save a document into a Docling JSON format.

Document doc = new Document(MyDir + "Rendering.docx");

DoclingSaveOptions saveOptions = new DoclingSaveOptions();
saveOptions.SaveFormat = 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.
saveOptions.RenderNonImageShapes = true;

doc.Save(ArtifactsDir + "DoclingSaveOptions.DoclingJson.json", saveOptions);

See Also