Aspose::Words::Saving::PdfSaveOptions Class Reference

Can be used to specify additional options when saving a document into the Aspose::Words::SaveFormat::Pdf format. More...

#include "Model/Saving/PdfSaveOptions.h"

Inherits Aspose::Words::Saving::FixedPageSaveOptions.

Public Member Functions

virtual Aspose::Words::SaveFormat get_SaveFormat ()
 Specifies the format in which the document will be saved if this save options object is used. Can only be Aspose::Words::SaveFormat::Pdf. More...
 
virtual void set_SaveFormat (Aspose::Words::SaveFormat value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_SaveFormat. More...
 
System::SharedPtr< Aspose::Words::Saving::OutlineOptionsget_OutlineOptions () const
 Allows to specify outline options. More...
 
Aspose::Words::Saving::PdfTextCompression get_TextCompression () const
 Specifies compression type to be used for all textual content in the document. More...
 
void set_TextCompression (Aspose::Words::Saving::PdfTextCompression value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_TextCompression. More...
 
Aspose::Words::Saving::PdfCompliance get_Compliance () const
 Specifies the PDF standards compliance level for output documents. More...
 
void set_Compliance (Aspose::Words::Saving::PdfCompliance value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_Compliance. More...
 
int32_t get_JpegQuality ()
 Gets or sets a value determining the quality of the JPEG images inside PDF document. More...
 
void set_JpegQuality (int32_t value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_JpegQuality. More...
 
bool get_PreserveFormFields () const
 Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text. Default is false. More...
 
void set_PreserveFormFields (bool value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_PreserveFormFields. More...
 
bool get_CreateNoteHyperlinks () const
 Specifies whether to convert footnote/endnote references in main text story into active hyperlinks. When clicked the hyperlink will lead to the corresponding footnote/endnote. Default is false. More...
 
void set_CreateNoteHyperlinks (bool value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_CreateNoteHyperlinks. More...
 
bool get_EmbedFullFonts () const
 Controls how fonts are embedded into the resulting PDF documents. More...
 
void set_EmbedFullFonts (bool value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_EmbedFullFonts. More...
 
Aspose::Words::Saving::PdfFontEmbeddingMode get_FontEmbeddingMode () const
 Specifies the font embedding mode. More...
 
void set_FontEmbeddingMode (Aspose::Words::Saving::PdfFontEmbeddingMode value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_FontEmbeddingMode. More...
 
bool get_UseCoreFonts () const
 Gets or sets a value determining whether or not to substitute TrueType fonts Arial, Times New Roman, Courier New and Symbol with core PDF Type 1 fonts. More...
 
void set_UseCoreFonts (bool value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_UseCoreFonts. More...
 
Aspose::Words::Saving::PdfCustomPropertiesExport get_CustomPropertiesExport () const
 Gets or sets a value determining the way Aspose::Words::Document::get_CustomDocumentProperties are exported to PDF file. Default value is Aspose::Words::Saving::PdfCustomPropertiesExport::None. More...
 
void set_CustomPropertiesExport (Aspose::Words::Saving::PdfCustomPropertiesExport value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_CustomPropertiesExport. More...
 
Aspose::Words::Saving::PdfZoomBehavior get_ZoomBehavior () const
 Gets or sets a value determining what type of zoom should be applied when a document is opened with a PDF viewer. More...
 
void set_ZoomBehavior (Aspose::Words::Saving::PdfZoomBehavior value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_ZoomBehavior. More...
 
int32_t get_ZoomFactor () const
 Gets or sets a value determining zoom factor (in percentages) for a document. More...
 
void set_ZoomFactor (int32_t value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_ZoomFactor. More...
 
Aspose::Words::Saving::PdfImageCompression get_ImageCompression () const
 Specifies compression type to be used for all images in the document. Default is Aspose::Words::Saving::PdfImageCompression::Auto. More...
 
void set_ImageCompression (Aspose::Words::Saving::PdfImageCompression value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_ImageCompression. More...
 
bool get_OpenHyperlinksInNewWindow () const
 Gets or sets a value determining whether hyperlinks in the output Pdf document are forced to be opened in a new window (or tab) of a browser. More...
 
void set_OpenHyperlinksInNewWindow (bool value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_OpenHyperlinksInNewWindow. More...
 
bool get_ExportDocumentStructure () const
 Gets or sets a value determining whether or not to export document structure. More...
 
void set_ExportDocumentStructure (bool value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_ExportDocumentStructure. More...
 
bool get_UseBookFoldPrintingSettings () const
 Gets or sets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via Aspose::Words::PageSetup::get_MultiplePages. More...
 
void set_UseBookFoldPrintingSettings (bool value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_UseBookFoldPrintingSettings. More...
 
System::SharedPtr< Aspose::Words::Saving::DownsampleOptionsget_DownsampleOptions () const
 Allows to specify downsample options. More...
 
void set_DownsampleOptions (System::SharedPtr< Aspose::Words::Saving::DownsampleOptions > value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_DownsampleOptions. More...
 
Aspose::Words::Saving::PdfPageMode get_PageMode () const
 Specifies how the PDF document should be displayed when opened in the PDF reader. More...
 
void set_PageMode (Aspose::Words::Saving::PdfPageMode value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_PageMode. More...
 
Aspose::Words::Saving::PdfImageColorSpaceExportMode get_ImageColorSpaceExportMode () const
 Specifies how the color space will be selected for the images in PDF document. More...
 
void set_ImageColorSpaceExportMode (Aspose::Words::Saving::PdfImageColorSpaceExportMode value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_ImageColorSpaceExportMode. More...
 
bool get_PreblendImages () const
 Gets or sets a value determining whether or not to preblend transparent images with black background color. More...
 
void set_PreblendImages (bool value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_PreblendImages. More...
 
bool get_DisplayDocTitle () const
 A flag specifying whether the window�s title bar should display the document title taken from the Title entry of the document information dictionary. More...
 
void set_DisplayDocTitle (bool value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_DisplayDocTitle. More...
 
virtual Aspose::Words::Saving::DmlEffectsRenderingMode get_DmlEffectsRenderingMode ()
 Gets or sets a value determining how DrawingML effects are rendered. More...
 
virtual void set_DmlEffectsRenderingMode (Aspose::Words::Saving::DmlEffectsRenderingMode value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_DmlEffectsRenderingMode. More...
 
bool get_EscapeUri () const
 A flag specifying whether URI should be escaped before writing. More...
 
void set_EscapeUri (bool value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_EscapeUri. More...
 
Aspose::Words::Saving::HeaderFooterBookmarksExportMode get_HeaderFooterBookmarksExportMode () const
 Determines how bookmarks in headers/footers are exported. More...
 
void set_HeaderFooterBookmarksExportMode (Aspose::Words::Saving::HeaderFooterBookmarksExportMode value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_HeaderFooterBookmarksExportMode. More...
 
bool get_AdditionalTextPositioning () const
 A flag specifying whether to write additional text positioning operators or not. More...
 
void set_AdditionalTextPositioning (bool value)
 Setter for Aspose::Words::Saving::PdfSaveOptions::get_AdditionalTextPositioning. More...
 
 PdfSaveOptions ()
 Initializes a new instance of this class that can be used to save a document in the Aspose::Words::SaveFormat::Pdf format. More...
 
System::SharedPtr< Aspose::Words::Saving::PdfSaveOptionsClone ()
 Creates a deep clone of this object. More...
 
- Public Member Functions inherited from Aspose::Words::Saving::FixedPageSaveOptions
int32_t get_PageIndex () const
 Gets or sets the 0-based index of the first page to save. Default is 0. More...
 
void set_PageIndex (int32_t value)
 Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_PageIndex. More...
 
int32_t get_PageCount () const
 Gets or sets the number of pages to save. Default is System::Int32::MaxValue which means all pages of the document will be rendered. More...
 
void set_PageCount (int32_t value)
 Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_PageCount. More...
 
System::SharedPtr< Aspose::Words::Saving::IPageSavingCallback > get_PageSavingCallback () const
 Allows to control how separate pages are saved when a document is exported to fixed page format. More...
 
void set_PageSavingCallback (System::SharedPtr< Aspose::Words::Saving::IPageSavingCallback > value)
 Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_PageSavingCallback. More...
 
Aspose::Words::Saving::NumeralFormat get_NumeralFormat () const
 Gets or sets Aspose::Words::Saving::NumeralFormat used for rendering of numerals. European numerals are used by default. More...
 
void set_NumeralFormat (Aspose::Words::Saving::NumeralFormat value)
 Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_NumeralFormat. More...
 
System::SharedPtr< Aspose::Words::Saving::MetafileRenderingOptionsget_MetafileRenderingOptions () const
 Allows to specify metafile rendering options. More...
 
void set_MetafileRenderingOptions (System::SharedPtr< Aspose::Words::Saving::MetafileRenderingOptions > value)
 Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_MetafileRenderingOptions. More...
 
int32_t get_JpegQuality () const
 Gets or sets a value determining the quality of the JPEG images inside Html document. More...
 
void set_JpegQuality (int32_t value)
 Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_JpegQuality. More...
 
virtual bool get_OptimizeOutput ()
 Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. More...
 
virtual void set_OptimizeOutput (bool value)
 Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_OptimizeOutput. More...
 
virtual bool Equals (System::SharedPtr< System::Object > obj)
 
 FixedPageSaveOptions ()
 
- Public Member Functions inherited from Aspose::Words::Saving::SaveOptions
System::String get_TempFolder () const
 Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is null and no temporary files are used. More...
 
void set_TempFolder (System::String value)
 Setter for Aspose::Words::Saving::SaveOptions::get_TempFolder. More...
 
bool get_PrettyFormat () const
 When true, pretty formats output where applicable. Default value is false. More...
 
void set_PrettyFormat (bool value)
 Setter for Aspose::Words::Saving::SaveOptions::get_PrettyFormat. More...
 
bool get_UseAntiAliasing () const
 Gets or sets a value determining whether or not to use anti-aliasing for rendering. More...
 
void set_UseAntiAliasing (bool value)
 Setter for Aspose::Words::Saving::SaveOptions::get_UseAntiAliasing. More...
 
bool get_UseHighQualityRendering () const
 Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. More...
 
void set_UseHighQualityRendering (bool value)
 Setter for Aspose::Words::Saving::SaveOptions::get_UseHighQualityRendering. More...
 
bool get_UpdateSdtContent () const
 Gets or sets value determining whether content of Aspose::Words::Markup::StructuredDocumentTag is updated before saving. More...
 
void set_UpdateSdtContent (bool value)
 Setter for Aspose::Words::Saving::SaveOptions::get_UpdateSdtContent. More...
 
Aspose::Words::Saving::ColorMode get_ColorMode () const
 Gets or sets a value determining how colors are rendered. More...
 
void set_ColorMode (Aspose::Words::Saving::ColorMode value)
 Setter for Aspose::Words::Saving::SaveOptions::get_ColorMode. More...
 
Aspose::Words::Saving::DmlRenderingMode get_DmlRenderingMode () const
 Gets or sets a value determining how DrawingML shapes are rendered. More...
 
void set_DmlRenderingMode (Aspose::Words::Saving::DmlRenderingMode value)
 Setter for Aspose::Words::Saving::SaveOptions::get_DmlRenderingMode. More...
 
System::String get_DefaultTemplate () const
 Gets or sets path to default template (including filename). Default value for this property is empty string (System::String::Empty). More...
 
void set_DefaultTemplate (System::String value)
 Setter for Aspose::Words::Saving::SaveOptions::get_DefaultTemplate. More...
 
bool get_UpdateFields () const
 Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true. More...
 
void set_UpdateFields (bool value)
 Setter for Aspose::Words::Saving::SaveOptions::get_UpdateFields. More...
 
bool get_UpdateLastSavedTimeProperty () const
 Gets or sets a value determining whether the Aspose::Words::Properties::BuiltInDocumentProperties::get_LastSavedTime property is updated before saving. More...
 
void set_UpdateLastSavedTimeProperty (bool value)
 Setter for Aspose::Words::Saving::SaveOptions::get_UpdateLastSavedTimeProperty. More...
 
bool get_MemoryOptimization () const
 Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false. More...
 
void set_MemoryOptimization (bool value)
 Setter for Aspose::Words::Saving::SaveOptions::get_MemoryOptimization. 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...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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 refernce 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_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 TypeInfoGetType () 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 (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Static Public Member Functions inherited from Aspose::Words::Saving::SaveOptions
static System::SharedPtr< Aspose::Words::Saving::SaveOptionsCreateSaveOptions (Aspose::Words::SaveFormat saveFormat)
 Creates a save options object of a class suitable for the specified save format. More...
 
static System::SharedPtr< Aspose::Words::Saving::SaveOptionsCreateSaveOptions (System::String fileName)
 Creates a save options object of a class suitable for the file extension specified in the given file name. 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 TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Detailed Description

Can be used to specify additional options when saving a document into the Aspose::Words::SaveFormat::Pdf format.

Constructor & Destructor Documentation

◆ PdfSaveOptions()

Aspose::Words::Saving::PdfSaveOptions::PdfSaveOptions ( )

Initializes a new instance of this class that can be used to save a document in the Aspose::Words::SaveFormat::Pdf format.

Member Function Documentation

◆ Clone()

System::SharedPtr<Aspose::Words::Saving::PdfSaveOptions> Aspose::Words::Saving::PdfSaveOptions::Clone ( )

Creates a deep clone of this object.

◆ get_AdditionalTextPositioning()

bool Aspose::Words::Saving::PdfSaveOptions::get_AdditionalTextPositioning ( ) const

A flag specifying whether to write additional text positioning operators or not.

If true, additional text positioning operators are written to the output PDF. This may help to overcome issues with inaccurate text positioning with some printers. The downside is the increased PDF document size.

The default value is false.

◆ get_Compliance()

Aspose::Words::Saving::PdfCompliance Aspose::Words::Saving::PdfSaveOptions::get_Compliance ( ) const

Specifies the PDF standards compliance level for output documents.

Default is Aspose::Words::Saving::PdfCompliance::Pdf15.

◆ get_CreateNoteHyperlinks()

bool Aspose::Words::Saving::PdfSaveOptions::get_CreateNoteHyperlinks ( ) const

Specifies whether to convert footnote/endnote references in main text story into active hyperlinks. When clicked the hyperlink will lead to the corresponding footnote/endnote. Default is false.

◆ get_CustomPropertiesExport()

Aspose::Words::Saving::PdfCustomPropertiesExport Aspose::Words::Saving::PdfSaveOptions::get_CustomPropertiesExport ( ) const

Gets or sets a value determining the way Aspose::Words::Document::get_CustomDocumentProperties are exported to PDF file. Default value is Aspose::Words::Saving::PdfCustomPropertiesExport::None.

◆ get_DisplayDocTitle()

bool Aspose::Words::Saving::PdfSaveOptions::get_DisplayDocTitle ( ) const

A flag specifying whether the window�s title bar should display the document title taken from the Title entry of the document information dictionary.

If false, the title bar should instead display the name of the PDF file containing the document.

The default value is false.

◆ get_DmlEffectsRenderingMode()

virtual Aspose::Words::Saving::DmlEffectsRenderingMode Aspose::Words::Saving::PdfSaveOptions::get_DmlEffectsRenderingMode ( )
virtual

Gets or sets a value determining how DrawingML effects are rendered.

The default value is Aspose::Words::Saving::DmlEffectsRenderingMode::Simplified.

This property is used when the document is exported to fixed page formats.

If Aspose::Words::Saving::PdfSaveOptions::get_Compliance is set to Aspose::Words::Saving::PdfCompliance::PdfA1a or Aspose::Words::Saving::PdfCompliance::PdfA1b, property always returns Aspose::Words::Saving::DmlEffectsRenderingMode::None.

Reimplemented from Aspose::Words::Saving::SaveOptions.

◆ get_DownsampleOptions()

System::SharedPtr<Aspose::Words::Saving::DownsampleOptions> Aspose::Words::Saving::PdfSaveOptions::get_DownsampleOptions ( ) const

Allows to specify downsample options.

◆ get_EmbedFullFonts()

bool Aspose::Words::Saving::PdfSaveOptions::get_EmbedFullFonts ( ) const

Controls how fonts are embedded into the resulting PDF documents.

The default value is false, which means the fonts are subsetted before embedding. Subsetting is useful if you want to keep the output file size smaller. Subsetting removes all unused glyphs from a font.

When this value is set to true, a complete font file is embedded into PDF without subsetting. This will result in larger output files, but can be a useful option when you want to edit the resulting PDF later (e.g. add more text).

Some fonts are large (several megabytes) and embedding them without subsetting will result in large output documents.

◆ get_EscapeUri()

bool Aspose::Words::Saving::PdfSaveOptions::get_EscapeUri ( ) const

A flag specifying whether URI should be escaped before writing.

Note that if this option is set to false hyperlinks are written "as is", so valid (escaped) URI should be provided in document's model.

The default value is true.

◆ get_ExportDocumentStructure()

bool Aspose::Words::Saving::PdfSaveOptions::get_ExportDocumentStructure ( ) const

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

This value is ignored when saving to PDF/A-1a because document structure is required for this compliance.

Note that exporting the document structure significantly increases the memory consumption, especially for the large documents.

◆ get_FontEmbeddingMode()

Aspose::Words::Saving::PdfFontEmbeddingMode Aspose::Words::Saving::PdfSaveOptions::get_FontEmbeddingMode ( ) const

Specifies the font embedding mode.

The default value is Aspose::Words::Saving::PdfFontEmbeddingMode::EmbedAll.

This setting works only for the text in ANSI (Windows-1252) encoding. If the document contains non-ANSI text then corresponding fonts will be embedded regardless of this setting.

Note that when saving to PDF/A this option must be set to Aspose::Words::Saving::PdfFontEmbeddingMode::EmbedAll as all fonts must be embedded in the PDF file.

◆ get_HeaderFooterBookmarksExportMode()

Aspose::Words::Saving::HeaderFooterBookmarksExportMode Aspose::Words::Saving::PdfSaveOptions::get_HeaderFooterBookmarksExportMode ( ) const

Determines how bookmarks in headers/footers are exported.

The default value is Aspose::Words::Saving::HeaderFooterBookmarksExportMode::All.

◆ get_ImageColorSpaceExportMode()

Aspose::Words::Saving::PdfImageColorSpaceExportMode Aspose::Words::Saving::PdfSaveOptions::get_ImageColorSpaceExportMode ( ) const

Specifies how the color space will be selected for the images in PDF document.

The default value is Aspose::Words::Saving::PdfImageColorSpaceExportMode::Auto. If Aspose::Words::Saving::PdfImageColorSpaceExportMode::SimpleCmyk value is specified, Aspose::Words::Saving::PdfSaveOptions::get_ImageCompression option is ignored and Flate compression is used for all images in the document.

◆ get_ImageCompression()

Aspose::Words::Saving::PdfImageCompression Aspose::Words::Saving::PdfSaveOptions::get_ImageCompression ( ) const

Specifies compression type to be used for all images in the document. Default is Aspose::Words::Saving::PdfImageCompression::Auto.

Using Aspose::Words::Saving::PdfImageCompression::Jpeg lets you control quality of images in the output document through the Aspose::Words::Saving::PdfSaveOptions::get_JpegQuality property. Using Aspose::Words::Saving::PdfImageCompression::Jpeg provides the fastest conversion speed when compared to the performance of other compression types.

◆ get_JpegQuality()

int32_t Aspose::Words::Saving::PdfSaveOptions::get_JpegQuality ( )

Gets or sets a value determining the quality of the JPEG images inside PDF document.

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. If quality is 100 and source image is JPEG, it means no compression - original bytes will be saved.

The default value is 100.

◆ get_OpenHyperlinksInNewWindow()

bool Aspose::Words::Saving::PdfSaveOptions::get_OpenHyperlinksInNewWindow ( ) const

Gets or sets a value determining whether hyperlinks in the output Pdf document are forced to be opened in a new window (or tab) of a browser.

The default value is false. When this value is set to true hyperlinks are saved using JavaScript code. JavaScript code is app.launchURL("URL", true);, where URL is a hyperlink.

Note that if this option is set to true hyperlinks can't work in some PDF readers e.g. Chrome, Firefox.

◆ get_OutlineOptions()

System::SharedPtr<Aspose::Words::Saving::OutlineOptions> Aspose::Words::Saving::PdfSaveOptions::get_OutlineOptions ( ) const

Allows to specify outline options.

◆ get_PageMode()

Aspose::Words::Saving::PdfPageMode Aspose::Words::Saving::PdfSaveOptions::get_PageMode ( ) const

Specifies how the PDF document should be displayed when opened in the PDF reader.

The default value is Aspose::Words::Saving::PdfPageMode::UseOutlines.

◆ get_PreblendImages()

bool Aspose::Words::Saving::PdfSaveOptions::get_PreblendImages ( ) const

Gets or sets a value determining whether or not to preblend transparent images with black background color.

Preblending images may improve PDF document visual appearance in Adobe Reader and remove anti-aliasing artifacts.

In order to properly display preblended images, PDF viewer application must support /Matte entry in soft-mask image dictionary. Also preblending images may decrease PDF rendering performance.

The default value is false.

◆ get_PreserveFormFields()

bool Aspose::Words::Saving::PdfSaveOptions::get_PreserveFormFields ( ) const

Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text. Default is false.

Microsoft Word form fields include text input, drop down and check box controls. When set to false, these fields will be exported as text to PDF. When set to true, these fields will be exported as PDF form fields.

When exporting form fields to PDF as form fields, some formatting loss might occur because PDF form fields do not support all features of Microsoft Word form fields.

◆ get_SaveFormat()

virtual Aspose::Words::SaveFormat Aspose::Words::Saving::PdfSaveOptions::get_SaveFormat ( )
virtual

Specifies the format in which the document will be saved if this save options object is used. Can only be Aspose::Words::SaveFormat::Pdf.

Implements Aspose::Words::Saving::SaveOptions.

◆ get_TextCompression()

Aspose::Words::Saving::PdfTextCompression Aspose::Words::Saving::PdfSaveOptions::get_TextCompression ( ) const

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

Default is Aspose::Words::Saving::PdfTextCompression::Flate.

◆ get_UseBookFoldPrintingSettings()

bool Aspose::Words::Saving::PdfSaveOptions::get_UseBookFoldPrintingSettings ( ) const

Gets or sets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via Aspose::Words::PageSetup::get_MultiplePages.

If this option is specified, page range set via Aspose::Words::Saving::FixedPageSaveOptions::get_PageIndex and Aspose::Words::Saving::FixedPageSaveOptions::get_PageCount is ignored when saving. This behavior matches MS Word. If book fold printing settings are not specified in page setup, this option will have no effect.

◆ get_UseCoreFonts()

bool Aspose::Words::Saving::PdfSaveOptions::get_UseCoreFonts ( ) const

Gets or sets a value determining whether or not to substitute TrueType fonts Arial, Times New Roman, Courier New and Symbol with core PDF Type 1 fonts.

The default value is false. When this value is set to true Arial, Times New Roman, Courier New and Symbol fonts are replaced in PDF document with corresponding core Type 1 font.

Core PDF fonts, or their font metrics and suitable substitution fonts, are required to be available to any PDF viewer application.

This setting works only for the text in ANSI (Windows-1252) encoding. Non-ANSI text will be written with embedded TrueType font regardless of this setting.

Settings core fonts to true is not allowed when saving to PDF/A as this compliance requires all fonts to be embedded.

This option has a higher priority then Aspose::Words::Saving::PdfSaveOptions::get_FontEmbeddingMode option.

◆ get_ZoomBehavior()

Aspose::Words::Saving::PdfZoomBehavior Aspose::Words::Saving::PdfSaveOptions::get_ZoomBehavior ( ) const

Gets or sets a value determining what type of zoom should be applied when a document is opened with a PDF viewer.

The default value is Aspose::Words::Saving::PdfZoomBehavior::None, i.e. no fit is applied.

◆ get_ZoomFactor()

int32_t Aspose::Words::Saving::PdfSaveOptions::get_ZoomFactor ( ) const

Gets or sets a value determining zoom factor (in percentages) for a document.

This value is used only if Aspose::Words::Saving::PdfSaveOptions::get_ZoomBehavior is set to Aspose::Words::Saving::PdfZoomBehavior::ZoomFactor.

◆ set_AdditionalTextPositioning()

void Aspose::Words::Saving::PdfSaveOptions::set_AdditionalTextPositioning ( bool  value)

◆ set_Compliance()

void Aspose::Words::Saving::PdfSaveOptions::set_Compliance ( Aspose::Words::Saving::PdfCompliance  value)

◆ set_CreateNoteHyperlinks()

void Aspose::Words::Saving::PdfSaveOptions::set_CreateNoteHyperlinks ( bool  value)

◆ set_CustomPropertiesExport()

void Aspose::Words::Saving::PdfSaveOptions::set_CustomPropertiesExport ( Aspose::Words::Saving::PdfCustomPropertiesExport  value)

◆ set_DisplayDocTitle()

void Aspose::Words::Saving::PdfSaveOptions::set_DisplayDocTitle ( bool  value)

◆ set_DmlEffectsRenderingMode()

virtual void Aspose::Words::Saving::PdfSaveOptions::set_DmlEffectsRenderingMode ( Aspose::Words::Saving::DmlEffectsRenderingMode  value)
virtual

◆ set_DownsampleOptions()

void Aspose::Words::Saving::PdfSaveOptions::set_DownsampleOptions ( System::SharedPtr< Aspose::Words::Saving::DownsampleOptions value)

◆ set_EmbedFullFonts()

void Aspose::Words::Saving::PdfSaveOptions::set_EmbedFullFonts ( bool  value)

◆ set_EscapeUri()

void Aspose::Words::Saving::PdfSaveOptions::set_EscapeUri ( bool  value)

◆ set_ExportDocumentStructure()

void Aspose::Words::Saving::PdfSaveOptions::set_ExportDocumentStructure ( bool  value)

◆ set_FontEmbeddingMode()

void Aspose::Words::Saving::PdfSaveOptions::set_FontEmbeddingMode ( Aspose::Words::Saving::PdfFontEmbeddingMode  value)

◆ set_HeaderFooterBookmarksExportMode()

void Aspose::Words::Saving::PdfSaveOptions::set_HeaderFooterBookmarksExportMode ( Aspose::Words::Saving::HeaderFooterBookmarksExportMode  value)

◆ set_ImageColorSpaceExportMode()

void Aspose::Words::Saving::PdfSaveOptions::set_ImageColorSpaceExportMode ( Aspose::Words::Saving::PdfImageColorSpaceExportMode  value)

◆ set_ImageCompression()

void Aspose::Words::Saving::PdfSaveOptions::set_ImageCompression ( Aspose::Words::Saving::PdfImageCompression  value)

◆ set_JpegQuality()

void Aspose::Words::Saving::PdfSaveOptions::set_JpegQuality ( int32_t  value)

◆ set_OpenHyperlinksInNewWindow()

void Aspose::Words::Saving::PdfSaveOptions::set_OpenHyperlinksInNewWindow ( bool  value)

◆ set_PageMode()

void Aspose::Words::Saving::PdfSaveOptions::set_PageMode ( Aspose::Words::Saving::PdfPageMode  value)

◆ set_PreblendImages()

void Aspose::Words::Saving::PdfSaveOptions::set_PreblendImages ( bool  value)

◆ set_PreserveFormFields()

void Aspose::Words::Saving::PdfSaveOptions::set_PreserveFormFields ( bool  value)

◆ set_SaveFormat()

virtual void Aspose::Words::Saving::PdfSaveOptions::set_SaveFormat ( Aspose::Words::SaveFormat  value)
virtual

◆ set_TextCompression()

void Aspose::Words::Saving::PdfSaveOptions::set_TextCompression ( Aspose::Words::Saving::PdfTextCompression  value)

◆ set_UseBookFoldPrintingSettings()

void Aspose::Words::Saving::PdfSaveOptions::set_UseBookFoldPrintingSettings ( bool  value)

◆ set_UseCoreFonts()

void Aspose::Words::Saving::PdfSaveOptions::set_UseCoreFonts ( bool  value)

◆ set_ZoomBehavior()

void Aspose::Words::Saving::PdfSaveOptions::set_ZoomBehavior ( Aspose::Words::Saving::PdfZoomBehavior  value)

◆ set_ZoomFactor()

void Aspose::Words::Saving::PdfSaveOptions::set_ZoomFactor ( int32_t  value)