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

Inherits Aspose::Slides::Export::SaveOptions, and Aspose::Slides::Export::IPdfOptions.

Public Member Functions
System::SharedPtr< INotesCommentsLayoutingOptions >	get_NotesCommentsLayouting () override
	Provides options that control how notes and comments is placed in exported document. More...

bool	get_ShowHiddenSlides () override
	Specifies whether the generated document should include hidden slides or not. Default is `false`. More...

void	set_ShowHiddenSlides (bool value) override
	Specifies whether the generated document should include hidden slides or not. Default is `false`. More...

PdfTextCompression	get_TextCompression () override
	Specifies compression type to be used for all textual content in the document. Read PdfTextCompression. More...

void	set_TextCompression (PdfTextCompression value) override
	Specifies compression type to be used for all textual content in the document. Write PdfTextCompression. More...

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

void	set_BestImagesCompressionRatio (bool value) 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. More...

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

void	set_EmbedTrueTypeFontsForASCII (bool value) 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. More...

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[]. More...

void	set_AdditionalCommonFontFamilies (System::ArrayPtr< System::String > value) override
	Sets an array of user-defined names of font families which Aspose.Slides should consider common. Write System::String[]. More...

bool	get_EmbedFullFonts () override
	Determines if all characters of font should be embedded or only used subset. Read bool. More...

void	set_EmbedFullFonts (bool value) override
	Determines if all characters of font should be embedded or only used subset. Write bool. More...

uint8_t	get_JpegQuality () override
	Returns a value determining the quality of the JPEG images inside PDF document. Read uint8_t. More...

void	set_JpegQuality (uint8_t value) override
	Sets a value determining the quality of the JPEG images inside PDF document. Write uint8_t. More...

PdfCompliance	get_Compliance () override
	Desired conformance level for generated PDF document. Read PdfCompliance. More...

void	set_Compliance (PdfCompliance value) override
	Desired conformance level for generated PDF document. Write PdfCompliance. More...

System::String	get_Password () override
	Setting user password to protect the PDF document. Read System::String. More...

void	set_Password (System::String value) override
	Setting user password to protect the PDF document. Write System::String. More...

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

void	set_AccessPermissions (PdfAccessPermissions value) override
	Contains a set of flags specifying which access permissions should be granted when the document is opened with user access. See PdfAccessPermissions. More...

bool	get_SaveMetafilesAsPng () override
	True to convert all metafiles used in a presentation to the PNG images. Read bool. More...

void	set_SaveMetafilesAsPng (bool value) override
	True to convert all metafiles used in a presentation to the PNG images. Write bool. More...

float	get_SufficientResolution () override
	Returns a value determining resolution of images inside PDF document. More...

void	set_SufficientResolution (float value) override
	Sets a value determining resolution of images inside PDF document. More...

bool	get_DrawSlidesFrame () override
	True to draw black frame around each slide. Read bool. More...

void	set_DrawSlidesFrame (bool value) override
	True to draw black frame around each slide. Write bool. More...

System::Drawing::Color	get_ImageTransparentColor () override
	Gets the image transparent color. More...

void	set_ImageTransparentColor (System::Drawing::Color value) override
	Sets the image transparent color. More...

bool	get_ApplyImageTransparent () override
	Applies the specified transparent color to an image if `true`. More...

void	set_ApplyImageTransparent (bool value) override
	Applies the specified transparent color to an image if `true`. More...

	PdfOptions ()
	Default constructor. More...

Public Member Functions inherited from Aspose::Slides::Export::SaveOptions
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. More...

void	set_WarningCallback (System::SharedPtr< Aspose::Slides::Warnings::IWarningCallback > value) 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. More...

System::SharedPtr< IProgressCallback >	get_ProgressCallback () override
	Represents a callback object for saving progress updates in percentage. See IProgressCallback. More...

void	set_ProgressCallback (System::SharedPtr< IProgressCallback > value) override
	Represents a callback object for saving progress updates in percentage. See IProgressCallback. More...

System::String	get_DefaultRegularFont () override
	Returns font used in case source font is not found. Reads System::String. More...

void	set_DefaultRegularFont (System::String value) override
	Sets font used in case source font is not found. Writes System::String. More...

Public Member Functions inherited from System::Object
	Object ()
	Creates object. Initializes all internal data structures. More...

virtual	~Object ()
	Destroys object. Frees all internal data structures. More...

	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared reference counter. More...

void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...

template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

Protected Member Functions
virtual	~PdfOptions ()

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

