RtfSaveOptions class
RtfSaveOptions class
Can be used to specify additional options when saving a document into the SaveFormat.Rtf format. To learn more, visit the Specify Save Options documentation article.
Inheritance: RtfSaveOptions → SaveOptions
Constructors
| Name | Description |
|---|---|
| RtfSaveOptions() | The default constructor. |
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) |
| defaultTemplate | Gets or sets path to default template (including filename). Default value for this property is empty string . (Inherited from SaveOptions) |
| 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) |
| exportCompactSize | Allows to make output RTF documents smaller in size, but if they contain RTL (right-to-left) text, it will not be displayed correctly. |
| exportGeneratorName | When true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true.(Inherited from SaveOptions) |
| exportImagesForOldReaders | Specifies whether the keywords for “old readers” are written to RTF or not. This can significantly affect the size of the RTF document. |
| 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) |
| 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 only be SaveFormat.Rtf. |
| saveImagesAsWmf | When true all images will be saved as WMF. |
| 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 save a document to .rtf with custom options.
let doc = new aw.Document(base.myDir + "Rendering.docx");
// Create an "RtfSaveOptions" object to pass to the document's "Save" method to modify how we save it to an RTF.
let options = new aw.Saving.RtfSaveOptions();
expect(options.saveFormat).toEqual(aw.SaveFormat.Rtf);
// Set the "ExportCompactSize" property to "true" to
// reduce the saved document's size at the cost of right-to-left text compatibility.
options.exportCompactSize = true;
// Set the "ExportImagesFotOldReaders" property to "true" to use extra keywords to ensure that our document is
// compatible with pre-Microsoft Word 97 readers and WordPad.
// Set the "ExportImagesFotOldReaders" property to "false" to reduce the size of the document,
// but prevent old readers from being able to read any non-metafile or BMP images that the document may contain.
options.exportImagesForOldReaders = exportImagesForOldReaders;
doc.save(base.artifactsDir + "RtfSaveOptions.ExportImages.rtf", options);
See Also
- module Aspose.Words.Saving
- class SaveOptions