TxtSaveOptions class
TxtSaveOptions class
Can be used to specify additional options when saving a document into the SaveFormat.Text format. To learn more, visit the Specify Save Options documentation article.
Inheritance: TxtSaveOptions → TxtSaveOptionsBase → SaveOptions
Constructors
| Name | Description |
|---|---|
| TxtSaveOptions() | The default constructor. |
Properties
| Name | Description |
|---|---|
| addBidiMarks | Specifies whether to add bi-directional marks before each BiDi run when exporting in plain text format. |
| 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) |
| encoding | Specifies the encoding to use when exporting in text formats. Default value is . (Inherited from TxtSaveOptionsBase) |
| exportGeneratorName | When true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true.(Inherited from SaveOptions) |
| exportHeadersFootersMode | Specifies the way headers and footers are exported to the text formats. Default value is TxtExportHeadersFootersMode.PrimaryOnly. (Inherited from TxtSaveOptionsBase) |
| forcePageBreaks | Allows to specify whether the page breaks should be preserved during export. (Inherited from TxtSaveOptionsBase) |
| imlRenderingMode | Gets or sets a value determining how ink (InkML) objects are rendered. (Inherited from SaveOptions) |
| listIndentation | Gets a TxtListIndentation object that specifies how many and which character to use for indentation of list levels. By default, it is zero count of character ‘\0’, that means no indentation. |
| maxCharactersPerLine | Gets or sets an integer value that specifies the maximum number of characters per one line. The default value is 0, that means no limit. |
| 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) |
| officeMathExportMode | Specifies how OfficeMath will be written to the output file. Default value is TxtOfficeMathExportMode.Text. |
| paragraphBreak | Specifies the string to use as a paragraph break when exporting in text formats. (Inherited from TxtSaveOptionsBase) |
| preserveTableLayout | Specifies whether the program should attempt to preserve layout of tables when saving in the plain text format. The default value is false. |
| 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.Text. |
| simplifyListLabels | Specifies whether the program should simplify list labels in case of complex label formatting not being adequately represented by plain text. |
| 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 .txt document with a custom paragraph break.
let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);
builder.writeln("Paragraph 1.");
builder.writeln("Paragraph 2.");
builder.write("Paragraph 3.");
// Create a "TxtSaveOptions" object, which we can pass to the document's "Save" method
// to modify how we save the document to plaintext.
let txtSaveOptions = new aw.Saving.TxtSaveOptions();
expect(txtSaveOptions.saveFormat).toEqual(aw.SaveFormat.Text);
// Set the "ParagraphBreak" to a custom value that we wish to put at the end of every paragraph.
txtSaveOptions.paragraphBreak = " End of paragraph.\n\n\t";
doc.save(base.artifactsDir + "TxtSaveOptions.paragraphBreak.txt", txtSaveOptions);
let docText = readTextFile(base.artifactsDir + "TxtSaveOptions.paragraphBreak.txt");
expect(docText).toEqual("Paragraph 1. End of paragraph.\n\n\t" +
"Paragraph 2. End of paragraph.\n\n\t" +
"Paragraph 3. End of paragraph.\n\n\t");
See Also
- module Aspose.Words.Saving
- class TxtSaveOptionsBase