Aspose::Pdf::Facades::Facade Class Reference

Base facade class. More...

Inherits Aspose::Pdf::Facades::IFacade.

Inherited by Aspose::Pdf::Facades::PdfConverter, Aspose::Pdf::Facades::PdfExtractor, and Aspose::Pdf::Facades::SaveableFacade.

Public Member Functions

System::SharedPtr< Aspose::Pdf::Documentget_Document () const
 Gets the document facade is working on. More...
 
virtual void BindPdf (System::String srcFile)
 Initializes the facade. More...
 
virtual void BindPdf (System::SharedPtr< System::IO::Stream > srcStream)
 Initializes the facade. More...
 
virtual void BindPdf (System::SharedPtr< Aspose::Pdf::Document > srcDoc)
 Initializes the facade. More...
 
virtual void Close ()
 Disposes Aspose.Pdf.Document bound with a facade. More...
 
void Dispose ()
 Disposes the facade. More...
 
- Public Member Functions inherited from Aspose::Pdf::Facades::IFacade
virtual void BindPdf (System::SharedPtr< Document > srcDoc)=0
 Binds PDF document for editing. 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)
 

Protected Member Functions

 Facade ()
 The constructor. More...
 
 Facade (System::SharedPtr< Aspose::Pdf::Document > srcDoc)
 The constructor. More...
 
virtual void BindPdf (System::String srcFile, System::String password)
 Initializes the facade. More...
 
virtual void BindPdf (System::SharedPtr< System::IO::Stream > srcStream, System::String password)
 Initializes the facade. More...
 
virtual void AssertDocument () const
 Asserts if the facade is initialized. More...
 

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

Base facade class.

Constructor & Destructor Documentation

◆ Facade() [1/2]

Aspose::Pdf::Facades::Facade::Facade ( )
protected

The constructor.

◆ Facade() [2/2]

Aspose::Pdf::Facades::Facade::Facade ( System::SharedPtr< Aspose::Pdf::Document srcDoc)
protected

The constructor.

Parameters
srcDocThe Aspose.Pdf.Document object.

Member Function Documentation

◆ AssertDocument()

virtual void Aspose::Pdf::Facades::Facade::AssertDocument ( ) const
protectedvirtual

Asserts if the facade is initialized.

Reimplemented in Aspose::Pdf::Facades::PdfFileInfo.

◆ BindPdf() [1/5]

virtual void Aspose::Pdf::Facades::Facade::BindPdf ( System::String  srcFile)
virtual

◆ BindPdf() [2/5]

virtual void Aspose::Pdf::Facades::Facade::BindPdf ( System::SharedPtr< System::IO::Stream srcStream)
virtual

◆ BindPdf() [3/5]

virtual void Aspose::Pdf::Facades::Facade::BindPdf ( System::SharedPtr< Aspose::Pdf::Document srcDoc)
virtual

Initializes the facade.

Parameters
srcDocThe Aspose.Pdf.Document object.

Reimplemented in Aspose::Pdf::Facades::PdfFileInfo.

◆ BindPdf() [4/5]

virtual void Aspose::Pdf::Facades::Facade::BindPdf ( System::String  srcFile,
System::String  password 
)
protectedvirtual

Initializes the facade.

Parameters
srcFileThe PDF file.
passwordThe password of the PDF document.

Reimplemented in Aspose::Pdf::Facades::Form, and Aspose::Pdf::Facades::PdfFileInfo.

◆ BindPdf() [5/5]

virtual void Aspose::Pdf::Facades::Facade::BindPdf ( System::SharedPtr< System::IO::Stream srcStream,
System::String  password 
)
protectedvirtual

Initializes the facade.

Parameters
srcStreamThe stream of PDF file.
passwordThe password of the PDF document.

Reimplemented in Aspose::Pdf::Facades::Form, and Aspose::Pdf::Facades::PdfFileInfo.

◆ Close()

◆ Dispose()

void Aspose::Pdf::Facades::Facade::Dispose ( )
virtual

Disposes the facade.

Reimplemented from System::IDisposable.

Reimplemented in Aspose::Pdf::Facades::PdfFileSecurity.

◆ get_Document()

System::SharedPtr<Aspose::Pdf::Document> Aspose::Pdf::Facades::Facade::get_Document ( ) const

Gets the document facade is working on.