Aspose::Pdf::Facades::PdfFileSanitization Class Referencefinal

Represents sanitization and recovery API. Use it if you can't create/open documents in any other way. More...

#include "PdfFileSanitization.h"

Inherits Aspose::Pdf::Facades::SaveableFacade, and Aspose::Pdf::Sanitization::IRecovery.

Public Member Functions

ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::String > > get_Log () override
 After file has Saved you can check what was done with file. More...
 
ASPOSE_PDF_SHARED_API bool get_UseTrimTop () const
 Allows to remove data before pdf data. More...
 
ASPOSE_PDF_SHARED_API void set_UseTrimTop (bool value)
 Allows to remove data before pdf data. More...
 
ASPOSE_PDF_SHARED_API bool get_UseTrimBottom () const
 Allows to remove data after pdf data More...
 
ASPOSE_PDF_SHARED_API void set_UseTrimBottom (bool value)
 Allows to remove data after pdf data More...
 
ASPOSE_PDF_SHARED_API bool get_UseRebuildXrefAndTrailer () const
 Allows to generate new xref and trailer for document. More...
 
ASPOSE_PDF_SHARED_API void set_UseRebuildXrefAndTrailer (bool value)
 Allows to generate new xref and trailer for document. More...
 
ASPOSE_PDF_SHARED_API PdfFileSanitization ()
 Initializes a new instance. More...
 
ASPOSE_PDF_SHARED_API void Save (System::String outputFile) override
 Saves the result PDF to file. More...
 
ASPOSE_PDF_SHARED_API void Save (System::SharedPtr< System::IO::Stream > outputStream) override
 Saves the result PDF to stream. More...
 
ASPOSE_PDF_SHARED_API void BindPdf (System::String inputFile) override
 Binds a Pdf file for Sanitize. More...
 
ASPOSE_PDF_SHARED_API void BindPdf (System::SharedPtr< System::IO::Stream > inputStream) override
 Binds a Pdf stream for Sanitize. More...
 
ASPOSE_PDF_SHARED_API void BindPdf (System::SharedPtr< Aspose::Pdf::Document > srcDoc) override
 Initializes the facade. More...
 
ASPOSE_PDF_SHARED_API void Recover () override
 Recovers document. Use properties to customize. More...
 
ASPOSE_PDF_SHARED_API void TrimTop () override
 Removes data before PDF. More...
 
ASPOSE_PDF_SHARED_API void TrimBottom () override
 Removes data after last %EOF. More...
 
ASPOSE_PDF_SHARED_API void RebuildXrefAndTrailer ()
 Removes old xref with trailer and creates a new xref with trailer. More...
 
ASPOSE_PDF_SHARED_API void Close () override
 Closes the facade. More...
 
- Public Member Functions inherited from Aspose::Pdf::Facades::Facade
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Documentget_Document () const
 Gets the document facade is working on. More...
 
ASPOSE_PDF_SHARED_API void BindPdf (System::SharedPtr< Aspose::Pdf::Document > srcDoc) override
 Initializes the facade. More...
 
