Aspose::Pdf::LoadOptions Class Reference

ATTENTION! The feature implemented but did not put yet to public API since blocker issue in OSHARED layer revealed for sample document. More...

Inherits System::Object.

Inherited by Aspose::Pdf::AutoDetectedFormatLoadOptions, Aspose::Pdf::CgmLoadOptions, Aspose::Pdf::EpubLoadOptions, Aspose::Pdf::HtmlLoadOptions, Aspose::Pdf::MdLoadOptions, Aspose::Pdf::MhtLoadOptions, Aspose::Pdf::PclLoadOptions, Aspose::Pdf::PluginLoadOptions, Aspose::Pdf::PsLoadOptions, Aspose::Pdf::SvgLoadOptions, Aspose::Pdf::XmlLoadOptions, and Aspose::Pdf::XpsLoadOptions.

Classes

class  ResourceLoadingResult
 

Public Types

enum  MarginsAreaUsageModes { MarginsAreaUsageModes::PutContentOnMarginAreaIfNecessary = 0, MarginsAreaUsageModes::NeverPutContentOnMarginArea = 1 }
 
enum  PageSizeAdjustmentModes { PageSizeAdjustmentModes::NoAjustmentAllwaysUsePredefinedSize = 0, PageSizeAdjustmentModes::EnlargeRequiredViewportWidthAndDoConversionAgain = 1 }
 
using ResourceLoadingStrategy = System::MulticastDelegate< System::SharedPtr< LoadOptions::ResourceLoadingResult >(System::String)>
 
- 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 ()
 Callback to handle any warnings generated. The WarningHandler returns ReturnAction enum item specifying either Continue or Abort. Continue is the default action and the Load operation continues, however the user may also return Abort in which case the Load 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 Load operation continues, however the user may also return Abort in which case the Load operation should cease. More...
 
Aspose::Pdf::LoadFormat get_LoadFormat ()
 Represents file format which LoadOptions describes. More...
 
 LoadOptions ()
 
- 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 () ASPOSE_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::LoadFormat _loadFormat
 
System::String ApsIntermediateFileIfAny
 
System::String XpsIntermediateFileIfAny
 
System::String PngIntermediateFileIfAny
 
ApsToXpsSavingType ApsAsXpsSavingType
 
System::String PlainApsIntermediateTempFileIfAny
 
bool UseAreaClipping
 
System::SharedPtr< Aspose::Pdf::PagePage
 
bool DontConvertToPdf
 

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

ATTENTION! The feature implemented but did not put yet to public API since blocker issue in OSHARED layer revealed for sample document.

Represents mode of usage of page size during conversion. Formats (like HTML, EPUB etc), usually have float design, so, it allows to fit required pagesize. But sometimes content has specifies horizontal positions or size that does not allow put content into required page size. In such case we can define what should be done in this case (i.e when size of content does not fit required initial page size of result PDF document).

Member Typedef Documentation

◆ ResourceLoadingStrategy

Member Enumeration Documentation

◆ MarginsAreaUsageModes

Enumerator
PutContentOnMarginAreaIfNecessary 

In this mode converter obeyes format of imported document (f.e. CSS of imported HTML) in usage of margins area.So, if format of imported document requires usage of margins area for rendering , converter will allow that

NeverPutContentOnMarginArea 

This mode strictly forbids usage of margins area, so, converter will never use area of margins for rendering, even if CSS or format of source document allows or requirs that

◆ PageSizeAdjustmentModes

Enumerator
NoAjustmentAllwaysUsePredefinedSize 

In this mode result pages will have required pagesize defined in LoadOptions, no matter whether content after conversion goes out of page boundaries or no.

EnlargeRequiredViewportWidthAndDoConversionAgain 

This mode defines such behaviour: after getting of conversion result , and detecting of fact that some content has been truncated, width of portview is enlarged to fit content and conversion is repeated. This mode allows getting of less pages in result in such case but requires repeated rendering(and therefore more processing time).

Constructor & Destructor Documentation

◆ LoadOptions()

Aspose::Pdf::LoadOptions::LoadOptions ( )

Member Function Documentation

◆ get_LoadFormat()

Aspose::Pdf::LoadFormat Aspose::Pdf::LoadOptions::get_LoadFormat ( )

Represents file format which LoadOptions describes.

◆ get_WarningHandler()

System::SharedPtr<IWarningCallback> Aspose::Pdf::LoadOptions::get_WarningHandler ( )

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

◆ set_WarningHandler()

void Aspose::Pdf::LoadOptions::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 Load operation continues, however the user may also return Abort in which case the Load operation should cease.

Member Data Documentation

◆ _loadFormat

Aspose::Pdf::LoadFormat Aspose::Pdf::LoadOptions::_loadFormat
protected

◆ ApsAsXpsSavingType

ApsToXpsSavingType Aspose::Pdf::LoadOptions::ApsAsXpsSavingType
protected

◆ ApsIntermediateFileIfAny

System::String Aspose::Pdf::LoadOptions::ApsIntermediateFileIfAny
protected

◆ DontConvertToPdf

bool Aspose::Pdf::LoadOptions::DontConvertToPdf
protected

◆ Page

System::SharedPtr<Aspose::Pdf::Page> Aspose::Pdf::LoadOptions::Page
protected

◆ PlainApsIntermediateTempFileIfAny

System::String Aspose::Pdf::LoadOptions::PlainApsIntermediateTempFileIfAny
protected

◆ PngIntermediateFileIfAny

System::String Aspose::Pdf::LoadOptions::PngIntermediateFileIfAny
protected

◆ UseAreaClipping

bool Aspose::Pdf::LoadOptions::UseAreaClipping
protected

◆ XpsIntermediateFileIfAny

System::String Aspose::Pdf::LoadOptions::XpsIntermediateFileIfAny
protected