Provides methods for COM clients to load a document into Aspose.Pdf. More...

#include "ComHelper.h"

Public Member Functions
ASPOSE_PDF_SHARED_API System::SharedPtr< Document >	OpenStream (System::SharedPtr< System::IO::Stream > input)
	Initialize and return new Document instance from the input stream. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Document >	OpenStream (System::SharedPtr< System::IO::Stream > input, System::String password)
	Initialize and return new Document instance from the input stream. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Document >	OpenStream (System::SharedPtr< System::IO::Stream > input, bool isManagedStream)
	Initialize and return new Document instance from the input stream. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Document >	OpenStream (System::SharedPtr< System::IO::Stream > input, System::String password, bool isManagedStream)
	Initialize and return new Document instance from the input stream. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Document >	OpenStream (System::SharedPtr< System::IO::Stream > input, System::SharedPtr< LoadOptions > options)
	Open and return an existing document from a stream providing necessary converting to get pdf document. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Document >	OpenFile (System::String filename)
	Just create and return Document using filename . The same as Document(Stream). More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Document >	OpenFile (System::String filename, System::String password)
	Initialize and return new instance of the Document class for working with encrypted document. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Document >	OpenFile (System::String filename, System::String password, bool isManagedStream)
	Initialize new instance of the Document class for working with encrypted document. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Document >	OpenFile (System::String filename, System::SharedPtr< LoadOptions > options)
	Open an existing document from a file providing necessary converting oprions to get pdf document. More...

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

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

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

Provides methods for COM clients to load a document into Aspose.Pdf.

Use the ComHelper class to load a document from a file or stream into a Document object in a COM application. The Document class provides a default constructor to create a new document and also provides overloaded constructors to load a document from a file or stream. If you are using Aspose.Words from a .NET application, you can use all of the Document constructors directly, but if you are using Aspose.Pdf from a COM application, only the default Document constructor is available.

Member Function Documentation

◆ OpenFile() [1/4]

ASPOSE_PDF_SHARED_API System::SharedPtr<Document> Aspose::Pdf::ComHelper::OpenFile ( System::String filename )

Just create and return Document using filename . The same as Document(Stream).

Parameters

filename The name of the pdf document file.

Returns: Document object

◆ OpenFile() [2/4]

ASPOSE_PDF_SHARED_API System::SharedPtr<Document> Aspose::Pdf::ComHelper::OpenFile	(	System::String	filename,
		System::String	password
	)

Initialize and return new instance of the Document class for working with encrypted document.

Parameters

filename	Document file name.
password	User or owner password.

Returns: Document object

◆ OpenFile() [3/4]

ASPOSE_PDF_SHARED_API System::SharedPtr<Document> Aspose::Pdf::ComHelper::OpenFile	(	System::String	filename,
		System::String	password,
		bool	isManagedStream
	)

Initialize new instance of the Document class for working with encrypted document.

Parameters

filename	Document file name.
password	User or owner password.
isManagedStream	if set to `true` inner stream is closed before exit; otherwise, is not.

Returns: Document object

◆ OpenFile() [4/4]

ASPOSE_PDF_SHARED_API System::SharedPtr<Document> Aspose::Pdf::ComHelper::OpenFile	(	System::String	filename,
		System::SharedPtr< LoadOptions >	options
	)

Open an existing document from a file providing necessary converting oprions to get pdf document.

Parameters

filename	Input file to convert into pdf document.
options	Represents properties for converting filename into pdf document.

Returns: Document object

◆ OpenStream() [1/5]

ASPOSE_PDF_SHARED_API System::SharedPtr<Document> Aspose::Pdf::ComHelper::OpenStream ( System::SharedPtr< System::IO::Stream > input )

Initialize and return new Document instance from the input stream.

Parameters

input Stream with pdf document.

Returns: Document object

◆ OpenStream() [2/5]

ASPOSE_PDF_SHARED_API System::SharedPtr<Document> Aspose::Pdf::ComHelper::OpenStream	(	System::SharedPtr< System::IO::Stream >	input,
		System::String	password
	)

Initialize and return new Document instance from the input stream.

Parameters

input	Input stream object, corresponding pdf is password protected.
password	User or owner password.

Returns: Document object

◆ OpenStream() [3/5]

ASPOSE_PDF_SHARED_API System::SharedPtr<Document> Aspose::Pdf::ComHelper::OpenStream	(	System::SharedPtr< System::IO::Stream >	input,
		bool	isManagedStream
	)

Initialize and return new Document instance from the input stream.

Parameters

input	Stream with pdf document.
isManagedStream	if set to `true` inner stream is closed before exit; otherwise, is not.

Returns: Document object

◆ OpenStream() [4/5]

ASPOSE_PDF_SHARED_API System::SharedPtr<Document> Aspose::Pdf::ComHelper::OpenStream	(	System::SharedPtr< System::IO::Stream >	input,
		System::String	password,
		bool	isManagedStream
	)

Initialize and return new Document instance from the input stream.

Parameters

input	Stream with pdf document.
password	User or owner password.
isManagedStream	if set to `true` inner stream is closed before exit; otherwise, is not.

Returns: Document object

◆ OpenStream() [5/5]

ASPOSE_PDF_SHARED_API System::SharedPtr<Document> Aspose::Pdf::ComHelper::OpenStream	(	System::SharedPtr< System::IO::Stream >	input,
		System::SharedPtr< LoadOptions >	options
	)

Open and return an existing document from a stream providing necessary converting to get pdf document.

Parameters

input	Input stream to convert into pdf document.
options	Represents properties for converting input into pdf document.

Returns: Document object

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ OpenFile() [1/4]

◆ OpenFile() [2/4]

◆ OpenFile() [3/4]

◆ OpenFile() [4/4]

◆ OpenStream() [1/5]

◆ OpenStream() [2/5]

◆ OpenStream() [3/5]

◆ OpenStream() [4/5]

◆ OpenStream() [5/5]