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

Examples

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

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
 
builder->Writeln(u"Paragraph 1.");
builder->Writeln(u"Paragraph 2.");
builder->Write(u"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.
auto txtSaveOptions = MakeObject<TxtSaveOptions>();
 
ASSERT_EQ(SaveFormat::Text, txtSaveOptions->get_SaveFormat());
 
// Set the "ParagraphBreak" to a custom value that we wish to put at the end of every paragraph.
txtSaveOptions->set_ParagraphBreak(u" End of paragraph.\n\n\t");
 
doc->Save(ArtifactsDir + u"TxtSaveOptions.ParagraphBreak.txt", txtSaveOptions);
 
String docText = System::IO::File::ReadAllText(ArtifactsDir + u"TxtSaveOptions.ParagraphBreak.txt");
 
ASSERT_EQ(String(u"Paragraph 1. End of paragraph.\n\n\t") + u"Paragraph 2. End of paragraph.\n\n\t" + u"Paragraph 3. End of paragraph.\n\n\t", docText);

#include <Aspose.Words.Cpp/Saving/TxtSaveOptionsBase.h>

Inheritance diagram for Aspose::Words::Saving::TxtSaveOptionsBase:

Public Member Functions
	TxtSaveOptionsBase ()

SharedPtr< Encoding >	get_Encoding () const
	Specifies the encoding to use when exporting in text formats. Default value is Encoding.UTF8. More...

TxtExportHeadersFootersMode	get_ExportHeadersFootersMode () const
	Specifies the way headers and footers are exported to the text formats. Default value is PrimaryOnly. More...

bool	get_ForcePageBreaks () const
	Allows to specify whether the page breaks should be preserved during export. The default value is false. More...

String	get_ParagraphBreak () const
	Specifies the string to use as a paragraph break when exporting in text formats. More...

virtual const TypeInfo &	GetType () const override

virtual bool	Is (const TypeInfo &target) const override

void	set_Encoding (SharedPtr< Encoding > value)
	Setter for get_Encoding. More...

void	set_ExportHeadersFootersMode (TxtExportHeadersFootersMode value)
	Setter for get_ExportHeadersFootersMode. More...

void	set_ForcePageBreaks (bool value)
	Setter for get_ForcePageBreaks. More...

void	set_ParagraphBreak (String value)
	Setter for get_ParagraphBreak. More...

Public Member Functions inherited from SaveOptions
bool	get_AllowEmbeddingPostScriptFonts () const
	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. More...

SharedPtr< TimeZoneInfo >	get_CustomTimeZoneInfo () const

String	get_DefaultTemplate () const
	Gets or sets path to default template (including filename). Default value for this property is empty string. More...

Dml3DEffectsRenderingMode	get_Dml3DEffectsRenderingMode () const
	Gets a value determining how 3D effects are rendered. More...

virtual DmlEffectsRenderingMode	get_DmlEffectsRenderingMode ()
	Gets or sets a value determining how DrawingML effects are rendered. More...

DmlRenderingMode	get_DmlRenderingMode () const
	Gets or sets a value determining how DrawingML shapes are rendered. More...

ImlRenderingMode	get_ImlRenderingMode () const
	Gets or sets a value determining how ink (InkML) objects are rendered. More...

bool	get_MemoryOptimization () const
	Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false. More...

bool	get_PrettyFormat () const
	When `true`, pretty formats output where applicable. Default value is false. More...

virtual SaveFormat	get_SaveFormat ()=0
	Specifies the format in which the document will be saved if this save options object is used. More...

String	get_TempFolder () const
	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. More...

bool	get_UpdateCreatedTimeProperty () const
	Gets a value determining whether the CreatedTime property is updated before saving. Default value is false;. More...

bool	get_UpdateFields () const
	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. More...

bool	get_UpdateLastPrintedProperty () const
	Gets or sets a value determining whether the LastPrinted property is updated before saving. More...

bool	get_UpdateLastSavedTimeProperty () const
	Gets or sets a value determining whether the LastSavedTime property is updated before saving. More...

bool	get_UpdateSdtContent () const
	Gets or sets value determining whether content of StructuredDocumentTag is updated before saving. More...

bool	get_UseAntiAliasing () const
	Gets or sets a value determining whether or not to use anti-aliasing for rendering. More...

bool	get_UseHighQualityRendering () const
	Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. More...

void	set_AllowEmbeddingPostScriptFonts (bool value)
	Setter for get_AllowEmbeddingPostScriptFonts. More...

void	set_CustomTimeZoneInfo (SharedPtr< TimeZoneInfo > value)

void	set_DefaultTemplate (String value)
	Setter for get_DefaultTemplate. More...

void	set_Dml3DEffectsRenderingMode (Dml3DEffectsRenderingMode value)
	Sets a value determining how 3D effects are rendered. More...

virtual void	set_DmlEffectsRenderingMode (DmlEffectsRenderingMode value)
	Setter for get_DmlEffectsRenderingMode. More...

void	set_DmlRenderingMode (DmlRenderingMode value)
	Setter for get_DmlRenderingMode. More...

void	set_ImlRenderingMode (ImlRenderingMode value)
	Setter for get_ImlRenderingMode. More...

void	set_MemoryOptimization (bool value)
	Setter for get_MemoryOptimization. More...

void	set_PrettyFormat (bool value)
	Setter for get_PrettyFormat. More...

virtual void	set_SaveFormat (SaveFormat value)=0
	Setter for get_SaveFormat. More...

void	set_TempFolder (String value)
	Setter for get_TempFolder. More...

void	set_UpdateCreatedTimeProperty (bool value)
	Sets a value determining whether the CreatedTime property is updated before saving. Default value is false;. More...

void	set_UpdateFields (bool value)
	Setter for get_UpdateFields. More...

void	set_UpdateLastPrintedProperty (bool value)
	Setter for get_UpdateLastPrintedProperty. More...

void	set_UpdateLastSavedTimeProperty (bool value)
	Setter for get_UpdateLastSavedTimeProperty. More...

void	set_UpdateSdtContent (bool value)
	Setter for get_UpdateSdtContent. More...

void	set_UseAntiAliasing (bool value)
	Setter for get_UseAntiAliasing. More...

void	set_UseHighQualityRendering (bool value)
	Setter for get_UseHighQualityRendering. More...

Static Public Member Functions
static const TypeInfo &	Type ()

Static Public Member Functions inherited from SaveOptions
static SharedPtr< SaveOptions >	CreateSaveOptions (SaveFormat saveFormat)
	Creates a save options object of a class suitable for the specified save format. More...

static SharedPtr< SaveOptions >	CreateSaveOptions (String fileName)
	Creates a save options object of a class suitable for the file extension specified in the given file name. More...

static const TypeInfo &	Type ()

Constructor & Destructor Documentation

◆ TxtSaveOptionsBase()

Aspose::Words::Saving::TxtSaveOptionsBase::TxtSaveOptionsBase ( )

Member Function Documentation

◆ get_Encoding()

System::SharedPtr<System::Text::Encoding> Aspose::Words::Saving::TxtSaveOptionsBase::get_Encoding ( ) const

Specifies the encoding to use when exporting in text formats. Default value is Encoding.UTF8.

Examples

Shows how to set encoding for a .txt output document.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
 
// Add some text with characters from outside the ASCII character set.
builder->Write(u"À È Ì Ò Ù.");
 
// Create a "TxtSaveOptions" object, which we can pass to the document's "Save" method
// to modify how we save the document to plaintext.
auto txtSaveOptions = MakeObject<TxtSaveOptions>();
 
// Verify that the "Encoding" property contains the appropriate encoding for our document's contents.
ASPOSE_ASSERT_EQ(System::Text::Encoding::get_UTF8(), txtSaveOptions->get_Encoding());
 
doc->Save(ArtifactsDir + u"TxtSaveOptions.Encoding.UTF8.txt", txtSaveOptions);
 
String docText = System::Text::Encoding::get_UTF8()->GetString(System::IO::File::ReadAllBytes(ArtifactsDir + u"TxtSaveOptions.Encoding.UTF8.txt"));
 
ASSERT_EQ(u"\ufeffÀ È Ì Ò Ù.\r\n", docText);
 
// Using an unsuitable encoding may result in a loss of document contents.
txtSaveOptions->set_Encoding(System::Text::Encoding::get_ASCII());
doc->Save(ArtifactsDir + u"TxtSaveOptions.Encoding.ASCII.txt", txtSaveOptions);
docText = System::Text::Encoding::get_ASCII()->GetString(System::IO::File::ReadAllBytes(ArtifactsDir + u"TxtSaveOptions.Encoding.ASCII.txt"));
 
ASSERT_EQ(u"? ? ? ? ?.\r\n", docText);

◆ get_ExportHeadersFootersMode()

Aspose::Words::Saving::TxtExportHeadersFootersMode Aspose::Words::Saving::TxtSaveOptionsBase::get_ExportHeadersFootersMode ( ) const

Specifies the way headers and footers are exported to the text formats. Default value is PrimaryOnly.

Examples

Shows how to specify how to export headers and footers to plain text format.

auto doc = MakeObject<Document>();
 
// Insert even and primary headers/footers into the document.
// The primary header/footers will override the even headers/footers.
doc->get_FirstSection()->get_HeadersFooters()->Add(MakeObject<HeaderFooter>(doc, HeaderFooterType::HeaderEven));
doc->get_FirstSection()->get_HeadersFooters()->idx_get(HeaderFooterType::HeaderEven)->AppendParagraph(u"Even header");
doc->get_FirstSection()->get_HeadersFooters()->Add(MakeObject<HeaderFooter>(doc, HeaderFooterType::FooterEven));
doc->get_FirstSection()->get_HeadersFooters()->idx_get(HeaderFooterType::FooterEven)->AppendParagraph(u"Even footer");
doc->get_FirstSection()->get_HeadersFooters()->Add(MakeObject<HeaderFooter>(doc, HeaderFooterType::HeaderPrimary));
doc->get_FirstSection()->get_HeadersFooters()->idx_get(HeaderFooterType::HeaderPrimary)->AppendParagraph(u"Primary header");
doc->get_FirstSection()->get_HeadersFooters()->Add(MakeObject<HeaderFooter>(doc, HeaderFooterType::FooterPrimary));
doc->get_FirstSection()->get_HeadersFooters()->idx_get(HeaderFooterType::FooterPrimary)->AppendParagraph(u"Primary footer");
 
// Insert pages to display these headers and footers.
auto builder = MakeObject<DocumentBuilder>(doc);
builder->Writeln(u"Page 1");
builder->InsertBreak(BreakType::PageBreak);
builder->Writeln(u"Page 2");
builder->InsertBreak(BreakType::PageBreak);
builder->Write(u"Page 3");
 
// Create a "TxtSaveOptions" object, which we can pass to the document's "Save" method
// to modify how we save the document to plaintext.
auto saveOptions = MakeObject<TxtSaveOptions>();
 
// Set the "ExportHeadersFootersMode" property to "TxtExportHeadersFootersMode.None"
// to not export any headers/footers.
// Set the "ExportHeadersFootersMode" property to "TxtExportHeadersFootersMode.PrimaryOnly"
// to only export primary headers/footers.
// Set the "ExportHeadersFootersMode" property to "TxtExportHeadersFootersMode.AllAtEnd"
// to place all headers and footers for all section bodies at the end of the document.
saveOptions->set_ExportHeadersFootersMode(txtExportHeadersFootersMode);
 
doc->Save(ArtifactsDir + u"TxtSaveOptions.ExportHeadersFooters.txt", saveOptions);
 
String docText = System::IO::File::ReadAllText(ArtifactsDir + u"TxtSaveOptions.ExportHeadersFooters.txt");
 
switch (txtExportHeadersFootersMode)
{
case TxtExportHeadersFootersMode::AllAtEnd:
    ASSERT_EQ(String(u"Page 1\r\n") + u"Page 2\r\n" + u"Page 3\r\n" + u"Even header\r\n\r\n" + u"Primary header\r\n\r\n" + u"Even footer\r\n\r\n" +
                  u"Primary footer\r\n\r\n",
              docText);
    break;
 
case TxtExportHeadersFootersMode::PrimaryOnly:
    ASSERT_EQ(String(u"Primary header\r\n") + u"Page 1\r\n" + u"Page 2\r\n" + u"Page 3\r\n" + u"Primary footer\r\n", docText);
    break;
 
case TxtExportHeadersFootersMode::None:
    ASSERT_EQ(String(u"Page 1\r\n") + u"Page 2\r\n" + u"Page 3\r\n", docText);
    break;
}

◆ get_ForcePageBreaks()

bool Aspose::Words::Saving::TxtSaveOptionsBase::get_ForcePageBreaks ( ) const

Allows to specify whether the page breaks should be preserved during export. The default value is false.

Examples

Shows how to specify whether to preserve page breaks when exporting a document to plaintext.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
 
builder->Writeln(u"Page 1");
builder->InsertBreak(BreakType::PageBreak);
builder->Writeln(u"Page 2");
builder->InsertBreak(BreakType::PageBreak);
builder->Writeln(u"Page 3");
 
// Create a "TxtSaveOptions" object, which we can pass to the document's "Save"
// method to modify how we save the document to plaintext.
auto saveOptions = MakeObject<TxtSaveOptions>();
 
// The Aspose.Words "Document" objects have page breaks, just like Microsoft Word documents.
// Save formats such as ".txt" are one continuous body of text without page breaks.
// Set the "ForcePageBreaks" property to "true" to preserve all page breaks in the form of '\f' characters.
// Set the "ForcePageBreaks" property to "false" to discard all page breaks.
saveOptions->set_ForcePageBreaks(forcePageBreaks);
 
doc->Save(ArtifactsDir + u"TxtSaveOptions.PageBreaks.txt", saveOptions);
 
// If we load a plaintext document with page breaks,
// the "Document" object will use them to split the body into pages.
doc = MakeObject<Document>(ArtifactsDir + u"TxtSaveOptions.PageBreaks.txt");
 
ASSERT_EQ(forcePageBreaks ? 3 : 1, doc->get_PageCount());

◆ get_ParagraphBreak()

System::String Aspose::Words::Saving::TxtSaveOptionsBase::get_ParagraphBreak ( ) const

Specifies the string to use as a paragraph break when exporting in text formats.

The default value is CrLf.

Examples

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

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
 
builder->Writeln(u"Paragraph 1.");
builder->Writeln(u"Paragraph 2.");
builder->Write(u"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.
auto txtSaveOptions = MakeObject<TxtSaveOptions>();
 
ASSERT_EQ(SaveFormat::Text, txtSaveOptions->get_SaveFormat());
 
// Set the "ParagraphBreak" to a custom value that we wish to put at the end of every paragraph.
txtSaveOptions->set_ParagraphBreak(u" End of paragraph.\n\n\t");
 
doc->Save(ArtifactsDir + u"TxtSaveOptions.ParagraphBreak.txt", txtSaveOptions);
 
String docText = System::IO::File::ReadAllText(ArtifactsDir + u"TxtSaveOptions.ParagraphBreak.txt");
 
ASSERT_EQ(String(u"Paragraph 1. End of paragraph.\n\n\t") + u"Paragraph 2. End of paragraph.\n\n\t" + u"Paragraph 3. End of paragraph.\n\n\t", docText);

◆ GetType()

virtual const System::TypeInfo& Aspose::Words::Saving::TxtSaveOptionsBase::GetType ( ) const

overridevirtual

Reimplemented from Aspose::Words::Saving::SaveOptions.

Reimplemented in Aspose::Words::Saving::TxtSaveOptions, and Aspose::Words::Saving::MarkdownSaveOptions.

◆ Is()

virtual bool Aspose::Words::Saving::TxtSaveOptionsBase::Is ( const System::TypeInfo & target ) const

overridevirtual

Reimplemented from Aspose::Words::Saving::SaveOptions.

Reimplemented in Aspose::Words::Saving::TxtSaveOptions, and Aspose::Words::Saving::MarkdownSaveOptions.

◆ set_Encoding()

void Aspose::Words::Saving::TxtSaveOptionsBase::set_Encoding ( System::SharedPtr< System::Text::Encoding > value )

Setter for Aspose::Words::Saving::TxtSaveOptionsBase::get_Encoding.

◆ set_ExportHeadersFootersMode()

void Aspose::Words::Saving::TxtSaveOptionsBase::set_ExportHeadersFootersMode ( Aspose::Words::Saving::TxtExportHeadersFootersMode value )

Setter for Aspose::Words::Saving::TxtSaveOptionsBase::get_ExportHeadersFootersMode.

◆ set_ForcePageBreaks()

void Aspose::Words::Saving::TxtSaveOptionsBase::set_ForcePageBreaks ( bool value )

Setter for Aspose::Words::Saving::TxtSaveOptionsBase::get_ForcePageBreaks.

◆ set_ParagraphBreak()

void Aspose::Words::Saving::TxtSaveOptionsBase::set_ParagraphBreak ( System::String value )

Setter for Aspose::Words::Saving::TxtSaveOptionsBase::get_ParagraphBreak.

◆ Type()

static const System::TypeInfo& Aspose::Words::Saving::TxtSaveOptionsBase::Type ( )

static

Public Member Functions

Static Public Member Functions