Aspose::Words::Saving::FixedPageSaveOptions Class Reference

Contains common options that can be specified when saving a document into fixed page formats (PDF, XPS, images etc). More...

#include "Model/Saving/FixedPageSaveOptions.h"

Inherits Aspose::Words::Saving::SaveOptions.

Inherited by Aspose::Words::Saving::HtmlFixedSaveOptions, Aspose::Words::Saving::ImageSaveOptions, Aspose::Words::Saving::PclSaveOptions, Aspose::Words::Saving::PdfSaveOptions, Aspose::Words::Saving::PsSaveOptions, Aspose::Words::Saving::SvgSaveOptions, Aspose::Words::Saving::XamlFixedSaveOptions, and Aspose::Words::Saving::XpsSaveOptions.

Public Member Functions

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
virtual Aspose::Words::SaveFormat get_SaveFormat ()=0
 Specifies the format in which the document will be saved if this save options object is used. More...
 
virtual void set_SaveFormat (Aspose::Words::SaveFormat value)=0
 Setter for Aspose::Words::Saving::SaveOptions::get_SaveFormat. More...
 
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...
 
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::SaveOptions::get_DmlEffectsRenderingMode. 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...
 
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)
 

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

Detailed Description

Contains common options that can be specified when saving a document into fixed page formats (PDF, XPS, images etc).

Constructor & Destructor Documentation

◆ FixedPageSaveOptions()

Aspose::Words::Saving::FixedPageSaveOptions::FixedPageSaveOptions ( )

Member Function Documentation

◆ Equals()

virtual bool Aspose::Words::Saving::FixedPageSaveOptions::Equals ( System::SharedPtr< System::Object obj)
virtual

◆ get_JpegQuality()

int32_t Aspose::Words::Saving::FixedPageSaveOptions::get_JpegQuality ( ) const

Gets or sets a value determining the quality of the JPEG images inside Html 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 fixed page 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 95.

◆ get_MetafileRenderingOptions()

System::SharedPtr<Aspose::Words::Saving::MetafileRenderingOptions> Aspose::Words::Saving::FixedPageSaveOptions::get_MetafileRenderingOptions ( ) const

Allows to specify metafile rendering options.

◆ get_NumeralFormat()

Aspose::Words::Saving::NumeralFormat Aspose::Words::Saving::FixedPageSaveOptions::get_NumeralFormat ( ) const

Gets or sets Aspose::Words::Saving::NumeralFormat used for rendering of numerals. European numerals are used by default.

If the value of this property is changed and page layout is already built then Aspose::Words::Document::UpdatePageLayout is invoked automatically to update any changes.

◆ get_OptimizeOutput()

virtual bool Aspose::Words::Saving::FixedPageSaveOptions::get_OptimizeOutput ( )
virtual

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.

Default is false.

Reimplemented in Aspose::Words::Saving::HtmlFixedSaveOptions.

◆ get_PageCount()

int32_t Aspose::Words::Saving::FixedPageSaveOptions::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.

◆ get_PageIndex()

int32_t Aspose::Words::Saving::FixedPageSaveOptions::get_PageIndex ( ) const

Gets or sets the 0-based index of the first page to save. Default is 0.

◆ get_PageSavingCallback()

System::SharedPtr<Aspose::Words::Saving::IPageSavingCallback> Aspose::Words::Saving::FixedPageSaveOptions::get_PageSavingCallback ( ) const

Allows to control how separate pages are saved when a document is exported to fixed page format.

◆ set_JpegQuality()

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

◆ set_MetafileRenderingOptions()

void Aspose::Words::Saving::FixedPageSaveOptions::set_MetafileRenderingOptions ( System::SharedPtr< Aspose::Words::Saving::MetafileRenderingOptions value)

◆ set_NumeralFormat()

void Aspose::Words::Saving::FixedPageSaveOptions::set_NumeralFormat ( Aspose::Words::Saving::NumeralFormat  value)

◆ set_OptimizeOutput()

virtual void Aspose::Words::Saving::FixedPageSaveOptions::set_OptimizeOutput ( bool  value)
virtual

◆ set_PageCount()

void Aspose::Words::Saving::FixedPageSaveOptions::set_PageCount ( int32_t  value)

◆ set_PageIndex()

void Aspose::Words::Saving::FixedPageSaveOptions::set_PageIndex ( int32_t  value)

◆ set_PageSavingCallback()

void Aspose::Words::Saving::FixedPageSaveOptions::set_PageSavingCallback ( System::SharedPtr< Aspose::Words::Saving::IPageSavingCallback >  value)