Aspose::Pdf::SaveOptions Class Reference

enumerates possible types of saved external resources More...

Inherits System::Object.

Inherited by Aspose::Pdf::PdfSaveOptions, Aspose::Pdf::PluginSaveOptions, 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, botom, 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< 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...
 

Public Member Functions

System::SharedPtr< IWarningCallbackget_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...
 
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::SaveFormat get_SaveFormat () const
 Format of data save. More...
 
bool get_CloseResponse () const
 Gets boolean value which indicates will Response object be closed after document saved into response. More...
 
void set_CloseResponse (bool value)
 Sets boolean value which indicates will Response object be closed after document saved into response. More...
 
 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...
 
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...
 
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 int 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 TypeInfoGetType () 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 (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)
 

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 TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Detailed Description

enumerates possible types of saved external resources

Member Enumeration Documentation

◆ HtmlBorderLineType

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 

grove line will be shown

Ridge 

ridhe line will be shown

Inset 

inset line will be shown

Outset 

outset line will be shown

◆ NodeLevelResourceType

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::SaveOptions::SaveOptions ( )

Member Function Documentation

◆ get_CloseResponse()

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::SaveFormat Aspose::Pdf::SaveOptions::get_SaveFormat ( ) const

Format of data save.

◆ get_WarningHandler()

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()

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()

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