TxtSaveOptions
Contents
[
Hide
]TxtSaveOptions class
Can be used to specify additional options when saving a document into the Text format.
To learn more, visit the Specify Save Options documentation article.
public class TxtSaveOptions : TxtSaveOptionsBase
Constructors
| Name | Description |
|---|---|
| TxtSaveOptions() | The default constructor. |
Properties
| Name | Description |
|---|---|
| AddBidiMarks { get; set; } | Specifies whether to add bi-directional marks before each BiDi run when exporting in plain text format. |
| 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. |
| Encoding { get; set; } | Specifies the encoding to use when exporting in text formats. Default value is Encoding.UTF8. |
| ExportGeneratorName { get; set; } | When true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true. |
| ExportHeadersFootersMode { get; set; } | Specifies the way headers and footers are exported to the text formats. Default value is PrimaryOnly. |
| ForcePageBreaks { get; set; } | Allows to specify whether the page breaks should be preserved during export. |
| ImlRenderingMode { get; set; } | Gets or sets a value determining how ink (InkML) objects are rendered. |
| ListIndentation { get; } | 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 { get; set; } | 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 { get; set; } | Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false. |
| ParagraphBreak { get; set; } | Specifies the string to use as a paragraph break when exporting in text formats. |
| PreserveTableLayout { get; set; } | Specifies whether the program should attempt to preserve layout of tables when saving in the plain text format. The default value 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. |
| override SaveFormat { get; set; } | Specifies the format in which the document will be saved if this save options object is used. Can only be Text. |
| SimplifyListLabels { get; set; } | Specifies whether the program should simplify list labels in case of complex label formatting not being adequately represented by plain text. |
| 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. |
| 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. |
| 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 .txt document with a custom paragraph break.
Document doc = new Document();
DocumentBuilder builder = new 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.
TxtSaveOptions txtSaveOptions = new TxtSaveOptions();
Assert.AreEqual(SaveFormat.Text, txtSaveOptions.SaveFormat);
// 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(ArtifactsDir + "TxtSaveOptions.ParagraphBreak.txt", txtSaveOptions);
string docText = File.ReadAllText(ArtifactsDir + "TxtSaveOptions.ParagraphBreak.txt");
Assert.AreEqual("Paragraph 1. End of paragraph.\n\n\t" +
"Paragraph 2. End of paragraph.\n\n\t" +
"Paragraph 3. End of paragraph.\n\n\t", docText);
See Also
- class TxtSaveOptionsBase
- namespace Aspose.Words.Saving
- assembly Aspose.Words
