com.aspose.cells

com.aspose.cells

Class DocxSaveOptions

  • java.lang.Object 
public class DocxSaveOptions 
extends SaveOptions

Represents options of saving .docx file.

Constructor Summary
DocxSaveOptions()
Represents options of saving .docx file.
DocxSaveOptions(booleansaveAsImage)
Represents options of saving .docx file.
 
Property Getters/Setters Summary
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.
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.
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.
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.
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

      • DocxSaveOptions

        public DocxSaveOptions()
        Represents options of saving .docx file.

      • DocxSaveOptions

        public DocxSaveOptions(boolean saveAsImage)
        Represents options of saving .docx file.
        Parameters:
        saveAsImage - If True, the workbook will be converted into some pictures of .docx file. If False, the workbook will be converted into some tables of .docx file.

    • Property Getters/Setters Detail

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

    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.