PdfOptions

PdfOptions class

Provides options that control how a presentation is saved in Pdf format.

class PdfOptions : public Aspose::Slides::Export::SaveOptions,
                   public Aspose::Slides::Export::IPdfOptions

Methods

Method	Description
virtual bool Equals(ptr)	Compares objects using C# Object.Equals semantics.
static std::enable_if<IsSmartPtr<T1>::value&&IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)	Compares reference type objects in C# style.
static std::enable_if<!IsSmartPtr<T1>::value&&!IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)	Compares value type objects in C# style.
static bool Equals(float const&, float const&)	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN.
static bool Equals(double const&, double const&)	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN.
virtual bool FastCast(const Details::FastRttiBase&, void **) const	For internal purposes only.
PdfAccessPermissions get_AccessPermissions() override	Contains a set of flags specifying which access permissions should be granted when the document is opened with user access. See PdfAccessPermissions.
System::ArrayPtr<System::String> get_AdditionalCommonFontFamilies() override	Returns an array of user-defined names of font families which Aspose.Slides should consider common. Read System::String[].
bool get_ApplyImageTransparent() override	Applies the specified transparent color to an image if true.
bool get_BestImagesCompressionRatio() override	Indicates if the most effective compression (instead of the default one) for each image must be selected automatically. If set to bool.true, for every image in presentation the most appropriate compression algorithm will be chosen, what will lead to the smaller size of the resulting PDF document.
PdfCompliance get_Compliance() override	Desired conformance level for generated PDF document. Read PdfCompliance.
System::String get_DefaultRegularFont() override	Returns font used in case source font is not found. Reads System::String.
bool get_DrawSlidesFrame() override	True to draw black frame around each slide. Read bool.
bool get_EmbedFullFonts() override	Determines if all characters of font should be embedded or only used subset. Read bool.
bool get_EmbedTrueTypeFontsForASCII() override	Determines if Aspose.Slides will embed common fonts for ASCII (33..127 code range) text. Fonts for character codes greater than 127 are always embedded. Common fonts list includes PDF’s base 14 fonts and additional user specified fonts. Read bool.
System::Drawing::Color get_ImageTransparentColor() override	Gets the image transparent color.
System::SharedPtr<IInkOptions> get_InkOptions() override	Provides options that control the look of Ink objects in exported document. Read-only IInkOptions
uint8_t get_JpegQuality() override	Returns a value determining the quality of the JPEG images inside PDF document. Read uint8_t.
System::SharedPtr<INotesCommentsLayoutingOptions> get_NotesCommentsLayouting() override	Provides options that control how notes and comments is placed in exported document.
System::String get_Password() override	Setting user password to protect the PDF document. Read System::String.
System::SharedPtr<IProgressCallback> get_ProgressCallback() override	Represents a callback object for saving progress updates in percentage. See IProgressCallback.
bool get_SaveMetafilesAsPng() override	True to convert all metafiles used in a presentation to the PNG images. Read bool.
bool get_ShowHiddenSlides() override	Specifies whether the generated document should include hidden slides or not. Default is false.
System::SharedPtr<ISlidesLayoutOptions> get_SlidesLayoutOptions() override	Gets the mode in which slides are placed on the page when exporting a presentation ISlidesLayoutOptions.
float get_SufficientResolution() override	Returns a value determining resolution of images inside PDF document.
PdfTextCompression get_TextCompression() override	Specifies compression type to be used for all textual content in the document. Read PdfTextCompression.
System::SharedPtr<Aspose::Slides::Warnings::IWarningCallback> get_WarningCallback() override	Returns of sets an object which receives warnings and decides whether loading process will continue or will be aborted. Read Aspose::Slides::Warnings::IWarningCallback.
Detail::SmartPtrCounter * GetCounter()	Gets reference counter data structure associated with the object.
virtual int32_t GetHashCode() const	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects.
virtual const TypeInfo& GetType() const	Gets actual type of object. Analog of C# System.Object.GetType() call.
virtual bool Is(const TypeInfo&) const	Check if object represents an instance of type described by targetType. Analog of C# ‘is’ operator.
void Lock()	Implements C# lock() statement locking. Call directly or use LockContext sentry object.
virtual ptr MemberwiseClone() const	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types.
Object()	Creates object. Initializes all internal data structures.
Object(Object const&)	Copy constructor. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
Object& operator=(Object const&)	Assignment operator. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
PdfOptions()	Default constructor.
static bool ReferenceEquals(ptr const&, ptr const&)	Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, T const&)	Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, std::nullptr_t)	Reference-compares value type object with nullptr.
bool ReferenceEquals(String const&, std::nullptr_t)	Specialization of Object::ReferenceEquals for case of string and nullptr.
bool ReferenceEquals(String const&, String const&)	Specialization of Object::ReferenceEquals for case of strings.
int RemovedSharedRefs(int)	Decreases shared reference count by specified value.
void set_AccessPermissions(PdfAccessPermissions) override	Contains a set of flags specifying which access permissions should be granted when the document is opened with user access. See PdfAccessPermissions.
void set_AdditionalCommonFontFamilies(System::ArrayPtr<System::String>) override	Sets an array of user-defined names of font families which Aspose.Slides should consider common. Write System::String[].
void set_ApplyImageTransparent(bool) override	Applies the specified transparent color to an image if true.
void set_BestImagesCompressionRatio(bool) override	Indicates if the most effective compression (instead of the default one) for each image must be selected automatically. If set to bool.true, for every image in presentation the most appropriate compression algorithm will be chosen, what will lead to the smaller size of the resulting PDF document.
void set_Compliance(PdfCompliance) override	Desired conformance level for generated PDF document. Write PdfCompliance.
void set_DefaultRegularFont(System::String) override	Sets font used in case source font is not found. Writes System::String.
void set_DrawSlidesFrame(bool) override	True to draw black frame around each slide. Write bool.
void set_EmbedFullFonts(bool) override	Determines if all characters of font should be embedded or only used subset. Write bool.
void set_EmbedTrueTypeFontsForASCII(bool) override	Determines if Aspose.Slides will embed common fonts for ASCII (33..127 code range) text. Fonts for character codes greater than 127 are always embedded. Common fonts list includes PDF’s base 14 fonts and additional user specified fonts. Write bool.
void set_ImageTransparentColor(System::Drawing::Color) override	Sets the image transparent color.
void set_JpegQuality(uint8_t) override	Sets a value determining the quality of the JPEG images inside PDF document. Write uint8_t.
void set_Password(System::String) override	Setting user password to protect the PDF document. Write System::String.
void set_ProgressCallback(System::SharedPtr<IProgressCallback>) override	Represents a callback object for saving progress updates in percentage. See IProgressCallback.
void set_SaveMetafilesAsPng(bool) override	True to convert all metafiles used in a presentation to the PNG images. Write bool.
void set_ShowHiddenSlides(bool) override	Specifies whether the generated document should include hidden slides or not. Default is false.
void set_SlidesLayoutOptions(System::SharedPtr<ISlidesLayoutOptions>) override	Sets the mode in which slides are placed on the page when exporting a presentation ISlidesLayoutOptions.
void set_SufficientResolution(float) override	Sets a value determining resolution of images inside PDF document.
void set_TextCompression(PdfTextCompression) override	Specifies compression type to be used for all textual content in the document. Write PdfTextCompression.
void set_WarningCallback(System::SharedPtr<Aspose::Slides::Warnings::IWarningCallback>) override	Returns of sets an object which receives warnings and decides whether loading process will continue or will be aborted. Write Aspose::Slides::Warnings::IWarningCallback.
virtual void SetTemplateWeakPtr(uint32_t)	Set n’th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode.
int SharedCount() const	Gets current value of shared reference counter.
Object * SharedRefAdded()	Increments shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
int SharedRefRemovedSafe()	Decrements and returns shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
virtual String ToString() const	Analog of C# Object.ToString() method. Enables converting custom objects to string.
static const TypeInfo& Type()	Implements C# typeof(System.Object) construct.
void Unlock()	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object.
Detail::SmartPtrCounter * WeakRefAdded()	Increments weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
void WeakRefRemoved()	Decrements weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
virtual ~Object()	Destroys object. Frees all internal data structures.

