Aspose::Cells::IPdfSaveOptions Class Referenceabstract

Represents the options for saving pdf file. More...

Inherits IPaginatedSaveOptions.

Public Member Functions

virtual bool GetEmbedStandardWindowsFonts ()=0
 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. More...
 
virtual void SetEmbedStandardWindowsFonts (bool value)=0
 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. More...
 
virtual intrusive_ptr< Aspose::Cells::Rendering::IPdfBookmarkEntryGetIPdfBookmarkEntry ()=0
 Gets the PdfBookmarkEntry object. More...
 
virtual void SetIPdfBookmarkEntry (intrusive_ptr< Aspose::Cells::Rendering::IPdfBookmarkEntry > value)=0
 Sets the PdfBookmarkEntry object. More...
 
virtual Aspose::Cells::Rendering::PdfCompliance GetCompliance ()=0
 Workbook converts to pdf will according to PdfCompliance in this property. More...
 
virtual void SetCompliance (Aspose::Cells::Rendering::PdfCompliance value)=0
 Workbook converts to pdf will according to PdfCompliance in this property. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::Drawing::Imaging::ImageFormat > GetImageType ()=0
 Represents the image type when converting the chart and shape . More...
 
virtual void SetImageType (intrusive_ptr< Aspose::Cells::Systems::Drawing::Imaging::ImageFormat > value)=0
 Represents the image type when converting the chart and shape . More...
 
virtual bool GetCalculateFormula ()=0
 Indicates whether calculate formulas before saving pdf file. More...
 
virtual void SetCalculateFormula (bool value)=0
 Indicates whether calculate formulas before saving pdf file. More...
 
virtual Aspose::Cells::Rendering::PdfCompressionCore GetPdfCompression ()=0
 Indicate the compression algorithm More...
 
virtual void SetPdfCompression (Aspose::Cells::Rendering::PdfCompressionCore value)=0
 Indicate the compression algorithm More...
 
virtual void SetImageResample (Aspose::Cells::Systems::Int32 desiredPPI, Aspose::Cells::Systems::Int32 jpegQuality)=0
 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. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::DateTime > GetCreatedTime ()=0
 Gets the time of generating the pdf document. More...
 
virtual void SetCreatedTime (intrusive_ptr< Aspose::Cells::Systems::DateTime > value)=0
 Sets the time of generating the pdf document. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::String > GetProducer ()=0
 Gets producer of generated pdf document. More...
 