template<>
bool	Equals (float const &objA, float const &objB)
	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. More...

template<>
bool	Equals (double const &objA, double const &objB)
	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. More...

Detailed Description

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

Constructor & Destructor Documentation

◆ PdfOptions()

Aspose::Slides::Export::PdfOptions::PdfOptions ( )

Default constructor.

◆ ~PdfOptions()

virtual Aspose::Slides::Export::PdfOptions::~PdfOptions ( )

protectedvirtual

Member Function Documentation

◆ get_AccessPermissions()

PdfAccessPermissions Aspose::Slides::Export::PdfOptions::get_AccessPermissions ( )

overridevirtual

Contains a set of flags specifying which access permissions should be granted when the document is opened with user access. See PdfAccessPermissions.

auto pdfOptions = MakeObject<PdfOptions>();
pdfOptions->set_Password(u"my_password");
pdfOptions->set_AccessPermissions(PdfAccessPermissions::PrintDocument | PdfAccessPermissions::HighQualityPrint);
auto presentation = MakeObject<Presentation>();
presentation->Save(pdfFilePath, SaveFormat::Pdf, pdfOptions);

Implements Aspose::Slides::Export::IPdfOptions.

◆ get_AdditionalCommonFontFamilies()

System::ArrayPtr<System::String> Aspose::Slides::Export::PdfOptions::get_AdditionalCommonFontFamilies ( )

overridevirtual

Returns an array of user-defined names of font families which Aspose.Slides should consider common. Read System::String[].

Implements Aspose::Slides::Export::IPdfOptions.

◆ get_ApplyImageTransparent()

bool Aspose::Slides::Export::PdfOptions::get_ApplyImageTransparent ( )

overridevirtual

Applies the specified transparent color to an image if true.

Implements Aspose::Slides::Export::IPdfOptions.

◆ get_BestImagesCompressionRatio()

bool Aspose::Slides::Export::PdfOptions::get_BestImagesCompressionRatio ( )

overridevirtual

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.

Best image compression ratio selection is computationally expensive and takes an additional amount of RAM, and this option is bool.false by default.

Default is bool.false.

Implements Aspose::Slides::Export::IPdfOptions.

◆ get_Compliance()

PdfCompliance Aspose::Slides::Export::PdfOptions::get_Compliance ( )

overridevirtual

Desired conformance level for generated PDF document. Read PdfCompliance.

Default is PdfCompliance::Pdf15.

Implements Aspose::Slides::Export::IPdfOptions.

◆ get_DrawSlidesFrame()

bool Aspose::Slides::Export::PdfOptions::get_DrawSlidesFrame ( )

overridevirtual

True to draw black frame around each slide. Read bool.

Default is false.

Implements Aspose::Slides::Export::IPdfOptions.

◆ get_EmbedFullFonts()

bool Aspose::Slides::Export::PdfOptions::get_EmbedFullFonts ( )

overridevirtual

Determines if all characters of font should be embedded or only used subset. Read bool.

Default is false.

Implements Aspose::Slides::Export::IPdfOptions.

◆ get_EmbedTrueTypeFontsForASCII()

bool Aspose::Slides::Export::PdfOptions::get_EmbedTrueTypeFontsForASCII ( )

overridevirtual

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.

Default is true.

Implements Aspose::Slides::Export::IPdfOptions.

◆ get_ImageTransparentColor()

System::Drawing::Color Aspose::Slides::Export::PdfOptions::get_ImageTransparentColor ( )

overridevirtual

Gets the image transparent color.

The color of the image transparent.

Implements Aspose::Slides::Export::IPdfOptions.

◆ get_JpegQuality()

uint8_t Aspose::Slides::Export::PdfOptions::get_JpegQuality ( )

overridevirtual

Returns a value determining the quality of the JPEG images inside PDF document. Read uint8_t.

Has effect only when a document contains JPEG images.

Use this property to get or set the quality of the images inside a document when saving in PDF format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression.

The default value is 100.

Implements Aspose::Slides::Export::IPdfOptions.

◆ get_NotesCommentsLayouting()

System::SharedPtr<INotesCommentsLayoutingOptions> Aspose::Slides::Export::PdfOptions::get_NotesCommentsLayouting ( )

overridevirtual

Provides options that control how notes and comments is placed in exported document.

Implements Aspose::Slides::Export::IPdfOptions.

◆ get_Password()

System::String Aspose::Slides::Export::PdfOptions::get_Password ( )

overridevirtual

Setting user password to protect the PDF document. Read System::String.

