Aspose::Pdf::Facades::PdfAnnotationEditor Class Referencefinal

Represents a class for work with PDF document annotations (comments). More...

#include "PdfAnnotationEditor.h"

Inherits Aspose::Pdf::Facades::SaveableFacade.

Public Member Functions

ASPOSE_PDF_SHARED_API void ImportAnnotationsFromXfdf (System::String xfdfFile)
 Imports all annotations from XFDF file. More...
 
ASPOSE_PDF_SHARED_API void ImportAnnotationFromXfdf (System::String xfdfFile)
 Imports all annotations from XFDF file. More...
 
ASPOSE_PDF_SHARED_API void ImportAnnotationFromXfdf (System::String xfdfFile, System::ArrayPtr< Aspose::Pdf::Annotations::AnnotationType > annotType)
 Imports the specified annotations from XFDF file. More...
 
ASPOSE_PDF_SHARED_API void ImportAnnotationFromXfdf (System::SharedPtr< System::IO::Stream > xfdfStream, System::ArrayPtr< Aspose::Pdf::Annotations::AnnotationType > annotType)
 Imports the specified annotations from XFDF data stream. More...
 
ASPOSE_PDF_SHARED_API void ImportAnnotationsFromXfdf (System::SharedPtr< System::IO::Stream > xfdfStream)
 Imports all annotations from XFDF data stream. More...
 
ASPOSE_PDF_SHARED_API void ImportAnnotationFromXfdf (System::SharedPtr< System::IO::Stream > xfdfStream)
 Imports all annotations from XFDF data stream. More...
 
ASPOSE_PDF_SHARED_API void ImportAnnotations (System::ArrayPtr< System::String > annotFile, System::ArrayPtr< Aspose::Pdf::Annotations::AnnotationType > annotType)
 Imports the specified annotations into document from array of another PDF documents. More...
 
ASPOSE_PDF_SHARED_API void ImportAnnotations (System::ArrayPtr< System::String > annotFile)
 Imports annotations into document from array of another PDF documents. More...
 
ASPOSE_PDF_SHARED_API void ImportAnnotations (System::ArrayPtr< System::SharedPtr< System::IO::Stream >> annotFileStream, System::ArrayPtr< Aspose::Pdf::Annotations::AnnotationType > annotType)
 Imports the specified annotations into document from array of another PDF document streams. More...
 
ASPOSE_PDF_SHARED_API void ImportAnnotations (System::ArrayPtr< System::SharedPtr< System::IO::Stream >> annotFileStream)
 Imports annotations into document from array of another PDF document streams. More...
 
ASPOSE_PDF_SHARED_API void ModifyAnnotationsAuthor (int32_t start, int32_t end, System::String srcAuthor, System::String desAuthor)
 Modifies the author of annotations on the specified page range. More...
 
ASPOSE_PDF_SHARED_API void FlatteningAnnotations ()
 Flattens all annotations in the document. More...
 
ASPOSE_PDF_SHARED_API void FlatteningAnnotations (System::SharedPtr< Forms::Form::FlattenSettings > flattenSettings)
 Flattens all annotations in the document. More...
 
ASPOSE_PDF_SHARED_API void FlatteningAnnotations (int32_t start, int32_t end, System::ArrayPtr< Aspose::Pdf::Annotations::AnnotationType > annotType)
 Flattens the annotations of the specified types. More...
 
ASPOSE_PDF_SHARED_API void DeleteAnnotations ()
 Deletes all annotations in the document. More...
 
ASPOSE_PDF_SHARED_API void DeleteAnnotations (System::String annotType)
 Deletes all annotations of the specified type in the document. More...
 
ASPOSE_PDF_SHARED_API void DeleteAnnotation (System::String annotName)
 Deletes the annotation with specified annotation name. More...
 
ASPOSE_PDF_SHARED_API void ExportAnnotationsXfdf (System::SharedPtr< System::IO::Stream > xmlOutputStream, int32_t start, int32_t end, System::ArrayPtr< System::String > annotTypes)
 Exports the content of the specified annotation types into XFDF More...
 
ASPOSE_PDF_SHARED_API void ExportAnnotationsXfdf (System::SharedPtr< System::IO::Stream > xmlOutputStream, int32_t start, int32_t end, System::ArrayPtr< Aspose::Pdf::Annotations::AnnotationType > annotTypes)
 Exports the content of the specified annotations types into XFDF More...
 
ASPOSE_PDF_SHARED_API void ExportAnnotationsToXfdf (System::SharedPtr< System::IO::Stream > xmlOutputStream)
 Exports annotations to stream. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< Aspose::Pdf::Annotations::Annotation > > > ExtractAnnotations (int32_t start, int32_t end, System::ArrayPtr< System::String > annotTypes)
 Gets the list of annotations of the specified types. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< Aspose::Pdf::Annotations::Annotation > > > ExtractAnnotations (int32_t start, int32_t end, System::ArrayPtr< Aspose::Pdf::Annotations::AnnotationType > annotTypes)
 Gets the list of annotations of the specified types. More...
 
