com.aspose.cells
Class XpsSaveOptions

java.lang.Object
  SaveOptions
      PaginatedSaveOptions
          com.aspose.cells.XpsSaveOptions

public class XpsSaveOptions 
extends PaginatedSaveOptions

XpsSaveOptions

public XpsSaveOptions()

Creates options for saving xps file.

XpsSaveOptions

public XpsSaveOptions(int saveFormat)

Creates options for saving xps file.

NOTE: This constructor is now obsolete. Instead, please use XpsSaveOptions() constructor. This property will be removed 12 months later since August 2022. Aspose apologizes for any inconvenience you may have experienced.

Parameters:

saveFormat - A SaveFormat value. The save format, it must be xps format.

public java.lang.String getDefaultFont() / public void setDefaultFont(java.lang.String value)

When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set the DefaultFont such as MingLiu or MS Gothic to show these characters. If this property is not set, Aspose.Cells will use system default font to show these unicode characters.

public void setDefaultFont(java.lang.String value)

public boolean getCheckWorkbookDefaultFont() / public void setCheckWorkbookDefaultFont(boolean value)

When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set this to true to try to use workbook's default font to show these characters first.

Default is true.

public void setCheckWorkbookDefaultFont(boolean value)

public boolean getCheckFontCompatibility() / public void setCheckFontCompatibility(boolean value)

Indicates whether to check font compatibility for every character in text.

The default value is true. Disable this property may give better performance. But when the default or specified font of text/character cannot be used to render it, unreadable characters(such as block) maybe occur in the generated pdf. For such situation user should keep this property as true so that alternative font can be searched and used to render the text instead;

public void setCheckFontCompatibility(boolean value)

public boolean isFontSubstitutionCharGranularity() / public void setFontSubstitutionCharGranularity(boolean value)

Indicates whether to only substitute the font of character when the cell font is not compatibility for it.

Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.

public void setFontSubstitutionCharGranularity(boolean value)

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.

public void setOnePagePerSheet(boolean value)

public boolean getAllColumnsInOnePagePerSheet() / public void setAllColumnsInOnePagePerSheet(boolean value)

If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be ignored, and the other settings of pagesetup will still take effect.

public void setAllColumnsInOnePagePerSheet(boolean value)

public boolean getIgnoreError() / public void setIgnoreError(boolean value)

Indicates if you need to hide the error while rendering. The error can be error in shape, image, chart rendering, etc.

public void setIgnoreError(boolean value)

public boolean getOutputBlankPageWhenNothingToPrint() / public void setOutputBlankPageWhenNothingToPrint(boolean value)

Indicates whether to output a blank page when there is nothing to print.

Default is true.

public void setOutputBlankPageWhenNothingToPrint(boolean value)

public int getPageIndex() / public void setPageIndex(int value)

Gets or sets the 0-based index of the first page to save.

Default is 0.

public void setPageIndex(int value)

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

Example:

//Open an Excel file
Workbook wb = new Workbook("Book1.xlsx");

PdfSaveOptions options = new PdfSaveOptions();

//Print only Page 3 and Page 4 in the output PDF
//Starting page index (0-based index)
options.setPageIndex(3);
//Number of pages to be printed
options.setPageCount(2);

//Save the PDF file
wb.save("output.pdf", options);

public void setPageCount(int value)

public int getPrintingPageType() / public void setPrintingPageType(int value)

Indicates which pages will not be printed. The value of the property is PrintingPageType integer constant.

If content in the sheet is sparse, there will be some pages are totally blank in the output pdf file. If you don't want these blank pages, you can use this option to omit them.

Example:

Workbook wb = new Workbook("Book1.xlsx");

PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();

//ignore blank pages
pdfSaveOptions.setPrintingPageType(PrintingPageType.IGNORE_BLANK);

wb.save("output_ignore_blank_page.pdf", pdfSaveOptions);


//ignore blank pages and pages which only contains some style content like cell background
pdfSaveOptions.setPrintingPageType(PrintingPageType.IGNORE_STYLE);

wb.save("output_ignore_blank_and_style_page.pdf", pdfSaveOptions);

public void setPrintingPageType(int value)

public int getGridlineType() / public void setGridlineType(int value)

Gets or sets gridline type. The value of the property is GridlineType integer constant.

Default is Dotted type.

public void setGridlineType(int value)

public int getTextCrossType() / public void setTextCrossType(int value)

Gets or sets displaying text type when the text width is larger than cell width. The value of the property is TextCrossType integer constant.

public void setTextCrossType(int value)

public int getDefaultEditLanguage() / public void setDefaultEditLanguage(int value)

Gets or sets default edit language. The value of the property is DefaultEditLanguage integer constant.

It may display/render different layouts for text paragraph when different edit languages is set. Default is DefaultEditLanguage.AUTO.

public void setDefaultEditLanguage(int value)

public SheetSet getSheetSet() / public void setSheetSet(SheetSet value)

Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.

public void setSheetSet(SheetSet value)

public DrawObjectEventHandler getDrawObjectEventHandler() / public void setDrawObjectEventHandler(DrawObjectEventHandler value)

Implements this interface to get DrawObject and Bound when rendering.

public void setDrawObjectEventHandler(DrawObjectEventHandler value)

public IPageSavingCallback getPageSavingCallback() / public void setPageSavingCallback(IPageSavingCallback value)

Control/Indicate progress of page saving process.

public void setPageSavingCallback(IPageSavingCallback value)

public int getSaveFormat()

Gets the save file format. The value of the property is SaveFormat integer constant.

public boolean getClearData() / public void setClearData(boolean value)

Make the workbook empty after saving the file.

public void setClearData(boolean value)

public java.lang.String getCachedFileFolder() / public void setCachedFileFolder(java.lang.String value)

The cached file folder is used to store some large data.

public void setCachedFileFolder(java.lang.String value)

public boolean getValidateMergedAreas() / public void setValidateMergedAreas(boolean value)

Indicates whether validate merged cells before saving the file.

The default value is false.

public void setValidateMergedAreas(boolean value)

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.

public void setMergeAreas(boolean value)

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.

public void setCreateDirectory(boolean value)

public boolean getSortNames() / public void setSortNames(boolean value)

Indicates whether sorting defined names before saving file.

public void setSortNames(boolean value)

public boolean getSortExternalNames() / public void setSortExternalNames(boolean value)

Indicates whether sorting external defined names before saving file.

public void setSortExternalNames(boolean value)

public boolean getRefreshChartCache() / public void setRefreshChartCache(boolean value)

Indicates whether refreshing chart cache data

public void setRefreshChartCache(boolean value)

public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)

Gets or sets warning callback.

public void setWarningCallback(IWarningCallback value)

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.

public void setUpdateSmartArt(boolean value)