Implements Aspose::Slides::Export::IPdfOptions.

◆ get_SaveMetafilesAsPng()

bool Aspose::Slides::Export::PdfOptions::get_SaveMetafilesAsPng ( )

overridevirtual

True to convert all metafiles used in a presentation to the PNG images. Read bool.

Default is true. Pdf document can contain vector graphics and raster images. If SaveMetafilesAsPng is set to true then source Metafile image is converted to Png format and saved to Pdf as a raster image. If SaveMetafilesAsPng is set to false then source Metafile is converted to Pdf vector graphics. Each approach has advantages and disadvantages. For example, if Metafile is converted to PNG, then some quality loss is possible during resulting document scaling. If Metafile is converted to Pdf vector graphics, then performance issues in Pdf viewing tool are possible.

Implements Aspose::Slides::Export::IPdfOptions.

◆ get_ShowHiddenSlides()

bool Aspose::Slides::Export::PdfOptions::get_ShowHiddenSlides ( )

overridevirtual

Specifies whether the generated document should include hidden slides or not. Default is false.

Implements Aspose::Slides::Export::IPdfOptions.

◆ get_SufficientResolution()

float Aspose::Slides::Export::PdfOptions::get_SufficientResolution ( )

overridevirtual

Returns a value determining resolution of images inside PDF document.

Property affects on file size, time of export and image quality.

The default value is 96.

Effect of this parameter depends on few factors. Algorithm tries to get best output image size according to the property value, source image size and image frame size. Using of similar property values may give the same result. Recommended to use step 16 or 32 to get visible effect.

Read float.

Implements Aspose::Slides::Export::IPdfOptions.

◆ get_TextCompression()

PdfTextCompression Aspose::Slides::Export::PdfOptions::get_TextCompression ( )

overridevirtual

Specifies compression type to be used for all textual content in the document. Read PdfTextCompression.

Default is PdfTextCompression::Flate.

Implements Aspose::Slides::Export::IPdfOptions.

◆ set_AccessPermissions()

void Aspose::Slides::Export::PdfOptions::set_AccessPermissions ( PdfAccessPermissions value )

overridevirtual

Contains a set of flags specifying which access permissions should be granted when the document is opened with user access. See PdfAccessPermissions.

auto pdfOptions = MakeObject<PdfOptions>();
pdfOptions->set_Password(u"my_password");
pdfOptions->set_AccessPermissions(PdfAccessPermissions::PrintDocument | PdfAccessPermissions::HighQualityPrint);
auto presentation = MakeObject<Presentation>();
presentation->Save(pdfFilePath, SaveFormat::Pdf, pdfOptions);

Implements Aspose::Slides::Export::IPdfOptions.

◆ set_AdditionalCommonFontFamilies()

void Aspose::Slides::Export::PdfOptions::set_AdditionalCommonFontFamilies ( System::ArrayPtr< System::String > value )

overridevirtual

Sets an array of user-defined names of font families which Aspose.Slides should consider common. Write System::String[].

Implements Aspose::Slides::Export::IPdfOptions.

◆ set_ApplyImageTransparent()

void Aspose::Slides::Export::PdfOptions::set_ApplyImageTransparent ( bool value )

overridevirtual

Applies the specified transparent color to an image if true.

Implements Aspose::Slides::Export::IPdfOptions.

◆ set_BestImagesCompressionRatio()

void Aspose::Slides::Export::PdfOptions::set_BestImagesCompressionRatio ( bool value )

overridevirtual

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.

Best image compression ratio selection is computationally expensive and takes an additional amount of RAM, and this option is bool.false by default.

Default is bool.false.

Implements Aspose::Slides::Export::IPdfOptions.

◆ set_Compliance()

void Aspose::Slides::Export::PdfOptions::set_Compliance ( PdfCompliance value )

overridevirtual

Desired conformance level for generated PDF document. Write PdfCompliance.

Default is PdfCompliance::Pdf15.

Implements Aspose::Slides::Export::IPdfOptions.

◆ set_DrawSlidesFrame()

void Aspose::Slides::Export::PdfOptions::set_DrawSlidesFrame ( bool value )

overridevirtual

True to draw black frame around each slide. Write bool.

Default is false.

Implements Aspose::Slides::Export::IPdfOptions.

◆ set_EmbedFullFonts()

void Aspose::Slides::Export::PdfOptions::set_EmbedFullFonts ( bool value )

overridevirtual

Determines if all characters of font should be embedded or only used subset. Write bool.

Default is false.

