Aspose::Cells::ITxtSaveOptions Class Referenceabstract

Repesents the save options for csv/tab delimitered/other text format. More...

Inherits Aspose::Cells::ISaveOptions.

Public Member Functions

virtual Aspose::Cells::Systems::Char GetSeparator ()=0
 Gets char Delimiter of text file. More...
 
virtual void SetSeparator (Aspose::Cells::Systems::Char value)=0
 Sets char Delimiter of text file. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::String > GetSeparatorString ()=0
 Gets the a string value as separator. More...
 
virtual void SetSeparatorString (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
 Sets a string value as separator. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::Text::Encoding > GetEncoding ()=0
 Gets the default encoding. Only applies for csv file. More...
 
virtual void SetEncoding (intrusive_ptr< Aspose::Cells::Systems::Text::Encoding > value)=0
 Sets the default encoding. Only applies for csv file. More...
 
virtual bool GetAlwaysQuoted ()=0
 Indicates whether always adding '"' for each field. If true then all values will be quoted; If false then values will only be quoted when needed(for example, when values contain special characters such as '"' , '
' or separator character). Default is false. More...
 
virtual void SetAlwaysQuoted (bool value)=0
 Indicates whether always adding '"' for each field. If true then all values will be quoted; If false then values will only be quoted when needed(for example, when values contain special characters such as '"' , '
' or separator character). Default is false. More...
 
virtual Aspose::Cells::TxtValueQuoteType GetQuoteType ()=0
 Gets how to quote values in the exported text file. More...
 
virtual void SetQuoteType (Aspose::Cells::TxtValueQuoteType value)=0
 Sets how to quote values in the exported text file. More...
 
virtual Aspose::Cells::CellValueFormatStrategy GetFormatStrategy ()=0
 Gets the format strategy when exporting the cell value as string. More...
 
virtual void SetFormatStrategy (Aspose::Cells::CellValueFormatStrategy value)=0
 Sets the format strategy when exporting the cell value as string. More...
 
virtual bool GetTrimLeadingBlankRowAndColumn ()=0
 Indicates whether leading blank rows and columns should be trimmed like what ms excel does. Default is true. More...
 
virtual void SetTrimLeadingBlankRowAndColumn (bool value)=0
 Indicates whether leading blank rows and columns should be trimmed like what ms excel does. Default is true. More...
 
virtual bool GetTrimTailingBlankCells ()=0
 Indicates whether tailing blank cells in one row should be trimmed. Default is false. More...
 
virtual void SetTrimTailingBlankCells (bool value)=0
 Indicates whether tailing blank cells in one row should be trimmed. Default is false. More...
 
virtual bool GetKeepSeparatorsForBlankRow ()=0
 Indicates whether separators should be output for blank row. Default value is false so by default the content for blank row will be empty. More...
 
virtual void SetKeepSeparatorsForBlankRow (bool value)=0
 Indicates whether separators should be output for blank row. Default value is false so by default the content for blank row will be empty. More...
 
virtual intrusive_ptr< Aspose::Cells::ICellAreaGetExportICellArea ()=0
 The range of cells to be exported. More...
 
virtual void SetExportICellArea (intrusive_ptr< Aspose::Cells::ICellArea > value)=0
 The range of cells to be exported. More...
 
virtual bool GetExportQuotePrefix ()=0
 Indicates whether the single quote sign should be exported as part of the value of one cell when Style.QuotePrefix is true for it. Default is false. More...
 
virtual void SetExportQuotePrefix (bool value)=0
 Indicates whether the single quote sign should be exported as part of the value of one cell when Style.QuotePrefix is true for it. Default is false. More...
 
virtual bool GetExportAllSheets ()=0
 Indicates whether exporting all sheets to the text file. If it is false, only export the activesheet, just like MS Excel. More...
 
virtual void SetExportAllSheets (bool value)=0
 Indicates whether exporting all sheets to the text file. If it is false, only export the activesheet, just like MS Excel. More...
 
- Public Member Functions inherited from Aspose::Cells::ISaveOptions
virtual Aspose::Cells::SaveFormat GetSaveFormat ()=0
 Gets the save file format. More...
 
virtual bool GetClearData ()=0
 Make the workbook empty after saving the file. More...
 
virtual void SetClearData (bool value)=0
 Make the workbook empty after saving the file. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::String > GetCachedFileFolder ()=0
 The cached file folder is used to store some large data. More...
 
virtual void SetCachedFileFolder (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
 The cached file folder is used to store some large data. More...
 
virtual bool GetValidateMergedAreas ()=0
 Indicates whether validate merged cells before saving the file. More...
 
virtual void SetValidateMergedAreas (bool value)=0
 Indicates whether validate merged cells before saving the file. More...
 
virtual bool GetMergeAreas ()=0
 Indicates whether merge the areas of conditional formatting and validation before saving the file. More...
 
virtual void SetMergeAreas (bool value)=0
 Indicates whether merge the areas of conditional formatting and validation before saving the file. More...
 
virtual bool GetCreateDirectory ()=0
 If true and the directory does not exist, the directory will be automatically created before saving the file. More...
 
virtual void SetCreateDirectory (bool value)=0
 If true and the directory does not exist, the directory will be automatically created before saving the file. More...
 
virtual bool GetSortNames ()=0
 Indicates whether sorting defined names before saving file. More...
 
virtual void SetSortNames (bool value)=0
 Indicates whether sorting defined names before saving file. More...
 
virtual bool GetSortExternalNames ()=0
 Indicates whether sorting external defined names before saving file. More...
 
virtual void SetSortExternalNames (bool value)=0
 Indicates whether sorting external defined names before saving file. More...
 
virtual bool GetRefreshChartCache ()=0
 Indicates whether refreshing chart cache data More...
 
virtual void SetRefreshChartCache (bool value)=0
 Indicates whether refreshing chart cache data More...
 
virtual bool GetUpdateSmartArt ()=0
 Indicates whether updating smart art setting. The default value is false. More...
 
virtual void SetUpdateSmartArt (bool value)=0
 Indicates whether updating smart art setting. The default value is false. More...
 

Detailed Description

Repesents the save options for csv/tab delimitered/other text format.

Member Function Documentation

◆ GetAlwaysQuoted()

virtual bool Aspose::Cells::ITxtSaveOptions::GetAlwaysQuoted ( )
pure virtual

Indicates whether always adding '"' for each field. If true then all values will be quoted; If false then values will only be quoted when needed(for example, when values contain special characters such as '"' , '
' or separator character). Default is false.

◆ GetEncoding()

virtual intrusive_ptr<Aspose::Cells::Systems::Text::Encoding> Aspose::Cells::ITxtSaveOptions::GetEncoding ( )
pure virtual

Gets the default encoding. Only applies for csv file.

◆ GetExportAllSheets()

virtual bool Aspose::Cells::ITxtSaveOptions::GetExportAllSheets ( )
pure virtual

Indicates whether exporting all sheets to the text file. If it is false, only export the activesheet, just like MS Excel.

The defult value is false.

◆ GetExportICellArea()

virtual intrusive_ptr<Aspose::Cells::ICellArea> Aspose::Cells::ITxtSaveOptions::GetExportICellArea ( )
pure virtual

The range of cells to be exported.

If the exported area has been specified, TrimLeadingBlankRowAndColumn

will takes no effect.

◆ GetExportQuotePrefix()

virtual bool Aspose::Cells::ITxtSaveOptions::GetExportQuotePrefix ( )
pure virtual

Indicates whether the single quote sign should be exported as part of the value of one cell when Style.QuotePrefix is true for it. Default is false.

◆ GetFormatStrategy()

virtual Aspose::Cells::CellValueFormatStrategy Aspose::Cells::ITxtSaveOptions::GetFormatStrategy ( )
pure virtual

Gets the format strategy when exporting the cell value as string.

◆ GetKeepSeparatorsForBlankRow()

virtual bool Aspose::Cells::ITxtSaveOptions::GetKeepSeparatorsForBlankRow ( )
pure virtual

Indicates whether separators should be output for blank row. Default value is false so by default the content for blank row will be empty.

◆ GetQuoteType()

virtual Aspose::Cells::TxtValueQuoteType Aspose::Cells::ITxtSaveOptions::GetQuoteType ( )
pure virtual

Gets how to quote values in the exported text file.

◆ GetSeparator()

virtual Aspose::Cells::Systems::Char Aspose::Cells::ITxtSaveOptions::GetSeparator ( )
pure virtual

Gets char Delimiter of text file.

◆ GetSeparatorString()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::ITxtSaveOptions::GetSeparatorString ( )
pure virtual

Gets the a string value as separator.

◆ GetTrimLeadingBlankRowAndColumn()

virtual bool Aspose::Cells::ITxtSaveOptions::GetTrimLeadingBlankRowAndColumn ( )
pure virtual

Indicates whether leading blank rows and columns should be trimmed like what ms excel does. Default is true.

When saving with LightCells mode, this option takes no effect. User should control the output range by the implementation of LightCellsDataProvider

or by speicifing IExportArea

◆ GetTrimTailingBlankCells()

virtual bool Aspose::Cells::ITxtSaveOptions::GetTrimTailingBlankCells ( )
pure virtual

Indicates whether tailing blank cells in one row should be trimmed. Default is false.

◆ SetAlwaysQuoted()

virtual void Aspose::Cells::ITxtSaveOptions::SetAlwaysQuoted ( bool  value)
pure virtual

Indicates whether always adding '"' for each field. If true then all values will be quoted; If false then values will only be quoted when needed(for example, when values contain special characters such as '"' , '
' or separator character). Default is false.

◆ SetEncoding()

virtual void Aspose::Cells::ITxtSaveOptions::SetEncoding ( intrusive_ptr< Aspose::Cells::Systems::Text::Encoding >  value)
pure virtual

Sets the default encoding. Only applies for csv file.

◆ SetExportAllSheets()

virtual void Aspose::Cells::ITxtSaveOptions::SetExportAllSheets ( bool  value)
pure virtual

Indicates whether exporting all sheets to the text file. If it is false, only export the activesheet, just like MS Excel.

The defult value is false.

◆ SetExportICellArea()

virtual void Aspose::Cells::ITxtSaveOptions::SetExportICellArea ( intrusive_ptr< Aspose::Cells::ICellArea value)
pure virtual

The range of cells to be exported.

If the exported area has been specified, TrimLeadingBlankRowAndColumn

will takes no effect.

◆ SetExportQuotePrefix()

virtual void Aspose::Cells::ITxtSaveOptions::SetExportQuotePrefix ( bool  value)
pure virtual

Indicates whether the single quote sign should be exported as part of the value of one cell when Style.QuotePrefix is true for it. Default is false.

◆ SetFormatStrategy()

virtual void Aspose::Cells::ITxtSaveOptions::SetFormatStrategy ( Aspose::Cells::CellValueFormatStrategy  value)
pure virtual

Sets the format strategy when exporting the cell value as string.

◆ SetKeepSeparatorsForBlankRow()

virtual void Aspose::Cells::ITxtSaveOptions::SetKeepSeparatorsForBlankRow ( bool  value)
pure virtual

Indicates whether separators should be output for blank row. Default value is false so by default the content for blank row will be empty.

◆ SetQuoteType()

virtual void Aspose::Cells::ITxtSaveOptions::SetQuoteType ( Aspose::Cells::TxtValueQuoteType  value)
pure virtual

Sets how to quote values in the exported text file.

◆ SetSeparator()

virtual void Aspose::Cells::ITxtSaveOptions::SetSeparator ( Aspose::Cells::Systems::Char  value)
pure virtual

Sets char Delimiter of text file.

◆ SetSeparatorString()

virtual void Aspose::Cells::ITxtSaveOptions::SetSeparatorString ( intrusive_ptr< Aspose::Cells::Systems::String >  value)
pure virtual

Sets a string value as separator.

◆ SetTrimLeadingBlankRowAndColumn()

virtual void Aspose::Cells::ITxtSaveOptions::SetTrimLeadingBlankRowAndColumn ( bool  value)
pure virtual

Indicates whether leading blank rows and columns should be trimmed like what ms excel does. Default is true.

When saving with LightCells mode, this option takes no effect. User should control the output range by the implementation of LightCellsDataProvider

or by speicifing IExportArea

◆ SetTrimTailingBlankCells()

virtual void Aspose::Cells::ITxtSaveOptions::SetTrimTailingBlankCells ( bool  value)
pure virtual

Indicates whether tailing blank cells in one row should be trimmed. Default is false.