ASPOSE_PDF_SHARED_API void Dispose () override
 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 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 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 (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< Objectptr
 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 TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
- Protected Member Functions inherited from Aspose::Pdf::Facades::SaveableFacade
ASPOSE_PDF_SHARED_API SaveableFacade ()
 The constructor. More...
 
ASPOSE_PDF_SHARED_API SaveableFacade (System::SharedPtr< Aspose::Pdf::Document > srcDoc)
 The constructor. More...
 
- Protected Member Functions inherited from Aspose::Pdf::Facades::Facade
bool get__IsObjectLicensed ()
 Gets licensed state of the system. Returns true is system works in licensed mode and false otherwise. More...
 
ASPOSE_PDF_SHARED_API Facade ()
 The constructor. More...
 
ASPOSE_PDF_SHARED_API Facade (System::SharedPtr< Aspose::Pdf::Document > srcDoc)
 The constructor. More...
 
virtual ASPOSE_PDF_SHARED_API void BindPdf (System::String srcFile, System::String password)
 Initializes the facade. More...
 
virtual ASPOSE_PDF_SHARED_API void BindPdf (System::SharedPtr< System::IO::Stream > srcStream, System::String password)
 Initializes the facade. More...
 
virtual ASPOSE_PDF_SHARED_API void AssertDocument () const
 Asserts if the facade is initialized. More...
 
virtual ASPOSE_PDF_SHARED_API ~Facade ()
 

Detailed Description

Represents sanitization and recovery API. Use it if you can't create/open documents in any other way.

Constructor & Destructor Documentation

◆ PdfFileSanitization()

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileSanitization::PdfFileSanitization ( )

Initializes a new instance.

Member Function Documentation

◆ BindPdf() [1/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSanitization::BindPdf ( System::String  inputFile)
overridevirtual

Binds a Pdf file for Sanitize.

Parameters
inputFileThe pdf file to be edited.

Reimplemented from Aspose::Pdf::Facades::Facade.

◆ BindPdf() [2/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSanitization::BindPdf ( System::SharedPtr< System::IO::Stream inputStream)
overridevirtual

Binds a Pdf stream for Sanitize.

Parameters
inputStreamThe pdf stream to be edited.

Reimplemented from Aspose::Pdf::Facades::Facade.

◆ BindPdf() [3/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSanitization::BindPdf ( System::SharedPtr< Aspose::Pdf::Document srcDoc)
override

Initializes the facade.

Parameters
srcDocThe Aspose.Pdf.Document object.

◆ Close()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSanitization::Close ( )
overridevirtual

Closes the facade.

Reimplemented from Aspose::Pdf::Facades::Facade.

◆ get_Log()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::String> > Aspose::Pdf::Facades::PdfFileSanitization::get_Log ( )
overridevirtual

After file has Saved you can check what was done with file.

Implements Aspose::Pdf::Sanitization::IRecovery.

◆ get_UseRebuildXrefAndTrailer()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSanitization::get_UseRebuildXrefAndTrailer ( ) const

Allows to generate new xref and trailer for document.

◆ get_UseTrimBottom()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSanitization::get_UseTrimBottom ( ) const

Allows to remove data after pdf data

◆ get_UseTrimTop()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSanitization::get_UseTrimTop ( ) const

Allows to remove data before pdf data.

◆ RebuildXrefAndTrailer()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSanitization::RebuildXrefAndTrailer ( )

Removes old xref with trailer and creates a new xref with trailer.

◆ Recover()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSanitization::Recover ( )
overridevirtual

Recovers document. Use properties to customize.

Implements Aspose::Pdf::Sanitization::IRecovery.

◆ Save() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSanitization::Save ( System::String  outputFile)
overridevirtual

Saves the result PDF to file.

Parameters
outputFileoutput pdf file

Reimplemented from Aspose::Pdf::Facades::SaveableFacade.

◆ Save() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSanitization::Save ( System::SharedPtr< System::IO::Stream outputStream)
overridevirtual

Saves the result PDF to stream.

Parameters
outputStreamoutput pdf stream

Reimplemented from Aspose::Pdf::Facades::SaveableFacade.

◆ set_UseRebuildXrefAndTrailer()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSanitization::set_UseRebuildXrefAndTrailer ( bool  value)

Allows to generate new xref and trailer for document.

◆ set_UseTrimBottom()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSanitization::set_UseTrimBottom ( bool  value)

Allows to remove data after pdf data

◆ set_UseTrimTop()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSanitization::set_UseTrimTop ( bool  value)

Allows to remove data before pdf data.

◆ TrimBottom()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSanitization::TrimBottom ( )
overridevirtual

Removes data after last %EOF.

Implements Aspose::Pdf::Sanitization::IRecovery.

◆ TrimTop()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSanitization::TrimTop ( )
overridevirtual

Removes data before PDF.

Implements Aspose::Pdf::Sanitization::IRecovery.