ASPOSE_PDF_SHARED_API PdfAnnotationEditor ()
 Initializes new PdfAnnotationEditor object. More...
 
ASPOSE_PDF_SHARED_API PdfAnnotationEditor (System::SharedPtr< Aspose::Pdf::Document > document)
 Initializes new PdfAnnotationEditor object on base of the document . More...
 
ASPOSE_PDF_SHARED_API void ModifyAnnotations (int32_t start, int32_t end, System::SharedPtr< Aspose::Pdf::Annotations::Annotation > annotation)
 Modifies the annotations of the specifed type on the specified page range. It supports to modify next annotation properties: Modified, Title, Contents, Color, Subject and Open. More...
 
ASPOSE_PDF_SHARED_API void RedactArea (int32_t pageIndex, System::SharedPtr< Rectangle > rect, System::Drawing::Color color)
 Redacts area on the specified page. All contents is removed. More...
 
- Public Member Functions inherited from Aspose::Pdf::Facades::SaveableFacade
ASPOSE_PDF_SHARED_API void Save (System::String destFile) override
 Saves the PDF document to the specified file. More...
 
ASPOSE_PDF_SHARED_API void Save (System::SharedPtr< System::IO::Stream > destStream) override
 Saves the PDF document to the specified stream. 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::String srcFile) override
 Initializes the facade. More...
 
ASPOSE_PDF_SHARED_API void BindPdf (System::SharedPtr< System::IO::Stream > srcStream) override
 Initializes the facade. More...
 
ASPOSE_PDF_SHARED_API void BindPdf (System::SharedPtr< Aspose::Pdf::Document > srcDoc) override
 Initializes the facade. More...
 
ASPOSE_PDF_SHARED_API void Close () override
 Disposes Aspose.Pdf.Document bound with a 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 a class for work with PDF document annotations (comments).

Constructor & Destructor Documentation

◆ PdfAnnotationEditor() [1/2]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfAnnotationEditor::PdfAnnotationEditor ( )

Initializes new PdfAnnotationEditor object.

◆ PdfAnnotationEditor() [2/2]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfAnnotationEditor::PdfAnnotationEditor ( System::SharedPtr< Aspose::Pdf::Document document)

Initializes new PdfAnnotationEditor object on base of the document .

Parameters
documentPdf document.

Member Function Documentation

◆ DeleteAnnotation()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::DeleteAnnotation ( System::String  annotName)

Deletes the annotation with specified annotation name.

Parameters
annotNameThe annotation name

◆ DeleteAnnotations() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::DeleteAnnotations ( )

Deletes all annotations in the document.

◆ DeleteAnnotations() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::DeleteAnnotations ( System::String  annotType)

Deletes all annotations of the specified type in the document.

Parameters
annotTypeThe type of annotation will be deleted.

◆ ExportAnnotationsToXfdf()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::ExportAnnotationsToXfdf ( System::SharedPtr< System::IO::Stream xmlOutputStream)

Exports annotations to stream.

Parameters
xmlOutputStreamOutput stream.

◆ ExportAnnotationsXfdf() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::ExportAnnotationsXfdf ( System::SharedPtr< System::IO::Stream xmlOutputStream,
int32_t  start,
int32_t  end,
System::ArrayPtr< System::String annotTypes 
)

Exports the content of the specified annotation types into XFDF

Parameters
xmlOutputStreamThe output XFDF stream.
startStart page from which the annotations of the document will be exported.
endEnd page to which the annotations of the document will be exported.
annotTypesThe array of annotation types need be exported.

◆ ExportAnnotationsXfdf() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::ExportAnnotationsXfdf ( System::SharedPtr< System::IO::Stream xmlOutputStream,
int32_t  start,
int32_t  end,
System::ArrayPtr< Aspose::Pdf::Annotations::AnnotationType annotTypes 
)

Exports the content of the specified annotations types into XFDF

Parameters
xmlOutputStreamThe output XFDF stream.
startStart page from which the annotations of the document will be exported.
endEnd page to which the annotations of the document will be exported.
annotTypesThe array of annotation types need be exported.

◆ ExtractAnnotations() [1/2]

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<Aspose::Pdf::Annotations::Annotation> > > Aspose::Pdf::Facades::PdfAnnotationEditor::ExtractAnnotations ( int32_t  start,
int32_t  end,
System::ArrayPtr< System::String annotTypes 
)

Gets the list of annotations of the specified types.

Parameters
startStart page from which the annotations will be selected.
endEnd page to which the annotations will be selected.
annotTypesThe array of needed annotation types.
Returns
Annotations list.

◆ ExtractAnnotations() [2/2]

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<Aspose::Pdf::Annotations::Annotation> > > Aspose::Pdf::Facades::PdfAnnotationEditor::ExtractAnnotations ( int32_t  start,
int32_t  end,
System::ArrayPtr< Aspose::Pdf::Annotations::AnnotationType annotTypes 
)

Gets the list of annotations of the specified types.

Parameters
startStart page from which the annotations will be selected.
endEnd page to which the annotations will be selected.
annotTypesThe array of needed annotation types.
Returns
Annotations list.

