DocSaveOptions class
DocSaveOptions class
Can be used to specify additional options when saving a document into the SaveFormat.Doc or SaveFormat.Dot format. To learn more, visit the Specify Save Options documentation article.
Remarks
At the moment provides only the DocSaveOptions.saveFormat property, but in the future will have other options added, such as an encryption password or digital signature settings.
Inheritance: DocSaveOptions → SaveOptions
Constructors
| Name | Description |
|---|---|
| DocSaveOptions() | Initializes a new instance of this class that can be used to save a document in the SaveFormat.Doc format. |
| DocSaveOptions(saveFormat) | Initializes a new instance of this class that can be used to save a document in the SaveFormat.Doc or SaveFormat.Dot format. |
Properties
| Name | Description |
|---|---|
| allowEmbeddingPostScriptFonts | 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) |
| alwaysCompressMetafiles | When false, small metafiles are not compressed for performance reason. Default value is true, all metafiles are compressed regardless of its size. |
| defaultTemplate | Gets or sets path to default template (including filename). Default value for this property is empty string . (Inherited from SaveOptions) |
| digitalSignatureDetails | Gets or sets DigitalSignatureDetails object used to sign a document. |
| dml3DEffectsRenderingMode | Gets or sets a value determining how 3D effects are rendered. (Inherited from SaveOptions) |
| dmlEffectsRenderingMode | Gets or sets a value determining how DrawingML effects are rendered. (Inherited from SaveOptions) |
| dmlRenderingMode | Gets or sets a value determining how DrawingML shapes are rendered. (Inherited from SaveOptions) |
| exportGeneratorName | When true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true.(Inherited from SaveOptions) |
| imlRenderingMode | Gets or sets a value determining how ink (InkML) objects are rendered. (Inherited from SaveOptions) |
| memoryOptimization | 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) |
| password | Gets/sets a password to encrypt document using RC4 encryption method. |
| prettyFormat | When true, pretty formats output where applicable. Default value is false.(Inherited from SaveOptions) |
| saveFormat | Specifies the format in which the document will be saved if this save options object is used. Can be SaveFormat.Doc or SaveFormat.Dot. |
| savePictureBullet | When false, PictureBullet data is not saved to output document. Default value is true. |
| saveRoutingSlip | When false, RoutingSlip data is not saved to output document. Default value is true. |
| tempFolder | 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.(Inherited from SaveOptions) |
| updateAmbiguousTextFont | Determines whether the font attributes will be changed according to the character code being used. (Inherited from SaveOptions) |
| updateCreatedTimeProperty | Gets or sets a value determining whether the BuiltInDocumentProperties.createdTime property is updated before saving. Default value is false;(Inherited from SaveOptions) |
| updateFields | 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) |
| updateLastPrintedProperty | Gets or sets a value determining whether the BuiltInDocumentProperties.lastPrinted property is updated before saving. (Inherited from SaveOptions) |
| updateLastSavedTimeProperty | Gets or sets a value determining whether the BuiltInDocumentProperties.lastSavedTime property is updated before saving. (Inherited from SaveOptions) |
| useAntiAliasing | Gets or sets a value determining whether or not to use anti-aliasing for rendering. (Inherited from SaveOptions) |
| useHighQualityRendering | Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. (Inherited from SaveOptions) |
Methods
| Name | Description |
|---|---|
| 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) |
Examples
Shows how to set save options for older Microsoft Word formats.
let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);
builder.write("Hello world!");
let options = new aw.Saving.DocSaveOptions(aw.SaveFormat.Doc);
// Set a password which will protect the loading of the document by Microsoft Word or Aspose.words.
// Note that this does not encrypt the contents of the document in any way.
options.password = "MyPassword";
// If the document contains a routing slip, we can preserve it while saving by setting this flag to true.
options.saveRoutingSlip = true;
doc.save(base.artifactsDir + "DocSaveOptions.SaveAsDoc.doc", options);
// To be able to load the document,
// we will need to apply the password we specified in the DocSaveOptions object in a LoadOptions object.
expect(() => doc = new aw.Document(base.artifactsDir + "DocSaveOptions.SaveAsDoc.doc")).toThrow("The document password is incorrect.");
let loadOptions = new aw.Loading.LoadOptions("MyPassword");
doc = new aw.Document(base.artifactsDir + "DocSaveOptions.SaveAsDoc.doc", loadOptions);
expect(doc.getText().trim()).toEqual("Hello world!");
See Also
- module Aspose.Words.Saving
- class SaveOptions