TxtSaveOptionsBase Class

The base class for specifying additional options when saving a document into a text based formats.

Inheritance Hierarchy

SystemObject
  Aspose.Words.SavingSaveOptions
    Aspose.Words.SavingTxtSaveOptionsBase
      Aspose.Words.SavingTxtSaveOptions

Namespace: Aspose.Words.Saving
Assembly: Aspose.Words (in Aspose.Words.dll) Version: 20.3

Syntax

C++

public abstract class TxtSaveOptionsBase : SaveOptions

Public MustInherit Class TxtSaveOptionsBase
	Inherits SaveOptions

public ref class TxtSaveOptionsBase abstract : public SaveOptions

[<AbstractClassAttribute>]
type TxtSaveOptionsBase =  
    class
        inherit SaveOptions
    end

The TxtSaveOptionsBase type exposes the following members.

Properties

	Name	Description
	DefaultTemplate	Gets or sets path to default template (including filename). Default value for this property is empty string (Empty). (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 Encoding.UTF8.
	ExportHeadersFootersMode	Specifies the way headers and footers are exported to the text formats. Default value is PrimaryOnly.
	ForcePageBreaks	Allows to specify whether the page breaks should be preserved during export. The default value is false.
	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.)
	ParagraphBreak	Specifies the string to use as a paragraph break when exporting in text formats.
	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. (Inherited from SaveOptions.)
	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.)
	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 LastPrinted property is updated before saving. (Inherited from SaveOptions.)
	UpdateLastSavedTimeProperty	Gets or sets a value determining whether the LastSavedTime property is updated before saving. (Inherited from SaveOptions.)
	UpdateSdtContent	Gets or sets value determining whether content of StructuredDocumentTag 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
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	ToString	(Inherited from Object.)

Examples

Shows how to save a .txt document with a custom paragraph break.

// Create a new document and add some paragraphs
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.Writeln("Paragraph 1.");
builder.Writeln("Paragraph 2.");
builder.Write("Paragraph 3.");

// When saved to plain text, the paragraphs we created can be separated by a custom string
TxtSaveOptions txtSaveOptions = new TxtSaveOptions { SaveFormat = SaveFormat.Text, ParagraphBreak = " End of paragraph.\n\n\t" };

doc.Save(ArtifactsDir + "TxtSaveOptions.ParagraphBreak.txt", txtSaveOptions);

Reference

Aspose.Words.Saving Namespace