Aspose::Pdf::ComHelper Class Reference

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

Inherits System::Object.

Public Member Functions

System::SharedPtr< DocumentOpenStream (System::SharedPtr< System::IO::Stream > input)
 Initialize and return new Document instance from the input stream. More...
 
System::SharedPtr< DocumentOpenStream (System::SharedPtr< System::IO::Stream > input, System::String password)
 Initialize and return new Document instance from the input stream. More...
 
System::SharedPtr< DocumentOpenStream (System::SharedPtr< System::IO::Stream > input, bool isManagedStream)
 Initialize and return new Document instance from the input stream. More...
 
System::SharedPtr< DocumentOpenStream (System::SharedPtr< System::IO::Stream > input, System::String password, bool isManagedStream)
 Initialize and return new Document instance from the input stream. More...
 
System::SharedPtr< DocumentOpenStream (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...
 
System::SharedPtr< DocumentOpenFile (System::String filename)
 Just create and return Document using filename . The same as Document(Stream). More...
 
System::SharedPtr< DocumentOpenFile (System::String filename, System::String password)
 Initialize and return new instance of the Document class for working with encrypted document. More...
 
System::SharedPtr< DocumentOpenFile (System::String filename, System::String password, bool isManagedStream)
 Initialize new instance of the Document class for working with encrypted document. More...
 
System::SharedPtr< DocumentOpenFile (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...
 
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)
 

Additional Inherited Members

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

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]

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

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

Parameters
filenameThe name of the pdf document file.
Returns
Document object

◆ OpenFile() [2/4]

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
filenameDocument file name.
passwordUser or owner password.
Returns
Document object

◆ OpenFile() [3/4]

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
filenameDocument file name.
passwordUser or owner password.
isManagedStreamif set to true inner stream is closed before exit; otherwise, is not.
Returns
Document object

◆ OpenFile() [4/4]

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
filenameInput file to convert into pdf document.
optionsRepresents properties for converting filename into pdf document.
Returns
Document object

◆ OpenStream() [1/5]

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

Initialize and return new Document instance from the input stream.

Parameters
inputStream with pdf document.
Returns
Document object

◆ OpenStream() [2/5]

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
inputInput stream object, corresponding pdf is password protected.
passwordUser or owner password.
Returns
Document object

◆ OpenStream() [3/5]

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
inputStream with pdf document.
isManagedStreamif set to true inner stream is closed before exit; otherwise, is not.
Returns
Document object

◆ OpenStream() [4/5]

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
inputStream with pdf document.
passwordUser or owner password.
isManagedStreamif set to true inner stream is closed before exit; otherwise, is not.
Returns
Document object

◆ OpenStream() [5/5]

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
inputInput stream to convert into pdf document.
optionsRepresents properties for converting input into pdf document.
Returns
Document object