Aspose::Pub::IPubPackageConverter Class Referenceabstract

Declares functionality for converting multiple Publisher documents to a specified format. More...

#include <Interfaces.h>

Inherits System::Object.

Inherited by Aspose::Pub::PubPackageConverter.

Public Member Functions

virtual System::SharedPtr< PackageDocumentCollectionConvertToFormat (System::SharedPtr< PackageDocumentCollection > inputDocumentCollection, bool mergeFiles, PubExportFormats outputFormat, PubDocumentType outputType)=0
 Converts each document from the inputDocumentCollection list to the specified format and saves the results in the appropriate storage. Type of storage to save is specified by outputType parameter. References to converted documents are placed in the returned PackageDocumentCollection object. If the mergeFiles flag is set, then all converted documents will be merged into single document in the same order in which they were placed in the inputDocumentCollection list.
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures.
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures.
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses.
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses.
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value.
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object.
 
int SharedCount () const
 Gets current value of shared reference counter.
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object.
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object.
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics.
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects.
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string.
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types.
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call.
 
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.
 
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.
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only.
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr.
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings.
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type.
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference.
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference.
 
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.
 
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.
 
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.
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct.
 
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.
 
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.
 

Detailed Description

Declares functionality for converting multiple Publisher documents to a specified format.

Member Function Documentation

◆ ConvertToFormat()

virtual System::SharedPtr< PackageDocumentCollection > Aspose::Pub::IPubPackageConverter::ConvertToFormat ( System::SharedPtr< PackageDocumentCollection > inputDocumentCollection,
bool mergeFiles,
PubExportFormats outputFormat,
PubDocumentType outputType )
pure virtual

Converts each document from the inputDocumentCollection list to the specified format and saves the results in the appropriate storage. Type of storage to save is specified by outputType parameter. References to converted documents are placed in the returned PackageDocumentCollection object. If the mergeFiles flag is set, then all converted documents will be merged into single document in the same order in which they were placed in the inputDocumentCollection list.

Parameters
inputDocumentCollectionCollection of input documents.
mergeFilesSpecifies, whether to merge all output documents into the single one.
outputFormatOutput format.


Parameters
outputTypeOutput storage type.
Returns
References to the converted documents in the PackageDocumentCollectionobject.

Implemented in Aspose::Pub::PubPackageConverter.