Aspose::Pdf::Annotations::AnnotationActionCollection Class Referencefinal
Represents the collection of annotation actions. More...
Inherits Aspose::Pdf::BaseActionCollection.
Public Member Functions | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< PdfAction > | get_OnEnter () |
| Gets an action to be performed when the cursor enters the annotation�s active area. More... | |
| ASPOSE_PDF_SHARED_API void | set_OnEnter (System::SharedPtr< PdfAction > value) |
| Sets an action to be performed when the cursor enters the annotation�s active area. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< PdfAction > | get_OnExit () |
| Gets an action to be performed when the cursor exits the annotation�s active area. More... | |
| ASPOSE_PDF_SHARED_API void | set_OnExit (System::SharedPtr< PdfAction > value) |
| Sets an action to be performed when the cursor exits the annotation�s active area. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< PdfAction > | get_OnPressMouseBtn () |
| Gets an action to be performed when the mouse button is pressed inside the annotation�s active area. More... | |
| ASPOSE_PDF_SHARED_API void | set_OnPressMouseBtn (System::SharedPtr< PdfAction > value) |
| Sets an action to be performed when the mouse button is pressed inside the annotation�s active area. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< PdfAction > | get_OnReleaseMouseBtn () |
| Gets an action to be performed when the mouse button is released inside the annotation�s active area. More... | |
| ASPOSE_PDF_SHARED_API void | set_OnReleaseMouseBtn (System::SharedPtr< PdfAction > value) |
| Sets an action to be performed when the mouse button is released inside the annotation�s active area. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< PdfAction > | get_OnReceiveFocus () |
| Gets an action to be performed when the annotation receives the input focus. More... | |
| ASPOSE_PDF_SHARED_API void | set_OnReceiveFocus (System::SharedPtr< PdfAction > value) |
| Sets an action to be performed when the annotation receives the input focus. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< PdfAction > | get_OnOpenPage () |
| Gets an action to be performed when the page containing the annotation is opened. More... | |
| ASPOSE_PDF_SHARED_API void | set_OnOpenPage (System::SharedPtr< PdfAction > value) |
| Sets an action to be performed when the page containing the annotation is opened. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< PdfAction > | get_OnClosePage () |
| Gets an action to be performed when the page containing the annotation is closed. More... | |
| ASPOSE_PDF_SHARED_API void | set_OnClosePage (System::SharedPtr< PdfAction > value) |
| Sets an action to be performed when the page containing the annotation is closed. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< PdfAction > | get_OnShowPage () |
| Gets an action to be performed when the page containing the annotation becomes visible in the viewer application�s user interface. More... | |
| ASPOSE_PDF_SHARED_API void | set_OnShowPage (System::SharedPtr< PdfAction > value) |
| Sets an action to be performed when the page containing the annotation becomes visible in the viewer application�s user interface. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< PdfAction > | get_OnHidePage () |
| Gets an action to be performed when the page containing the annotation is no longer visible in the viewer application�s user interface. More... | |
| ASPOSE_PDF_SHARED_API void | set_OnHidePage (System::SharedPtr< PdfAction > value) |
| Sets an action to be performed when the page containing the annotation is no longer visible in the viewer application�s user interface. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< PdfAction > | get_OnLostFocus () |
| Gets an action to be performed when the annotation loses the input focus. More... | |
| ASPOSE_PDF_SHARED_API void | set_OnLostFocus (System::SharedPtr< PdfAction > value) |
| Sets an action to be performed when the annotation loses the input focus. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< PdfAction > | get_OnModifyCharacter () |
| Gets an action to be performed when user modifies character of the field. More... | |
| ASPOSE_PDF_SHARED_API void | set_OnModifyCharacter (System::SharedPtr< PdfAction > value) |
| Sets an action to be performed when user modifies character of the field. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< PdfAction > | get_OnValidate () |
| Gets an action to be performed when user changes contents of the field. More... | |
| ASPOSE_PDF_SHARED_API void | set_OnValidate (System::SharedPtr< PdfAction > value) |
| Sets an action to be performed when user changes contents of the field. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< PdfAction > | get_OnFormat () |
| Gets an action to be performed to format field value. More... | |
| ASPOSE_PDF_SHARED_API void | set_OnFormat (System::SharedPtr< PdfAction > value) |
| Sets an action to be performed to format field value. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< PdfAction > | get_OnCalculate () |
| Gets an action to calculate field value. More... | |
| ASPOSE_PDF_SHARED_API void | set_OnCalculate (System::SharedPtr< PdfAction > value) |
| Sets an action to calculate field value. More... | |
 Public Member Functions inherited from Aspose::Pdf::BaseActionCollection | |