◆ FlatteningAnnotations() [1/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::FlatteningAnnotations ( )

Flattens all annotations in the document.

◆ FlatteningAnnotations() [2/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::FlatteningAnnotations ( System::SharedPtr< Forms::Form::FlattenSettings flattenSettings)

Flattens all annotations in the document.

Parameters
flattenSettingsSpecifies modes of flattening.

◆ FlatteningAnnotations() [3/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::FlatteningAnnotations ( int32_t  start,
int32_t  end,
System::ArrayPtr< Aspose::Pdf::Annotations::AnnotationType annotType 
)

Flattens the annotations of the specified types.

Parameters
startThe start page.
endThen end page.
annotTypeThe annotation types should be flattened.

◆ ImportAnnotationFromXfdf() [1/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::ImportAnnotationFromXfdf ( System::String  xfdfFile)

Imports all annotations from XFDF file.

Deprecated:
Method is obsolete, please use ImportAnnotationsFromXfdf instead
Parameters
xfdfFileThe input XFDF file.

◆ ImportAnnotationFromXfdf() [2/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::ImportAnnotationFromXfdf ( System::String  xfdfFile,
System::ArrayPtr< Aspose::Pdf::Annotations::AnnotationType annotType 
)

Imports the specified annotations from XFDF file.

Parameters
xfdfFileThe input XFDF file.
annotTypeThe annotations array to be imported.

◆ ImportAnnotationFromXfdf() [3/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::ImportAnnotationFromXfdf ( System::SharedPtr< System::IO::Stream xfdfStream,
System::ArrayPtr< Aspose::Pdf::Annotations::AnnotationType annotType 
)

Imports the specified annotations from XFDF data stream.

Parameters
xfdfStreamThe input XFDF data stream.
annotTypeThe array of annotation types to be imported.

◆ ImportAnnotationFromXfdf() [4/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::ImportAnnotationFromXfdf ( System::SharedPtr< System::IO::Stream xfdfStream)

Imports all annotations from XFDF data stream.

Deprecated:
Method is obsolete, please use ImportAnnotationsFromXfdf instead
Parameters
xfdfStreamThe input XFDF data stream.

◆ ImportAnnotations() [1/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::ImportAnnotations ( System::ArrayPtr< System::String annotFile,
System::ArrayPtr< Aspose::Pdf::Annotations::AnnotationType annotType 
)

Imports the specified annotations into document from array of another PDF documents.

Parameters
annotFileThe array of paths of PDF documents that contain source annotations.
annotTypeThe array of annotation types to be imported.

◆ ImportAnnotations() [2/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::ImportAnnotations ( System::ArrayPtr< System::String annotFile)

Imports annotations into document from array of another PDF documents.

Parameters
annotFileThe array of paths of PDF documents that contain source annotations.

◆ ImportAnnotations() [3/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::ImportAnnotations ( System::ArrayPtr< System::SharedPtr< System::IO::Stream >>  annotFileStream,
System::ArrayPtr< Aspose::Pdf::Annotations::AnnotationType annotType 
)

Imports the specified annotations into document from array of another PDF document streams.

Parameters
annotFileStreamThe array of streams of PDF documents that contain source annotations.
annotTypeThe annotation types to be imported.

◆ ImportAnnotations() [4/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::ImportAnnotations ( System::ArrayPtr< System::SharedPtr< System::IO::Stream >>  annotFileStream)

Imports annotations into document from array of another PDF document streams.

Parameters
annotFileStreamThe array of streams of PDF documents that contain source annotations.

◆ ImportAnnotationsFromXfdf() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::ImportAnnotationsFromXfdf ( System::String  xfdfFile)

Imports all annotations from XFDF file.

Parameters
xfdfFileThe input XFDF file.

◆ ImportAnnotationsFromXfdf() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::ImportAnnotationsFromXfdf ( System::SharedPtr< System::IO::Stream xfdfStream)

Imports all annotations from XFDF data stream.

Parameters
xfdfStreamThe input XFDF data stream.

◆ ModifyAnnotations()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::ModifyAnnotations ( int32_t  start,
int32_t  end,
System::SharedPtr< Aspose::Pdf::Annotations::Annotation annotation 
)

Modifies the annotations of the specifed type on the specified page range. It supports to modify next annotation properties: Modified, Title, Contents, Color, Subject and Open.

Parameters
startThe start page number.
endThe end page number.
annotationThe annotation object contains new properties.

◆ ModifyAnnotationsAuthor()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::ModifyAnnotationsAuthor ( int32_t  start,
int32_t  end,
System::String  srcAuthor,
System::String  desAuthor 
)

Modifies the author of annotations on the specified page range.

Parameters
startThe start page number.
endThe end page number.
srcAuthorThe author that must be modified.
desAuthorThe new author.

◆ RedactArea()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfAnnotationEditor::RedactArea ( int32_t  pageIndex,
System::SharedPtr< Rectangle rect,
System::Drawing::Color  color 
)

Redacts area on the specified page. All contents is removed.

Parameters
pageIndexIndex of the page.
rectArea rectangle.
colorFilling color.