Remarks

The following example shows how to convert PowerPoint to PDF with custom options.

auto presentation = System::MakeObject<Presentation>(u"PowerPoint.pptx");

// Instantiates the PdfOptions class
System::SharedPtr<PdfOptions> pdfOptions = System::MakeObject<PdfOptions>();
// Sets the Jpeg quality
pdfOptions->set_JpegQuality(90);
// Sets the behavior for metafiles
pdfOptions->set_SaveMetafilesAsPng(true);
// Sets the text compression level
pdfOptions->set_TextCompression(PdfTextCompression::Flate);
// Defines the PDF standard
pdfOptions->set_Compliance(PdfCompliance::Pdf15);
// Saves the presentation as a PDF
presentation->Save(u"PowerPoint-to-PDF.pdf", SaveFormat::Pdf, pdfOptions);

The following example shows how to convert PowerPoint to PDF with hidden slides.

// Instantiates a Presentation class that represents a PowerPoint file
auto presentation = System::MakeObject<Presentation>(u"PowerPoint.pptx");

// Instantiates the PdfOptions class
System::SharedPtr<PdfOptions> pdfOptions = System::MakeObject<PdfOptions>();
// Adds hidden slides
pdfOptions->set_ShowHiddenSlides(true);
// Saves the presentation as a PDF
presentation->Save(u"PowerPoint-to-PDF.pdf", SaveFormat::Pdf, pdfOptions);

The following example shows how to convert PowerPoint to password protected PDF.

// Instantiates a Presentation object that represents a PowerPoint file
auto presentation = System::MakeObject<Presentation>(u"PowerPoint.pptx");

System::SharedPtr<PdfOptions> pdfOptions = System::MakeObject<PdfOptions>();

// Sets PDF password and access permissions
pdfOptions->set_Password(u"password");
pdfOptions->set_AccessPermissions(PdfAccessPermissions::PrintDocument | PdfAccessPermissions::HighQualityPrint);
// Saves the presentation as a PDF
presentation->Save(u"PPTX-to-PDF.pdf", SaveFormat::Pdf, pdfOptions);

The following example shows how to convert PowerPoint to PDF with notes.

// Instantiate a Presentation object that represents a presentation file
auto presentation = System::MakeObject<Presentation>(u"SelectedSlides.pptx");

auto auxPresentation = System::MakeObject<Presentation>();

auto slide = presentation->get_Slides()->idx_get(0);
auxPresentation->get_Slides()->InsertClone(0, slide);

// Setting Slide Type and Size
auxPresentation->get_SlideSize()->SetSize(612.F, 792.F, SlideSizeScaleType::EnsureFit);

System::SharedPtr<PdfOptions> pdfOptions = System::MakeObject<PdfOptions>();
pdfOptions->get_NotesCommentsLayouting()->set_NotesPosition(NotesPositions::BottomFull);
auxPresentation->Save(u"PDFnotes_out.pdf", SaveFormat::Pdf, pdfOptions);

PdfOptions

PdfOptions class

Methods

Remarks

See Also