Implements Aspose::Slides::Export::IPdfOptions.

◆ set_EmbedTrueTypeFontsForASCII()

void Aspose::Slides::Export::PdfOptions::set_EmbedTrueTypeFontsForASCII ( bool value )

overridevirtual

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.

Default is true.

Implements Aspose::Slides::Export::IPdfOptions.

◆ set_ImageTransparentColor()

void Aspose::Slides::Export::PdfOptions::set_ImageTransparentColor ( System::Drawing::Color value )

overridevirtual

Sets the image transparent color.

The color of the image transparent.

Implements Aspose::Slides::Export::IPdfOptions.

◆ set_JpegQuality()

void Aspose::Slides::Export::PdfOptions::set_JpegQuality ( uint8_t value )

overridevirtual

Sets a value determining the quality of the JPEG images inside PDF document. Write uint8_t.

Has effect only when a document contains JPEG images.

Use this property to get or set the quality of the images inside a document when saving in PDF format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression.

The default value is 100.

Implements Aspose::Slides::Export::IPdfOptions.

◆ set_Password()

void Aspose::Slides::Export::PdfOptions::set_Password ( System::String value )

overridevirtual

Setting user password to protect the PDF document. Write System::String.

Implements Aspose::Slides::Export::IPdfOptions.

◆ set_SaveMetafilesAsPng()

void Aspose::Slides::Export::PdfOptions::set_SaveMetafilesAsPng ( bool value )

overridevirtual

True to convert all metafiles used in a presentation to the PNG images. Write bool.

Default is true. Pdf document can contain vector graphics and raster images. If SaveMetafilesAsPng is set to true then source Metafile image is converted to Png format and saved to Pdf as a raster image. If SaveMetafilesAsPng is set to false then source Metafile is converted to Pdf vector graphics. Each approach has advantages and disadvantages. For example, if Metafile is converted to PNG, then some quality loss is possible during resulting document scaling. If Metafile is converted to Pdf vector graphics, then performance issues in Pdf viewing tool are possible.

Implements Aspose::Slides::Export::IPdfOptions.

◆ set_ShowHiddenSlides()

void Aspose::Slides::Export::PdfOptions::set_ShowHiddenSlides ( bool value )

overridevirtual

Specifies whether the generated document should include hidden slides or not. Default is false.

Implements Aspose::Slides::Export::IPdfOptions.

◆ set_SufficientResolution()

void Aspose::Slides::Export::PdfOptions::set_SufficientResolution ( float value )

overridevirtual

Sets a value determining resolution of images inside PDF document.

Property affects on file size, time of export and image quality.

The default value is 96.

Effect of this parameter depends on few factors. Algorithm tries to get best output image size according to the property value, source image size and image frame size. Using of similar property values may give the same result. Recommended to use step 16 or 32 to get visible effect.

Write float.

Implements Aspose::Slides::Export::IPdfOptions.

◆ set_TextCompression()

void Aspose::Slides::Export::PdfOptions::set_TextCompression ( PdfTextCompression value )

overridevirtual

Specifies compression type to be used for all textual content in the document. Write PdfTextCompression.

Default is PdfTextCompression::Flate.

Implements Aspose::Slides::Export::IPdfOptions.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PdfOptions()

◆ ~PdfOptions()

Member Function Documentation

◆ get_AccessPermissions()

◆ get_AdditionalCommonFontFamilies()

◆ get_ApplyImageTransparent()

◆ get_BestImagesCompressionRatio()

◆ get_Compliance()

◆ get_DrawSlidesFrame()

◆ get_EmbedFullFonts()

◆ get_EmbedTrueTypeFontsForASCII()

◆ get_ImageTransparentColor()

◆ get_JpegQuality()

◆ get_NotesCommentsLayouting()

◆ get_Password()

◆ get_SaveMetafilesAsPng()

◆ get_ShowHiddenSlides()

◆ get_SufficientResolution()

◆ get_TextCompression()

◆ set_AccessPermissions()

◆ set_AdditionalCommonFontFamilies()

◆ set_ApplyImageTransparent()

◆ set_BestImagesCompressionRatio()

◆ set_Compliance()

◆ set_DrawSlidesFrame()

◆ set_EmbedFullFonts()

◆ set_EmbedTrueTypeFontsForASCII()

◆ set_ImageTransparentColor()

◆ set_JpegQuality()

◆ set_Password()

◆ set_SaveMetafilesAsPng()

◆ set_ShowHiddenSlides()

◆ set_SufficientResolution()

◆ set_TextCompression()