com.aspose.cells

com.aspose.cells

Class OoxmlSaveOptions

  • java.lang.Object 
public class OoxmlSaveOptions 
extends SaveOptions

Represents the options of saving office open xml file.

Constructor Summary
OoxmlSaveOptions()
Creates the options for saving office open xml file.
OoxmlSaveOptions(intsaveFormat)
Creates the options for saving office open xml file.
 
Property Getters/Setters Summary
java.lang.StringgetCachedFileFolder()
void
setCachedFileFolder(java.lang.Stringvalue)
           The cached file folder is used to store some large data.
booleangetClearData()
void
setClearData(booleanvalue)
           Make the workbook empty after saving the file.
intgetCompressionType()
void
setCompressionType(intvalue)
           Gets and sets the compression type for ooxml file. The value of the property is OoxmlCompressionType integer constant.
booleangetCreateDirectory()
void
setCreateDirectory(booleanvalue)
           If true and the directory does not exist, the directory will be automatically created before saving the file.
booleangetEmbedOoxmlAsOleObject()
void
setEmbedOoxmlAsOleObject(booleanvalue)
           Indicates whether embedding Ooxml files of OleObject as ole object.
booleangetEnableHTTPCompression()
void
setEnableHTTPCompression(booleanvalue)
           Indicates if http compression is to be used in user's IIS.
booleangetEnableZip64()
void
setEnableZip64(booleanvalue)
           Always use ZIP64 extensions when writing zip archives, even when unnecessary.
booleangetExportCellName()
void
setExportCellName(booleanvalue)
           Indicates if export cell name to Excel2007 .xlsx (.xlsm, .xltx, .xltm) file. If the output file may be accessed by SQL Server DTS, this value must be true. Setting the value to false will highly increase the performance and reduce the file size when creating large file. Default value is true.
LightCellsDataProvidergetLightCellsDataProvider()
void
setLightCellsDataProvider(LightCellsDataProvider value)
           The Data provider to provide cells data for saving workbook in light mode.
booleangetMergeAreas()
void
setMergeAreas(booleanvalue)
           Indicates whether merge the areas of conditional formatting and validation before saving the file.
java.lang.StringgetPdfExportImagesFolder()
void
setPdfExportImagesFolder(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.
booleangetRefreshChartCache()
void
setRefreshChartCache(booleanvalue)
           Indicates whether refreshing chart cache data
intgetSaveFormat()
Gets the save file format. The value of the property is SaveFormat integer constant.
booleangetSortNames()
void
setSortNames(booleanvalue)
           Indicates whether sorting defined names before saving file.
booleangetUpdateSmartArt()
void
setUpdateSmartArt(booleanvalue)
           Indicates whether updating smart art setting. The default value is false.
booleangetUpdateZoom()
void
setUpdateZoom(booleanvalue)
           Indicates whether update scaling factor before saving the file if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled.
booleangetValidateMergedAreas()
void
setValidateMergedAreas(booleanvalue)
           Indicates whether validate merged cells before saving the file.
IWarningCallbackgetWarningCallback()
void
setWarningCallback(IWarningCallback value)
           Gets or sets warning callback.
 

    • Constructor Detail

      • OoxmlSaveOptions

        public OoxmlSaveOptions()
        Creates the options for saving office open xml file.

      • OoxmlSaveOptions

        public OoxmlSaveOptions(int saveFormat)
        Creates the options for saving office open xml file.
        Parameters:
        saveFormat - A SaveFormat value. The file format. It must be xlsx,xltx,xlsm,xltm.

    • Property Getters/Setters Detail

      • getExportCellName/setExportCellName

        public boolean getExportCellName() / public void setExportCellName(boolean value)
        Indicates if export cell name to Excel2007 .xlsx (.xlsm, .xltx, .xltm) file. If the output file may be accessed by SQL Server DTS, this value must be true. Setting the value to false will highly increase the performance and reduce the file size when creating large file. Default value is true.

      • getLightCellsDataProvider/setLightCellsDataProvider

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

      • getUpdateZoom/setUpdateZoom

        public boolean getUpdateZoom() / public void setUpdateZoom(boolean value)
        Indicates whether update scaling factor before saving the file if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled. The default value is false for permance.

      • getEnableZip64/setEnableZip64

        public boolean getEnableZip64() / public void setEnableZip64(boolean value)
        Always use ZIP64 extensions when writing zip archives, even when unnecessary.

      • 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.

      • getEmbedOoxmlAsOleObject/setEmbedOoxmlAsOleObject

        public boolean getEmbedOoxmlAsOleObject() / public void setEmbedOoxmlAsOleObject(boolean value)
        Indicates whether embedding Ooxml files of OleObject as ole object. Only for OleObject.

      • getCompressionType/setCompressionType

        public int getCompressionType() / public void setCompressionType(int value)
        Gets and sets the compression type for ooxml file. The value of the property is OoxmlCompressionType integer constant.The default value is OoxmlCompressionType.Level2.

      • 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.

      • 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.

    setExportCellName

    public voidsetExportCellName(booleanvalue)
    Indicates if export cell name to Excel2007 .xlsx (.xlsm, .xltx, .xltm) file. If the output file may be accessed by SQL Server DTS, this value must be true. Setting the value to false will highly increase the performance and reduce the file size when creating large file. Default value is true.

    setLightCellsDataProvider

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

    setUpdateZoom

    public voidsetUpdateZoom(booleanvalue)
    Indicates whether update scaling factor before saving the file if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled. The default value is false for permance.

    setEnableZip64

    public voidsetEnableZip64(booleanvalue)
    Always use ZIP64 extensions when writing zip archives, even when unnecessary.

    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.

    setEmbedOoxmlAsOleObject

    public voidsetEmbedOoxmlAsOleObject(booleanvalue)
    Indicates whether embedding Ooxml files of OleObject as ole object. Only for OleObject.

    setCompressionType

    public voidsetCompressionType(intvalue)
    Gets and sets the compression type for ooxml file. The value of the property is OoxmlCompressionType integer constant.The default value is OoxmlCompressionType.Level2.

    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.

    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.