virtual void SetProducer (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
 Sets producer of generated pdf document. More...
 
virtual Aspose::Cells::Rendering::PdfOptimizationType GetOptimizationType ()=0
 Gets pdf optimization type. More...
 
virtual void SetOptimizationType (Aspose::Cells::Rendering::PdfOptimizationType value)=0
 Sets pdf optimization type. More...
 
virtual Aspose::Cells::Rendering::PdfCustomPropertiesExport GetCustomPropertiesExport ()=0
 Gets a value determining the way CustomDocumentPropertyCollection are exported to PDF file. Default value is None. More...
 
virtual void SetCustomPropertiesExport (Aspose::Cells::Rendering::PdfCustomPropertiesExport value)=0
 Sets a value determining the way CustomDocumentPropertyCollection are exported to PDF file. Default value is None. More...
 
virtual bool GetExportDocumentStructure ()=0
 Gets a value determining whether or not to export document structure. More...
 
virtual void SetExportDocumentStructure (bool value)=0
 Sets a value determining whether or not to export document structure. More...
 
virtual Aspose::Cells::EmfRenderSetting GetEmfRenderSetting ()=0
 Setting for rendering Emf metafile. More...
 
virtual void SetEmfRenderSetting (Aspose::Cells::EmfRenderSetting value)=0
 Setting for rendering Emf metafile. More...
 
virtual bool GetDisplayDocTitle ()=0
 Indicate whether the window's title bar should display the document title. More...
 
virtual void SetDisplayDocTitle (bool value)=0
 Indicate whether the window's title bar should display the document title. More...
 
virtual Aspose::Cells::Rendering::PdfFontEncoding GetFontEncoding ()=0
 Gets embedded font encoding in pdf. More...
 
virtual void SetFontEncoding (Aspose::Cells::Rendering::PdfFontEncoding value)=0
 Sets embedded font encoding in pdf. More...
 

Detailed Description

Represents the options for saving pdf file.

Member Function Documentation

◆ GetCalculateFormula()

virtual bool Aspose::Cells::IPdfSaveOptions::GetCalculateFormula ( )
pure virtual

Indicates whether calculate formulas before saving pdf file.

The default value is false.

◆ GetCompliance()

virtual Aspose::Cells::Rendering::PdfCompliance Aspose::Cells::IPdfSaveOptions::GetCompliance ( )
pure virtual

Workbook converts to pdf will according to PdfCompliance in this property.

◆ GetCreatedTime()

virtual intrusive_ptr<Aspose::Cells::Systems::DateTime> Aspose::Cells::IPdfSaveOptions::GetCreatedTime ( )
pure virtual

Gets the time of generating the pdf document.

if it is not be set, it will be the time of generating the pdf.

◆ GetCustomPropertiesExport()

virtual Aspose::Cells::Rendering::PdfCustomPropertiesExport Aspose::Cells::IPdfSaveOptions::GetCustomPropertiesExport ( )
pure virtual

Gets a value determining the way CustomDocumentPropertyCollection are exported to PDF file. Default value is None.

◆ GetDisplayDocTitle()

virtual bool Aspose::Cells::IPdfSaveOptions::GetDisplayDocTitle ( )
pure virtual

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

◆ GetEmbedStandardWindowsFonts()

virtual bool Aspose::Cells::IPdfSaveOptions::GetEmbedStandardWindowsFonts ( )
pure virtual

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.

◆ GetEmfRenderSetting()

virtual Aspose::Cells::EmfRenderSetting Aspose::Cells::IPdfSaveOptions::GetEmfRenderSetting ( )
pure virtual

Setting for rendering Emf metafile.

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.EmfPlusPrefer is set, then EMF+ records will be parsed while rendering to pdf, otherwise only EMF records will be parsed. Default value is EmfRenderSetting.EmfOnly

◆ GetExportDocumentStructure()

virtual bool Aspose::Cells::IPdfSaveOptions::GetExportDocumentStructure ( )
pure virtual

Gets a value determining whether or not to export document structure.

◆ GetFontEncoding()

virtual Aspose::Cells::Rendering::PdfFontEncoding Aspose::Cells::IPdfSaveOptions::GetFontEncoding ( )
pure virtual

Gets embedded font encoding in pdf.

Default value is PdfFontEncoding.Identity

◆ GetImageType()

virtual intrusive_ptr<Aspose::Cells::Systems::Drawing::Imaging::ImageFormat> Aspose::Cells::IPdfSaveOptions::GetImageType ( )
pure virtual

Represents the image type when converting the chart and shape .

◆ GetIPdfBookmarkEntry()

virtual intrusive_ptr<Aspose::Cells::Rendering::IPdfBookmarkEntry> Aspose::Cells::IPdfSaveOptions::GetIPdfBookmarkEntry ( )
pure virtual

Gets the PdfBookmarkEntry object.

◆ GetOptimizationType()

virtual Aspose::Cells::Rendering::PdfOptimizationType Aspose::Cells::IPdfSaveOptions::GetOptimizationType ( )
pure virtual

Gets pdf optimization type.

Default value is PdfOptimizationType.Standard

◆ GetPdfCompression()

virtual Aspose::Cells::Rendering::PdfCompressionCore Aspose::Cells::IPdfSaveOptions::GetPdfCompression ( )
pure virtual

Indicate the compression algorithm

◆ GetProducer()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IPdfSaveOptions::GetProducer ( )
pure virtual

Gets producer of generated pdf document.

If the value is null, or a valid LICENSE is not set, string Aspose.Cells vVERSION will be used.

◆ SetCalculateFormula()

virtual void Aspose::Cells::IPdfSaveOptions::SetCalculateFormula ( bool  value)
pure virtual

Indicates whether calculate formulas before saving pdf file.

The default value is false.

◆ SetCompliance()

virtual void Aspose::Cells::IPdfSaveOptions::SetCompliance ( Aspose::Cells::Rendering::PdfCompliance  value)
pure virtual

Workbook converts to pdf will according to PdfCompliance in this property.

◆ SetCreatedTime()

virtual void Aspose::Cells::IPdfSaveOptions::SetCreatedTime ( intrusive_ptr< Aspose::Cells::Systems::DateTime >  value)
pure virtual

Sets the time of generating the pdf document.

if it is not be set, it will be the time of generating the pdf.

◆ SetCustomPropertiesExport()

virtual void Aspose::Cells::IPdfSaveOptions::SetCustomPropertiesExport ( Aspose::Cells::Rendering::PdfCustomPropertiesExport  value)
pure virtual

Sets a value determining the way CustomDocumentPropertyCollection are exported to PDF file. Default value is None.

◆ SetDisplayDocTitle()

virtual void Aspose::Cells::IPdfSaveOptions::SetDisplayDocTitle ( bool  value)
pure virtual

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

◆ SetEmbedStandardWindowsFonts()

virtual void Aspose::Cells::IPdfSaveOptions::SetEmbedStandardWindowsFonts ( bool  value)
pure virtual

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.

◆ SetEmfRenderSetting()

virtual void Aspose::Cells::IPdfSaveOptions::SetEmfRenderSetting ( Aspose::Cells::EmfRenderSetting  value)
pure virtual

Setting for rendering Emf metafile.

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.EmfPlusPrefer is set, then EMF+ records will be parsed while rendering to pdf, otherwise only EMF records will be parsed. Default value is EmfRenderSetting.EmfOnly

◆ SetExportDocumentStructure()

virtual void Aspose::Cells::IPdfSaveOptions::SetExportDocumentStructure ( bool  value)
pure virtual

Sets a value determining whether or not to export document structure.

◆ SetFontEncoding()

virtual void Aspose::Cells::IPdfSaveOptions::SetFontEncoding ( Aspose::Cells::Rendering::PdfFontEncoding  value)
pure virtual

Sets embedded font encoding in pdf.

Default value is PdfFontEncoding.Identity

◆ SetImageResample()

virtual void Aspose::Cells::IPdfSaveOptions::SetImageResample ( Aspose::Cells::Systems::Int32  desiredPPI,
Aspose::Cells::Systems::Int32  jpegQuality 
)
pure virtual

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
desiredPPIDesired pixels per inch. 220 high quality. 150 screen quality. 96 email quality.
jpegQuality0 - 100% JPEG quality.

The following code sets desired PPI as 96 and jpeg quality as 80 for images in the output pdf.

//load the source file with images.
intrusive_ptr<IWorkbook> workbook = Factory::CreateIWorkbook(AsposeCellsTestCases::TestConstants::sourcePath->StringAppend(new String("Book1.xlsx")));
intrusive_ptr <IPdfSaveOptions> pdfSaveOptions = Factory::CreateIPdfSaveOptions();
//set desired PPI as 96 and jpeg quality as 80.
pdfSaveOptions->SetImageResample(96, 80);
workbook->Save(new String("output.pdf"), pdfSaveOptions);

◆ SetImageType()

virtual void Aspose::Cells::IPdfSaveOptions::SetImageType ( intrusive_ptr< Aspose::Cells::Systems::Drawing::Imaging::ImageFormat >  value)
pure virtual

Represents the image type when converting the chart and shape .

◆ SetIPdfBookmarkEntry()

virtual void Aspose::Cells::IPdfSaveOptions::SetIPdfBookmarkEntry ( intrusive_ptr< Aspose::Cells::Rendering::IPdfBookmarkEntry value)
pure virtual

Sets the PdfBookmarkEntry object.

◆ SetOptimizationType()

virtual void Aspose::Cells::IPdfSaveOptions::SetOptimizationType ( Aspose::Cells::Rendering::PdfOptimizationType  value)
pure virtual

Sets pdf optimization type.

Default value is PdfOptimizationType.Standard

◆ SetPdfCompression()

virtual void Aspose::Cells::IPdfSaveOptions::SetPdfCompression ( Aspose::Cells::Rendering::PdfCompressionCore  value)
pure virtual

Indicate the compression algorithm

◆ SetProducer()

virtual void Aspose::Cells::IPdfSaveOptions::SetProducer ( intrusive_ptr< Aspose::Cells::Systems::String >  value)
pure virtual

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.