com.aspose.cells

com.aspose.cells

Class TxtSaveOptions

  • java.lang.Object 
public class TxtSaveOptions 
extends SaveOptions

Represents the save options for csv/tab delimited/other text format.

Constructor Summary
TxtSaveOptions()
Creates text file save options.
TxtSaveOptions(intformat)
Creates text file save options.
 
Property Getters/Setters Summary
booleangetAlwaysQuoted()
void
setAlwaysQuoted(boolean)
           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 '"' , '\n' or separator character). Default is false.
java.lang.StringgetCachedFileFolder()
void
setCachedFileFolder(java.lang.String)
           The cached file folder is used to store some large data.
booleangetClearData()
void
setClearData(boolean)
           Make the workbook empty after saving the file.
booleangetCreateDirectory()
void
setCreateDirectory(boolean)
           If true and the directory does not exist, the directory will be automatically created before saving the file.
booleangetEnableHTTPCompression()
void
setEnableHTTPCompression(boolean)
           Indicates if http compression is to be used in user's IIS.
com.aspose.cells.EncodinggetEncoding()
void
setEncoding(com.aspose.cells.Encoding)
           Gets and sets the default encoding.
booleangetExportAllSheets()
void
setExportAllSheets(boolean)
           Indicates whether exporting all sheets to the text file. If it is false, only export the activesheet, just like MS Excel.
CellAreagetExportArea()
void
setExportArea(CellArea)
           The range of cells to be exported.
booleangetExportQuotePrefix()
void
setExportQuotePrefix(boolean)
           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.
intgetFormatStrategy()
void
setFormatStrategy(int)
           Gets and sets the format strategy when exporting the cell value as string. The value of the property is CellValueFormatStrategy integer constant.
booleangetKeepSeparatorsForBlankRow()
void
setKeepSeparatorsForBlankRow(boolean)
           Indicates whether separators should be output for blank row. Default value is false so by default the content for blank row will be empty.
LightCellsDataProvidergetLightCellsDataProvider()
void
setLightCellsDataProvider(LightCellsDataProvider)
           The Data provider to provide cells data for saving workbook in light mode.
booleangetMergeAreas()
void
setMergeAreas(boolean)
           Indicates whether merge the areas of conditional formatting and validation before saving the file.
java.lang.StringgetPdfExportImagesFolder()
void
setPdfExportImagesFolder(java.lang.String)
           The physical folder where images will be saved when exporting a workbook to Aspose.Pdf XML format. Default is an empty string.
intgetQuoteType()
void
setQuoteType(int)
           Gets or sets how to quote values in the exported text file. The value of the property is TxtValueQuoteType integer constant.
booleangetRefreshChartCache()
void
setRefreshChartCache(boolean)
           Indicates whether refreshing chart cache data
intgetSaveFormat()
Gets the save file format. The value of the property is SaveFormat integer constant.
chargetSeparator()
void
setSeparator(char)
           Gets and sets char Delimiter of text file.
java.lang.StringgetSeparatorString()
void
setSeparatorString(java.lang.String)
           Gets and sets the a string value as separator.
booleangetSortExternalNames()
void
setSortExternalNames(boolean)
           Indicates whether sorting external defined names before saving file.
booleangetSortNames()
void
setSortNames(boolean)
           Indicates whether sorting defined names before saving file.
booleangetTrimLeadingBlankRowAndColumn()
void
setTrimLeadingBlankRowAndColumn(boolean)
           Indicates whether leading blank rows and columns should be trimmed like what ms excel does. Default is true.
booleangetUpdateSmartArt()
void
setUpdateSmartArt(boolean)
           Indicates whether updating smart art setting. The default value is false.
booleangetValidateMergedAreas()
void
setValidateMergedAreas(boolean)
           Indicates whether validate merged cells before saving the file.
