Base class for Publisher document references for use in package conversions. Provides fields for specifying output source for the converted document - OutputFileName for a disk file and OutputStream for stream. Also provides conversion settings. More...

#include <PubPackageConverter.h>

Inherits System::Object.

Inherited by Aspose::Pub::PackageFileItem, and Aspose::Pub::PackageStreamItem.

Public Member Functions
ASPOSE_PUB_SHARED_API System::String	get_OutputFileName () const
	Name of output file. Full path is required.

ASPOSE_PUB_SHARED_API void	set_OutputFileName (System::String value)
	Name of output file. Full path is required.

ASPOSE_PUB_SHARED_API System::SharedPtr< System::IO::Stream >	get_OutputStream () const
	Output stream for saving conversion result.

ASPOSE_PUB_SHARED_API void	set_OutputStream (System::SharedPtr< System::IO::Stream > value)
	Output stream for saving conversion result.

ASPOSE_PUB_SHARED_API System::SharedPtr< PubToPdfConversionOptions >	get_ConversionOptions () const
	Conversion settings.

ASPOSE_PUB_SHARED_API void	set_ConversionOptions (System::SharedPtr< PubToPdfConversionOptions > value)
	Conversion settings.

ASPOSE_PUB_SHARED_API	PackageDocumentItem (System::String outputFileName)
	Constructor.

ASPOSE_PUB_SHARED_API	PackageDocumentItem (System::String outputFileName, System::SharedPtr< PubToPdfConversionOptions > conversionOptions)
	Constructor.

ASPOSE_PUB_SHARED_API	PackageDocumentItem (System::SharedPtr< System::IO::Stream > outputStream)
	Constructor.

ASPOSE_PUB_SHARED_API	PackageDocumentItem (System::SharedPtr< System::IO::Stream > outputStream, System::SharedPtr< PubToPdfConversionOptions > conversionOptions)
	Constructor.

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.

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses.

Object *	SharedRefAdded ()
	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 TypeInfo &	GetType () 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< Object >	ptr
	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 TypeInfo &	Type ()
	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

Base class for Publisher document references for use in package conversions. Provides fields for specifying output source for the converted document - OutputFileName for a disk file and OutputStream for stream. Also provides conversion settings.

Constructor & Destructor Documentation

◆ PackageDocumentItem() [1/4]

ASPOSE_PUB_SHARED_API Aspose::Pub::PackageDocumentItem::PackageDocumentItem ( System::String outputFileName )

Constructor.

Parameters

outputFileName The name of the output file that is the result of the conversion. Full path is required.

◆ PackageDocumentItem() [2/4]

ASPOSE_PUB_SHARED_API Aspose::Pub::PackageDocumentItem::PackageDocumentItem	(	System::String	outputFileName,
		System::SharedPtr< PubToPdfConversionOptions >	conversionOptions )

Constructor.

Parameters

outputFileName	The name of the output file that is the result of the conversion. Full path is required.
conversionOptions	Conversion settings.

◆ PackageDocumentItem() [3/4]

ASPOSE_PUB_SHARED_API Aspose::Pub::PackageDocumentItem::PackageDocumentItem ( System::SharedPtr< System::IO::Stream > outputStream )

Constructor.

Parameters

outputStream Stream for saving conversion result.

◆ PackageDocumentItem() [4/4]

ASPOSE_PUB_SHARED_API Aspose::Pub::PackageDocumentItem::PackageDocumentItem	(	System::SharedPtr< System::IO::Stream >	outputStream,
		System::SharedPtr< PubToPdfConversionOptions >	conversionOptions )

Constructor.

Parameters

outputStream	Stream for saving conversion result.
conversionOptions	Conversion settings.

Member Function Documentation

◆ get_ConversionOptions()

ASPOSE_PUB_SHARED_API System::SharedPtr< PubToPdfConversionOptions > Aspose::Pub::PackageDocumentItem::get_ConversionOptions ( ) const

Conversion settings.

◆ get_OutputFileName()

ASPOSE_PUB_SHARED_API System::String Aspose::Pub::PackageDocumentItem::get_OutputFileName ( ) const

Name of output file. Full path is required.

◆ get_OutputStream()

ASPOSE_PUB_SHARED_API System::SharedPtr< System::IO::Stream > Aspose::Pub::PackageDocumentItem::get_OutputStream ( ) const

Output stream for saving conversion result.

◆ set_ConversionOptions()

ASPOSE_PUB_SHARED_API void Aspose::Pub::PackageDocumentItem::set_ConversionOptions ( System::SharedPtr< PubToPdfConversionOptions > value )

Conversion settings.

◆ set_OutputFileName()

ASPOSE_PUB_SHARED_API void Aspose::Pub::PackageDocumentItem::set_OutputFileName ( System::String value )

Name of output file. Full path is required.

◆ set_OutputStream()

ASPOSE_PUB_SHARED_API void Aspose::Pub::PackageDocumentItem::set_OutputStream ( System::SharedPtr< System::IO::Stream > value )

Output stream for saving conversion result.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PackageDocumentItem() [1/4]

◆ PackageDocumentItem() [2/4]

◆ PackageDocumentItem() [3/4]

◆ PackageDocumentItem() [4/4]

Member Function Documentation

◆ get_ConversionOptions()

◆ get_OutputFileName()

◆ get_OutputStream()

◆ set_ConversionOptions()

◆ set_OutputFileName()

◆ set_OutputStream()