SaveOptions type hold level of abstraction on individual save options More...

#include "SaveOptions.h"

Inherited by Aspose::Pdf::PdfSaveOptions, Aspose::Pdf::UnifiedSaveOptions, and Aspose::Pdf::XmlSaveOptions.

Classes
class	BorderInfo
	Instance of this class represents information about border That can be drown on some result document. More...

class	BorderPartStyle
	Represents information of one part of border(top, bottom, left side or right side) More...

class	MarginInfo
	Instance of this class represents information about page margin That can be drown on some result document. More...

class	MarginPartStyle
	Represents information of one part of margin(top, botom, left side or right side) More...

class	ResourceSavingInfo
	This class represents set of data that related to external resource file's saving that occures during conversion of PDF to some other format (f.e. HTML) More...

Public Types
enum	HtmlBorderLineType { HtmlBorderLineType::None = 0, HtmlBorderLineType::Dotted = 1, HtmlBorderLineType::Dashed = 2, HtmlBorderLineType::Solid = 3, HtmlBorderLineType::Double = 4, HtmlBorderLineType::Groove = 5, HtmlBorderLineType::Ridge = 6, HtmlBorderLineType::Inset = 7, HtmlBorderLineType::Outset = 8 }
	Represents line types that can be used in result document for drawing borders or another lines More...

enum	NodeLevelResourceType { NodeLevelResourceType::Image = 0, NodeLevelResourceType::Font = 1 }
	enumerates possible types of saved external resources More...

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

Public Member Functions
ASPOSE_PDF_SHARED_API System::SharedPtr< IWarningCallback >	get_WarningHandler () const
	Callback to handle any warnings generated. The WarningHandler returns ReturnAction enum item specifying either Continue or Abort. Continue is the default action and the Save operation continues, however the user may also return Abort in which case the Save operation should cease. More...

ASPOSE_PDF_SHARED_API void	set_WarningHandler (System::SharedPtr< IWarningCallback > value)
	Callback to handle any warnings generated. The WarningHandler returns ReturnAction enum item specifying either Continue or Abort. Continue is the default action and the Save operation continues, however the user may also return Abort in which case the Save operation should cease. More...

ASPOSE_PDF_SHARED_API Aspose::Pdf::SaveFormat	get_SaveFormat () const
	Format of data save. More...

ASPOSE_PDF_SHARED_API bool	get_CloseResponse () const
	Gets boolean value which indicates will Response object be closed after document saved into response. More...

ASPOSE_PDF_SHARED_API void	set_CloseResponse (bool value)
	Sets boolean value which indicates will Response object be closed after document saved into response. More...

ASPOSE_PDF_SHARED_API	SaveOptions ()

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

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

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

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

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

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

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

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

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

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

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

virtual ASPOSECPP_SHARED_API 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 ASPOSECPP_SHARED_API bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. 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...

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 Attributes
Aspose::Pdf::SaveFormat	_saveFormat

System::String	ApsIntermediateFileIfAny

System::String	XpsIntermediateFileIfAny

System::String	PngIntermediateFileIfAny

ApsToXpsSavingMode	ApsAsXpsSavingMode

System::SharedPtr< Aspose::DocumentInfo >	DocumentInfoForSaveAsXps

System::String	PlainApsIntermediateTempFileIfAny
	Sometimes we need use temp file to save APS during conversion to avoid OOM exceptions in PalZipWriter For such hard tests can be used this parameter - it will force usage of ile instead of MemoryStream More...

Additional Inherited Members
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...

Detailed Description

SaveOptions type hold level of abstraction on individual save options

Member Enumeration Documentation

◆ HtmlBorderLineType

enum Aspose::Pdf::SaveOptions::HtmlBorderLineType

strong

Represents line types that can be used in result document for drawing borders or another lines

Enumerator
None	No line will be shown.
Dotted	Dotted line will be shown.
Dashed	Dashed line will be shown.
Solid	Solid line will be shown.
Double	Double line will be shown.
Groove	Groove line will be shown.
Ridge	Ridge line will be shown.
Inset	Inset line will be shown.
Outset	Outset line will be shown.

◆ NodeLevelResourceType

enum Aspose::Pdf::SaveOptions::NodeLevelResourceType

strong

enumerates possible types of saved external resources

Enumerator
Image	Means that supplied resource is image
Font	Means that supplied resource is font

Constructor & Destructor Documentation

◆ SaveOptions()

ASPOSE_PDF_SHARED_API Aspose::Pdf::SaveOptions::SaveOptions ( )

Member Function Documentation

◆ get_CloseResponse()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::SaveOptions::get_CloseResponse ( ) const

Gets boolean value which indicates will Response object be closed after document saved into response.

◆ get_SaveFormat()

ASPOSE_PDF_SHARED_API Aspose::Pdf::SaveFormat Aspose::Pdf::SaveOptions::get_SaveFormat ( ) const

Format of data save.

◆ get_WarningHandler()

ASPOSE_PDF_SHARED_API System::SharedPtr<IWarningCallback> Aspose::Pdf::SaveOptions::get_WarningHandler ( ) const

Callback to handle any warnings generated. The WarningHandler returns ReturnAction enum item specifying either Continue or Abort. Continue is the default action and the Save operation continues, however the user may also return Abort in which case the Save operation should cease.

◆ set_CloseResponse()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::SaveOptions::set_CloseResponse ( bool value )

Sets boolean value which indicates will Response object be closed after document saved into response.

◆ set_WarningHandler()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::SaveOptions::set_WarningHandler ( System::SharedPtr< IWarningCallback > value )

Callback to handle any warnings generated. The WarningHandler returns ReturnAction enum item specifying either Continue or Abort. Continue is the default action and the Save operation continues, however the user may also return Abort in which case the Save operation should cease.

Member Data Documentation

◆ _saveFormat

Aspose::Pdf::SaveFormat Aspose::Pdf::SaveOptions::_saveFormat

protected

◆ ApsAsXpsSavingMode

ApsToXpsSavingMode Aspose::Pdf::SaveOptions::ApsAsXpsSavingMode

protected

◆ ApsIntermediateFileIfAny

System::String Aspose::Pdf::SaveOptions::ApsIntermediateFileIfAny

protected

◆ DocumentInfoForSaveAsXps

System::SharedPtr<Aspose::DocumentInfo> Aspose::Pdf::SaveOptions::DocumentInfoForSaveAsXps

protected

◆ PlainApsIntermediateTempFileIfAny

System::String Aspose::Pdf::SaveOptions::PlainApsIntermediateTempFileIfAny

protected

Sometimes we need use temp file to save APS during conversion to avoid OOM exceptions in PalZipWriter For such hard tests can be used this parameter - it will force usage of ile instead of MemoryStream

◆ PngIntermediateFileIfAny

System::String Aspose::Pdf::SaveOptions::PngIntermediateFileIfAny

protected

◆ XpsIntermediateFileIfAny

System::String Aspose::Pdf::SaveOptions::XpsIntermediateFileIfAny

protected

Classes

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ HtmlBorderLineType

◆ NodeLevelResourceType

Constructor & Destructor Documentation

◆ SaveOptions()

Member Function Documentation

◆ get_CloseResponse()

◆ get_SaveFormat()

◆ get_WarningHandler()

◆ set_CloseResponse()

◆ set_WarningHandler()

Member Data Documentation

◆ _saveFormat

◆ ApsAsXpsSavingMode

◆ ApsIntermediateFileIfAny

◆ DocumentInfoForSaveAsXps

◆ PlainApsIntermediateTempFileIfAny

◆ PngIntermediateFileIfAny

◆ XpsIntermediateFileIfAny