| ASPOSE_PDF_SHARED_API void | RemoveActions () |
| Removes all actions of the annotation. 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... | |
Protected Member Functions | |
| AnnotationActionCollection (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > annotation) | |
| MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (AnnotationActionCollection, CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > annotation)) | |
| Protected Member Functions inherited from Aspose::Pdf::BaseActionCollection | |
| System::SharedPtr< Annotations::PdfAction > | GetAction (const System::String &name) |
| Returns action by its name. More... | |
| void | SetAction (const System::String &name, const System::SharedPtr< Annotations::PdfAction > &action) |
| Sets action by its name. More... | |
| BaseActionCollection (const System::SharedPtr< Engine::Data::IPdfObject > &annotation) | |
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... | |
| Protected Attributes inherited from Aspose::Pdf::BaseActionCollection | |
| System::SharedPtr< Engine::Data::IPdfObject > | Owner |
Detailed Description
Represents the collection of annotation actions.
Constructor & Destructor Documentation
◆ AnnotationActionCollection()
|
protected |
Member Function Documentation
◆ get_OnCalculate()
| ASPOSE_PDF_SHARED_API System::SharedPtr<PdfAction> Aspose::Pdf::Annotations::AnnotationActionCollection::get_OnCalculate | ( | ) |
Gets an action to calculate field value.
◆ get_OnClosePage()
| ASPOSE_PDF_SHARED_API System::SharedPtr<PdfAction> Aspose::Pdf::Annotations::AnnotationActionCollection::get_OnClosePage | ( | ) |
Gets an action to be performed when the page containing the annotation is closed.
◆ get_OnEnter()
| ASPOSE_PDF_SHARED_API System::SharedPtr<PdfAction> Aspose::Pdf::Annotations::AnnotationActionCollection::get_OnEnter | ( | ) |
Gets an action to be performed when the cursor enters the annotation�s active area.
◆ get_OnExit()
| ASPOSE_PDF_SHARED_API System::SharedPtr<PdfAction> Aspose::Pdf::Annotations::AnnotationActionCollection::get_OnExit | ( | ) |
Gets an action to be performed when the cursor exits the annotation�s active area.
◆ get_OnFormat()
| ASPOSE_PDF_SHARED_API System::SharedPtr<PdfAction> Aspose::Pdf::Annotations::AnnotationActionCollection::get_OnFormat | ( | ) |
Gets an action to be performed to format field value.
◆ get_OnHidePage()
| ASPOSE_PDF_SHARED_API System::SharedPtr<PdfAction> Aspose::Pdf::Annotations::AnnotationActionCollection::get_OnHidePage | ( | ) |
Gets an action to be performed when the page containing the annotation is no longer visible in the viewer application�s user interface.
◆ get_OnLostFocus()
| ASPOSE_PDF_SHARED_API System::SharedPtr<PdfAction> Aspose::Pdf::Annotations::AnnotationActionCollection::get_OnLostFocus | ( | ) |
Gets an action to be performed when the annotation loses the input focus.
◆ get_OnModifyCharacter()
| ASPOSE_PDF_SHARED_API System::SharedPtr<PdfAction> Aspose::Pdf::Annotations::AnnotationActionCollection::get_OnModifyCharacter | ( | ) |
Gets an action to be performed when user modifies character of the field.
◆ get_OnOpenPage()
| ASPOSE_PDF_SHARED_API System::SharedPtr<PdfAction> Aspose::Pdf::Annotations::AnnotationActionCollection::get_OnOpenPage | ( | ) |
Gets an action to be performed when the page containing the annotation is opened.
◆ get_OnPressMouseBtn()
| ASPOSE_PDF_SHARED_API System::SharedPtr<PdfAction> Aspose::Pdf::Annotations::AnnotationActionCollection::get_OnPressMouseBtn | ( | ) |
Gets an action to be performed when the mouse button is pressed inside the annotation�s active area.
◆ get_OnReceiveFocus()
| ASPOSE_PDF_SHARED_API System::SharedPtr<PdfAction> Aspose::Pdf::Annotations::AnnotationActionCollection::get_OnReceiveFocus | ( | ) |
Gets an action to be performed when the annotation receives the input focus.
◆ get_OnReleaseMouseBtn()
| ASPOSE_PDF_SHARED_API System::SharedPtr<PdfAction> Aspose::Pdf::Annotations::AnnotationActionCollection::get_OnReleaseMouseBtn | ( | ) |
Gets an action to be performed when the mouse button is released inside the annotation�s active area.
◆ get_OnShowPage()
| ASPOSE_PDF_SHARED_API System::SharedPtr<PdfAction> Aspose::Pdf::Annotations::AnnotationActionCollection::get_OnShowPage | ( | ) |
Gets an action to be performed when the page containing the annotation becomes visible in the viewer application�s user interface.
◆ get_OnValidate()
| ASPOSE_PDF_SHARED_API System::SharedPtr<PdfAction> Aspose::Pdf::Annotations::AnnotationActionCollection::get_OnValidate | ( | ) |
Gets an action to be performed when user changes contents of the field.
◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()
|
protected |
◆ set_OnCalculate()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AnnotationActionCollection::set_OnCalculate | ( | System::SharedPtr< PdfAction > | value | ) |
Sets an action to calculate field value.
◆ set_OnClosePage()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AnnotationActionCollection::set_OnClosePage | ( | System::SharedPtr< PdfAction > | value | ) |
Sets an action to be performed when the page containing the annotation is closed.
◆ set_OnEnter()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AnnotationActionCollection::set_OnEnter | ( | System::SharedPtr< PdfAction > | value | ) |
Sets an action to be performed when the cursor enters the annotation�s active area.
◆ set_OnExit()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AnnotationActionCollection::set_OnExit | ( | System::SharedPtr< PdfAction > | value | ) |
Sets an action to be performed when the cursor exits the annotation�s active area.
◆ set_OnFormat()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AnnotationActionCollection::set_OnFormat | ( | System::SharedPtr< PdfAction > | value | ) |
Sets an action to be performed to format field value.
◆ set_OnHidePage()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AnnotationActionCollection::set_OnHidePage | ( | System::SharedPtr< PdfAction > | value | ) |
Sets an action to be performed when the page containing the annotation is no longer visible in the viewer application�s user interface.
◆ set_OnLostFocus()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AnnotationActionCollection::set_OnLostFocus | ( | System::SharedPtr< PdfAction > | value | ) |
Sets an action to be performed when the annotation loses the input focus.
◆ set_OnModifyCharacter()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AnnotationActionCollection::set_OnModifyCharacter | ( | System::SharedPtr< PdfAction > | value | ) |
Sets an action to be performed when user modifies character of the field.
◆ set_OnOpenPage()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AnnotationActionCollection::set_OnOpenPage | ( | System::SharedPtr< PdfAction > | value | ) |
Sets an action to be performed when the page containing the annotation is opened.
◆ set_OnPressMouseBtn()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AnnotationActionCollection::set_OnPressMouseBtn | ( | System::SharedPtr< PdfAction > | value | ) |
Sets an action to be performed when the mouse button is pressed inside the annotation�s active area.
◆ set_OnReceiveFocus()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AnnotationActionCollection::set_OnReceiveFocus | ( | System::SharedPtr< PdfAction > | value | ) |
Sets an action to be performed when the annotation receives the input focus.
◆ set_OnReleaseMouseBtn()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AnnotationActionCollection::set_OnReleaseMouseBtn | ( | System::SharedPtr< PdfAction > | value | ) |
Sets an action to be performed when the mouse button is released inside the annotation�s active area.
◆ set_OnShowPage()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AnnotationActionCollection::set_OnShowPage | ( | System::SharedPtr< PdfAction > | value | ) |
Sets an action to be performed when the page containing the annotation becomes visible in the viewer application�s user interface.
◆ set_OnValidate()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AnnotationActionCollection::set_OnValidate | ( | System::SharedPtr< PdfAction > | value | ) |
Sets an action to be performed when user changes contents of the field.