asposecells.api

Classes

Constants

Class PdfSaveOptions

Represents the options for saving pdf file.

Constructor Summary
`PdfSaveOptions()` Creates the options for saving pdf file.

Property Getters/Setters Summary
`method`	`getAllColumnsInOnePagePerSheet()`
`method`	`setAllColumnsInOnePagePerSheet(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.
`method`	`getBookmark()`
`method`	`setBookmark(value)`
	Gets and sets the PdfBookmarkEntry object.
`method`	`getCachedFileFolder()`
`method`	`setCachedFileFolder(value)`
	The cached file folder is used to store some large data.
`method`	`getCalculateFormula()`
`method`	`setCalculateFormula(value)`
	Indicates whether to calculate formulas before saving pdf file.
`method`	`getCheckFontCompatibility()`
`method`	`setCheckFontCompatibility(value)`
	Indicates whether to check font compatibility for every character in text.
`method`	`getCheckWorkbookDefaultFont()`
`method`	`setCheckWorkbookDefaultFont(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.
`method`	`getClearData()`
`method`	`setClearData(value)`
	Make the workbook empty after saving the file.
`method`	`getCompliance()`
`method`	`setCompliance(value)`
	Gets or sets the PDF standards compliance level for output documents. The value of the property is PdfCompliance integer constant.
`method`	`getCreateDirectory()`
`method`	`setCreateDirectory(value)`
	If true and the directory does not exist, the directory will be automatically created before saving the file.
`method`	`getCreatedTime()`
`method`	`setCreatedTime(value)`
	Gets and sets the time of generating the pdf document.
`method`	`getCustomPropertiesExport()`
`method`	`setCustomPropertiesExport(value)`
	Gets or sets a value determining the way CustomDocumentPropertyCollection are exported to PDF file. Default value is None. The value of the property is PdfCustomPropertiesExport integer constant.
`method`	`getDefaultEditLanguage()`
`method`	`setDefaultEditLanguage(value)`
	Gets or sets default edit language. The value of the property is DefaultEditLanguage integer constant.
`method`	`getDefaultFont()`
`method`	`setDefaultFont(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.
`method`	`getDisplayDocTitle()`
`method`	`setDisplayDocTitle(value)`
	Indicates whether the window's title bar should display the document title.
`method`	`getDrawObjectEventHandler()`
`method`	`setDrawObjectEventHandler(value)`
	Implements this interface to get DrawObject and Bound when rendering.
`method`	`getEmbedAttachments()`
`method`	`setEmbedAttachments(value)`
	Indicates whether to embed attachment for Ole objects in Excel.
`method`	`getEmbedStandardWindowsFonts()`
`method`	`setEmbedStandardWindowsFonts(value)`
	True to embed true type fonts. Affects only ASCII characters 32-127. Fonts for character codes greater than 127 are always embedded. Fonts are always embedded for PDF/A-1a, PDF/A-1b standard. Default is true.
`method`	`getEmfRenderSetting()`
`method`	`setEmfRenderSetting(value)`
	Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant.
`method`	`getExportDocumentStructure()`
`method`	`setExportDocumentStructure(value)`
	Indicates whether to export document structure.
`method`	`getFontEncoding()`
`method`	`setFontEncoding(value)`
	Gets or sets embedded font encoding in pdf. The value of the property is PdfFontEncoding integer constant.
`method`	`getGridlineType()`
`method`	`setGridlineType(value)`
	Gets or sets gridline type. The value of the property is GridlineType integer constant.
`method`	`getIgnoreError()`
`method`	`setIgnoreError(value)`
	Indicates if you need to hide the error while rendering. The error can be error in shape, image, chart rendering, etc.
`method`	`getImageType()`
`method`	`setImageType(value)`
	Represents the image type when converting the chart and shape .
`method`	`isFontSubstitutionCharGranularity()`
`method`	`setFontSubstitutionCharGranularity(value)`
	Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
`method`	`getMergeAreas()`
`method`	`setMergeAreas(value)`
	Indicates whether merge the areas of conditional formatting and validation before saving the file.
`method`	`getOnePagePerSheet()`
`method`	`setOnePagePerSheet(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.
`method`	`getOptimizationType()`
`method`	`setOptimizationType(value)`
	Gets and sets pdf optimization type. The value of the property is PdfOptimizationType integer constant.
`method`	`getOutputBlankPageWhenNothingToPrint()`
`method`	`setOutputBlankPageWhenNothingToPrint(value)`
	Indicates whether to output a blank page when there is nothing to print.
`method`	`getPageCount()`
`method`	`setPageCount(value)`
	Gets or sets the number of pages to save.
`method`	`getPageIndex()`
`method`	`setPageIndex(value)`
	Gets or sets the 0-based index of the first page to save.
`method`	`getPageSavingCallback()`
`method`	`setPageSavingCallback(value)`
	Control/Indicate progress of page saving process.
`method`	`getPdfCompression()`
`method`	`setPdfCompression(value)`
	Indicate the compression algorithm The value of the property is PdfCompressionCore integer constant.
`method`	`getPrintingPageType()`
`method`	`setPrintingPageType(value)`
	Indicates which pages will not be printed. The value of the property is PrintingPageType integer constant.
`method`	`getProducer()`
`method`	`setProducer(value)`
	Gets and sets producer of generated pdf document.
`method`	`getRefreshChartCache()`
`method`	`setRefreshChartCache(value)`
	Indicates whether refreshing chart cache data
`method`	`getSaveFormat()`
	Gets the save file format. The value of the property is SaveFormat integer constant.
`method`	`getSecurityOptions()`
`method`	`setSecurityOptions(value)`
	Set this options, when security is need in xls2pdf result.
`method`	`getSheetSet()`
`method`	`setSheetSet(value)`
	Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
`method`	`getSortExternalNames()`
`method`	`setSortExternalNames(value)`
	Indicates whether sorting external defined names before saving file.
`method`	`getSortNames()`
`method`	`setSortNames(value)`
	Indicates whether sorting defined names before saving file.
`method`	`getTextCrossType()`
`method`	`setTextCrossType(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.
`method`	`getUpdateSmartArt()`
`method`	`setUpdateSmartArt(value)`
	Indicates whether updating smart art setting. The default value is false.
`method`	`getValidateMergedAreas()`
`method`	`setValidateMergedAreas(value)`
	Indicates whether validate merged cells before saving the file.
`method`	`getWatermark()`
`method`	`setWatermark(value)`
	Gets or sets watermark to output.

Method Summary
`method`	`setImageResample(desiredPPI, jpegQuality)`
`method`	Sets desired PPI(pixels per inch) of resample images and jpeg quality. All images will be converted to JPEG with the specified quality setting, and images that are greater than the specified PPI (pixels per inch) will be resampled.

- Constructor Detail
  - PdfSaveOptions
```
PdfSaveOptions()
```
    Creates the options for saving pdf file.
- Property Getters/Setters Detail
  - getEmbedStandardWindowsFonts/setEmbedStandardWindowsFonts : boolean
```
boolean getEmbedStandardWindowsFonts() / setEmbedStandardWindowsFonts(value)
```
    True to embed true type fonts. Affects only ASCII characters 32-127. Fonts for character codes greater than 127 are always embedded. Fonts are always embedded for PDF/A-1a, PDF/A-1b standard. Default is true.
  - getBookmark/setBookmark : PdfBookmarkEntry
```
PdfBookmarkEntry getBookmark() / setBookmark(value)
```
    Gets and sets the PdfBookmarkEntry object.
  - getCompliance/setCompliance : int
```
int getCompliance() / setCompliance(value)
```
    Gets or sets the PDF standards compliance level for output documents. The value of the property is PdfCompliance integer constant.
    Default is Pdf17.
  - getSecurityOptions/setSecurityOptions : PdfSecurityOptions
```
PdfSecurityOptions getSecurityOptions() / setSecurityOptions(value)
```
    Set this options, when security is need in xls2pdf result.
  - getImageType/setImageType : ImageFormat
```
ImageFormat getImageType() / setImageType(value)
```
    Represents the image type when converting the chart and shape .
    NOTE: This member is now obsolete. Instead, Chart and Shape are always rendered as vector elements(e.g. point, line) for rendering quality. This property will be removed 12 months later since June 2022. Aspose apologizes for any inconvenience you may have experienced.
  - getCalculateFormula/setCalculateFormula : boolean
```
boolean getCalculateFormula() / setCalculateFormula(value)
```
    Indicates whether to calculate formulas before saving pdf file.
    The default value is false.
  - getPdfCompression/setPdfCompression : int
```
int getPdfCompression() / setPdfCompression(value)
```
    Indicate the compression algorithm The value of the property is PdfCompressionCore integer constant.
  - getCreatedTime/setCreatedTime : DateTime
```
DateTime getCreatedTime() / setCreatedTime(value)
```
    Gets and sets the time of generating the pdf document.
    if it is not be set, it will be the time of generating the pdf.
  - getProducer/setProducer : String
```
String getProducer() / setProducer(value)
```
    Gets and sets producer of generated pdf document.
    If the value is null, or a valid LICENSE is not set, string Aspose.Cells vVERSION will be used.
  - getOptimizationType/setOptimizationType : int
```
int getOptimizationType() / setOptimizationType(value)
```
    Gets and sets pdf optimization type. The value of the property is PdfOptimizationType integer constant.
    Default value is PdfOptimizationType.STANDARD
  - getCustomPropertiesExport/setCustomPropertiesExport : int
```
int getCustomPropertiesExport() / setCustomPropertiesExport(value)
```
    Gets or sets a value determining the way CustomDocumentPropertyCollection are exported to PDF file. Default value is None. The value of the property is PdfCustomPropertiesExport integer constant.
  - getExportDocumentStructure/setExportDocumentStructure : boolean
```
boolean getExportDocumentStructure() / setExportDocumentStructure(value)
```
    Indicates whether to export document structure.
  - getDisplayDocTitle/setDisplayDocTitle : boolean
```
boolean getDisplayDocTitle() / setDisplayDocTitle(value)
```
    Indicates whether the window's title bar should display the document title.
    If false, the title bar should instead display the name of the PDF file. Default value is false.
  - getFontEncoding/setFontEncoding : int
```
int getFontEncoding() / setFontEncoding(value)
```
    Gets or sets embedded font encoding in pdf. The value of the property is PdfFontEncoding integer constant.
    Default value is PdfFontEncoding.IDENTITY
  - getWatermark/setWatermark : RenderingWatermark
```
RenderingWatermark getWatermark() / setWatermark(value)
```
    Gets or sets watermark to output.
  - getEmbedAttachments/setEmbedAttachments : boolean
```
boolean getEmbedAttachments() / setEmbedAttachments(value)
```
    Indicates whether to embed attachment for Ole objects in Excel.
    Default value is false. The value must be false when PDF/A compliance is set or pdf encryption is enabled.
  - getDefaultFont/setDefaultFont : String
```
String getDefaultFont() / setDefaultFont(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.
  - getCheckWorkbookDefaultFont/setCheckWorkbookDefaultFont : boolean
```
boolean getCheckWorkbookDefaultFont() / setCheckWorkbookDefaultFont(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.
  - getCheckFontCompatibility/setCheckFontCompatibility : boolean
```
boolean getCheckFontCompatibility() / setCheckFontCompatibility(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;
  - isFontSubstitutionCharGranularity/setFontSubstitutionCharGranularity : boolean
```
boolean isFontSubstitutionCharGranularity() / setFontSubstitutionCharGranularity(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.
  - getOnePagePerSheet/setOnePagePerSheet : boolean
```
boolean getOnePagePerSheet() / setOnePagePerSheet(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.
  - getAllColumnsInOnePagePerSheet/setAllColumnsInOnePagePerSheet : boolean
```
boolean getAllColumnsInOnePagePerSheet() / setAllColumnsInOnePagePerSheet(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.
  - getIgnoreError/setIgnoreError : boolean
```
boolean getIgnoreError() / setIgnoreError(value)
```
    Indicates if you need to hide the error while rendering. The error can be error in shape, image, chart rendering, etc.
  - getOutputBlankPageWhenNothingToPrint/setOutputBlankPageWhenNothingToPrint : boolean
```
boolean getOutputBlankPageWhenNothingToPrint() / setOutputBlankPageWhenNothingToPrint(value)
```
    Indicates whether to output a blank page when there is nothing to print.
    Default is true.
  - getPageIndex/setPageIndex : int
```
int getPageIndex() / setPageIndex(value)
```
    Gets or sets the 0-based index of the first page to save.
    Default is 0.
  - getPageCount/setPageCount : int
```
int getPageCount() / setPageCount(value)
```
    Gets or sets the number of pages to save.
    Default is System.Int32.MaxValue which means all pages will be rendered..
  - getPrintingPageType/setPrintingPageType : int
```
int getPrintingPageType() / setPrintingPageType(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.
  - getGridlineType/setGridlineType : int
```
int getGridlineType() / setGridlineType(value)
```
    Gets or sets gridline type. The value of the property is GridlineType integer constant.
    Default is Dotted type.
  - getTextCrossType/setTextCrossType : int
```
int getTextCrossType() / setTextCrossType(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.
  - getDefaultEditLanguage/setDefaultEditLanguage : int
```
int getDefaultEditLanguage() / setDefaultEditLanguage(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.
  - getSheetSet/setSheetSet : SheetSet
```
SheetSet getSheetSet() / setSheetSet(value)
```
    Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
  - getDrawObjectEventHandler/setDrawObjectEventHandler : DrawObjectEventHandler
```
DrawObjectEventHandler getDrawObjectEventHandler() / setDrawObjectEventHandler(value)
```
    Implements this interface to get DrawObject and Bound when rendering.
  - getPageSavingCallback/setPageSavingCallback : IPageSavingCallback
```
IPageSavingCallback getPageSavingCallback() / setPageSavingCallback(value)
```
    Control/Indicate progress of page saving process.
  - getEmfRenderSetting/setEmfRenderSetting : int
```
int getEmfRenderSetting() / setEmfRenderSetting(value)
```
    Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant.
    EMF metafiles identified as "EMF+ Dual" can contain both EMF+ records and EMF records. Either type of record can be used to render the image, only EMF+ records, or only EMF records. When EmfRenderSetting.EMF_PLUS_PREFER is set, then EMF+ records will be parsed while rendering to page, otherwise only EMF records will be parsed. Default value is EmfRenderSetting.EMF_ONLY.
  - getSaveFormat : int
```
int getSaveFormat()
```
    Gets the save file format. The value of the property is SaveFormat integer constant.
  - getClearData/setClearData : boolean
```
boolean getClearData() / setClearData(value)
```
    Make the workbook empty after saving the file.
  - getCachedFileFolder/setCachedFileFolder : String
```
String getCachedFileFolder() / setCachedFileFolder(value)
```
    The cached file folder is used to store some large data.
  - getValidateMergedAreas/setValidateMergedAreas : boolean
```
boolean getValidateMergedAreas() / setValidateMergedAreas(value)
```
    Indicates whether validate merged cells before saving the file.
    The default value is false.
  - getMergeAreas/setMergeAreas : boolean
```
boolean getMergeAreas() / setMergeAreas(value)
```
    Indicates whether merge the areas of conditional formatting and validation before saving the file.
    The default value is false.
  - getCreateDirectory/setCreateDirectory : boolean
```
boolean getCreateDirectory() / setCreateDirectory(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 : boolean
```
boolean getSortNames() / setSortNames(value)
```
    Indicates whether sorting defined names before saving file.
  - getSortExternalNames/setSortExternalNames : boolean
```
boolean getSortExternalNames() / setSortExternalNames(value)
```
    Indicates whether sorting external defined names before saving file.
  - getRefreshChartCache/setRefreshChartCache : boolean
```
boolean getRefreshChartCache() / setRefreshChartCache(value)
```
    Indicates whether refreshing chart cache data
  - getUpdateSmartArt/setUpdateSmartArt : boolean
```
boolean getUpdateSmartArt() / setUpdateSmartArt(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.
- Method Detail
  - setImageResample
```
 setImageResample(desiredPPI, jpegQuality)
```
    Sets desired PPI(pixels per inch) of resample images and jpeg quality. All images will be converted to JPEG with the specified quality setting, and images that are greater than the specified PPI (pixels per inch) will be resampled.
    Parameters:
    desiredPPI: int - Desired pixels per inch. 220 high quality. 150 screen quality. 96 email quality.
    jpegQuality: int - 0 - 100% JPEG quality.

asposecells.api

Classes

Constants

Class PdfSaveOptions

Constructor Detail

PdfSaveOptions

Property Getters/Setters Detail

getEmbedStandardWindowsFonts/setEmbedStandardWindowsFonts : boolean

getBookmark/setBookmark : PdfBookmarkEntry

getCompliance/setCompliance : int

getSecurityOptions/setSecurityOptions : PdfSecurityOptions

getImageType/setImageType : ImageFormat

getCalculateFormula/setCalculateFormula : boolean

getPdfCompression/setPdfCompression : int

getCreatedTime/setCreatedTime : DateTime

getProducer/setProducer : String

getOptimizationType/setOptimizationType : int

getCustomPropertiesExport/setCustomPropertiesExport : int

getExportDocumentStructure/setExportDocumentStructure : boolean

getDisplayDocTitle/setDisplayDocTitle : boolean

getFontEncoding/setFontEncoding : int

getWatermark/setWatermark : RenderingWatermark

getEmbedAttachments/setEmbedAttachments : boolean

getDefaultFont/setDefaultFont : String

getCheckWorkbookDefaultFont/setCheckWorkbookDefaultFont : boolean

getCheckFontCompatibility/setCheckFontCompatibility : boolean

isFontSubstitutionCharGranularity/setFontSubstitutionCharGranularity : boolean

getOnePagePerSheet/setOnePagePerSheet : boolean

getAllColumnsInOnePagePerSheet/setAllColumnsInOnePagePerSheet : boolean

getIgnoreError/setIgnoreError : boolean

getOutputBlankPageWhenNothingToPrint/setOutputBlankPageWhenNothingToPrint : boolean

getPageIndex/setPageIndex : int

getPageCount/setPageCount : int

getPrintingPageType/setPrintingPageType : int

getGridlineType/setGridlineType : int

getTextCrossType/setTextCrossType : int

getDefaultEditLanguage/setDefaultEditLanguage : int

getSheetSet/setSheetSet : SheetSet

getDrawObjectEventHandler/setDrawObjectEventHandler : DrawObjectEventHandler

getPageSavingCallback/setPageSavingCallback : IPageSavingCallback

getEmfRenderSetting/setEmfRenderSetting : int

getSaveFormat : int

getClearData/setClearData : boolean

getCachedFileFolder/setCachedFileFolder : String

getValidateMergedAreas/setValidateMergedAreas : boolean

getMergeAreas/setMergeAreas : boolean

getCreateDirectory/setCreateDirectory : boolean

getSortNames/setSortNames : boolean

getSortExternalNames/setSortExternalNames : boolean

getRefreshChartCache/setRefreshChartCache : boolean

getUpdateSmartArt/setUpdateSmartArt : boolean

Method Detail

setImageResample