IWarningCallbackgetWarningCallback()
void
setWarningCallback(IWarningCallback)
           Gets or sets warning callback.
 

    • Constructor Detail

      • TxtSaveOptions

        public TxtSaveOptions()
        Creates text file save options.

      • TxtSaveOptions

        public TxtSaveOptions(int format)
        Creates text file save options.
        Parameters:
        format - A SaveFormat value. The save format of the text file.

    • Property Getters/Setters Detail

      • getSeparator/setSeparator

        public char getSeparator() / public void setSeparator(char value)
        Gets and sets char Delimiter of text file.

      • getSeparatorString/setSeparatorString

        public java.lang.String getSeparatorString() / public void setSeparatorString(java.lang.String value)
        Gets and sets the a string value as separator.

      • getEncoding/setEncoding

        public com.aspose.cells.Encoding getEncoding() / public void setEncoding(com.aspose.cells.Encoding value)
        Gets and sets the default encoding.

      • getAlwaysQuoted/setAlwaysQuoted

        public boolean getAlwaysQuoted() / public void setAlwaysQuoted(boolean value)
        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 '"' , '\n' or separator character). Default is false. NOTE: This member is now obsolete. Instead, please use QuoteType property instead. This property will be removed 12 months later since August 2012. Aspose apologizes for any inconvenience you may have experienced.

      • getQuoteType/setQuoteType

        public int getQuoteType() / public void setQuoteType(int value)
        Gets or sets how to quote values in the exported text file. The value of the property is TxtValueQuoteType integer constant.

      • getFormatStrategy/setFormatStrategy

        public int getFormatStrategy() / public void setFormatStrategy(int value)
        Gets and sets the format strategy when exporting the cell value as string. The value of the property is CellValueFormatStrategy integer constant.

      • getLightCellsDataProvider/setLightCellsDataProvider

        public LightCellsDataProvider getLightCellsDataProvider() / public void setLightCellsDataProvider(LightCellsDataProvider value)
        The Data provider to provide cells data for saving workbook in light mode.

      • getTrimLeadingBlankRowAndColumn/setTrimLeadingBlankRowAndColumn

        public boolean getTrimLeadingBlankRowAndColumn() / public void setTrimLeadingBlankRowAndColumn(boolean value)
        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 ExportArea

      • getKeepSeparatorsForBlankRow/setKeepSeparatorsForBlankRow

        public boolean getKeepSeparatorsForBlankRow() / public void setKeepSeparatorsForBlankRow(boolean value)
        Indicates whether separators should be output for blank row. Default value is false so by default the content for blank row will be empty.

      • getExportArea/setExportArea

        public CellArea getExportArea() / public void setExportArea(CellArea value)
        The range of cells to be exported. If the exported area has been specified, TrimLeadingBlankRowAndColumn will takes no effect.

      • getExportQuotePrefix/setExportQuotePrefix

        public boolean getExportQuotePrefix() / public void setExportQuotePrefix(boolean value)
        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.

      • getExportAllSheets/setExportAllSheets

        public boolean getExportAllSheets() / public void setExportAllSheets(boolean value)
        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.

      • getSaveFormat

        public int getSaveFormat()
        Gets the save file format. The value of the property is SaveFormat integer constant.

      • getClearData/setClearData

        public boolean getClearData() / public void setClearData(boolean value)
        Make the workbook empty after saving the file.

      • getCachedFileFolder/setCachedFileFolder

        public java.lang.String getCachedFileFolder() / public void setCachedFileFolder(java.lang.String value)
        The cached file folder is used to store some large data.

      • getValidateMergedAreas/setValidateMergedAreas

        public boolean getValidateMergedAreas() / public void setValidateMergedAreas(boolean value)
        Indicates whether validate merged cells before saving the file. The default value is false.

      • getMergeAreas/setMergeAreas

        public boolean getMergeAreas() / public void setMergeAreas(boolean value)
        Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is false.

      • getCreateDirectory/setCreateDirectory

        public boolean getCreateDirectory() / public void setCreateDirectory(boolean value)
        If true and the directory does not exist, the directory will be automatically created before saving the file. The default value is false.

      • getSortNames/setSortNames

        public boolean getSortNames() / public void setSortNames(boolean value)
        Indicates whether sorting defined names before saving file.

      • getSortExternalNames/setSortExternalNames

        public boolean getSortExternalNames() / public void setSortExternalNames(boolean value)
        Indicates whether sorting external defined names before saving file.

      • getRefreshChartCache/setRefreshChartCache

        public boolean getRefreshChartCache() / public void setRefreshChartCache(boolean value)
        Indicates whether refreshing chart cache data

      • getPdfExportImagesFolder/setPdfExportImagesFolder

        public java.lang.String getPdfExportImagesFolder() / public void setPdfExportImagesFolder(java.lang.String value)
        The physical folder where images will be saved when exporting a workbook to Aspose.Pdf XML format. Default is an empty string.

      • getEnableHTTPCompression/setEnableHTTPCompression

        public boolean getEnableHTTPCompression() / public void setEnableHTTPCompression(boolean value)
        Indicates if http compression is to be used in user's IIS. Please specify this property to true if http compression is used.

      • getWarningCallback/setWarningCallback

        public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)
        Gets or sets warning callback.

      • getUpdateSmartArt/setUpdateSmartArt

        public boolean getUpdateSmartArt() / public void setUpdateSmartArt(boolean value)
        Indicates whether updating smart art setting. The default value is false. Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.

    setSeparator

    public voidsetSeparator(charvalue)
    Gets and sets char Delimiter of text file.

    setSeparatorString

    public voidsetSeparatorString(java.lang.Stringvalue)
    Gets and sets the a string value as separator.

    setEncoding

    public voidsetEncoding(com.aspose.cells.Encodingvalue)
    Gets and sets the default encoding.

    setAlwaysQuoted

    public voidsetAlwaysQuoted(booleanvalue)
    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 '"' , '\n' or separator character). Default is false. NOTE: This member is now obsolete. Instead, please use QuoteType property instead. This property will be removed 12 months later since August 2012. Aspose apologizes for any inconvenience you may have experienced.

    setQuoteType

    public voidsetQuoteType(intvalue)
    Gets or sets how to quote values in the exported text file. The value of the property is TxtValueQuoteType integer constant.

    setFormatStrategy

    public voidsetFormatStrategy(intvalue)
    Gets and sets the format strategy when exporting the cell value as string. The value of the property is CellValueFormatStrategy integer constant.

    setLightCellsDataProvider

    public voidsetLightCellsDataProvider(LightCellsDataProvider value)
    The Data provider to provide cells data for saving workbook in light mode.

    setTrimLeadingBlankRowAndColumn

    public voidsetTrimLeadingBlankRowAndColumn(booleanvalue)
    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 ExportArea

    setKeepSeparatorsForBlankRow

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

    setExportArea

    public voidsetExportArea(CellArea value)
    The range of cells to be exported. If the exported area has been specified, TrimLeadingBlankRowAndColumn will takes no effect.

    setExportQuotePrefix

    public voidsetExportQuotePrefix(booleanvalue)
    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.

    setExportAllSheets

    public voidsetExportAllSheets(booleanvalue)
    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.

    setClearData

    public voidsetClearData(booleanvalue)
    Make the workbook empty after saving the file.

    setCachedFileFolder

    public voidsetCachedFileFolder(java.lang.Stringvalue)
    The cached file folder is used to store some large data.

    setValidateMergedAreas

    public voidsetValidateMergedAreas(booleanvalue)
    Indicates whether validate merged cells before saving the file. The default value is false.

    setMergeAreas

    public voidsetMergeAreas(booleanvalue)
    Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is false.

    setCreateDirectory

    public voidsetCreateDirectory(booleanvalue)
    If true and the directory does not exist, the directory will be automatically created before saving the file. The default value is false.

    setSortNames

    public voidsetSortNames(booleanvalue)
    Indicates whether sorting defined names before saving file.

    setSortExternalNames

    public voidsetSortExternalNames(booleanvalue)
    Indicates whether sorting external defined names before saving file.

    setRefreshChartCache

    public voidsetRefreshChartCache(booleanvalue)
    Indicates whether refreshing chart cache data

    setPdfExportImagesFolder

    public voidsetPdfExportImagesFolder(java.lang.Stringvalue)
    The physical folder where images will be saved when exporting a workbook to Aspose.Pdf XML format. Default is an empty string.

    setEnableHTTPCompression

    public voidsetEnableHTTPCompression(booleanvalue)
    Indicates if http compression is to be used in user's IIS. Please specify this property to true if http compression is used.

    setWarningCallback

    public voidsetWarningCallback(IWarningCallback value)
    Gets or sets warning callback.

    setUpdateSmartArt

    public voidsetUpdateSmartArt(booleanvalue)
    Indicates whether updating smart art setting. The default value is false. Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.