com.aspose.cells

com.aspose.cells

Class XpsSaveOptions

  • java.lang.Object 
public class XpsSaveOptions 
extends SaveOptions

Represents the additional options when saving the file as the Xps.

Constructor Summary
XpsSaveOptions()
Creates options for saving xps file.
XpsSaveOptions(intsaveFormat)
Creates options for saving xps 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.
booleangetCreateDirectory()
void
setCreateDirectory(booleanvalue)
           If true and the directory does not exist, the directory will be automatically created before saving the file.
booleangetEnableHTTPCompression()
void
setEnableHTTPCompression(booleanvalue)
           Indicates if http compression is to be used in user's IIS.
booleangetMergeAreas()
void
setMergeAreas(booleanvalue)
           Indicates whether merge the areas of conditional formatting and validation before saving the file.
booleangetOnePagePerSheet()
void
setOnePagePerSheet(booleanvalue)
           If OnePagePerSheet is true , all content of one sheet will output to only one page in result. The paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.
intgetPageCount()
void
setPageCount(intvalue)
           Gets or sets the number of pages to save.
intgetPageIndex()
void
setPageIndex(intvalue)
           Gets or sets the 0-based index of the first page to save.
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.
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

      • XpsSaveOptions

        public XpsSaveOptions()
        Creates options for saving xps file.

      • XpsSaveOptions

        public XpsSaveOptions(int saveFormat)
        Creates options for saving xps file.
        Parameters:
        saveFormat - A SaveFormat value. The save format, it must be xps format.

    • Property Getters/Setters Detail

      • getOnePagePerSheet/setOnePagePerSheet

        public boolean getOnePagePerSheet() / public void setOnePagePerSheet(boolean value)
        If OnePagePerSheet is true , all content of one sheet will output to only one page in result. The paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.

      • getPageIndex/setPageIndex

        public int getPageIndex() / public void setPageIndex(int value)
        Gets or sets the 0-based index of the first page to save. Default is 0.

      • getPageCount/setPageCount

        public int getPageCount() / public void setPageCount(int value)
        Gets or sets the number of pages to save. Default is System.Int32.MaxValue which means all pages will be rendered..

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

    setOnePagePerSheet

    public voidsetOnePagePerSheet(booleanvalue)
    If OnePagePerSheet is true , all content of one sheet will output to only one page in result. The paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.

    setPageIndex

    public voidsetPageIndex(intvalue)
    Gets or sets the 0-based index of the first page to save. Default is 0.

    setPageCount

    public voidsetPageCount(intvalue)
    Gets or sets the number of pages to save. Default is System.Int32.MaxValue which means all pages will be rendered..

    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.