Aspose::Pdf::Annotations::RenditionAction Class Referencefinal

A rendition action that controls the playing of multimedia content. More...

Inherits Aspose::Pdf::Annotations::PdfAction.

Public Member Functions

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Annotations::Renditionget_Rendition ()
 Gets rendition associated with the action. More...
 
ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::RenditionOperation get_RenditionOperation ()
 The operation to perform when the action is triggered. More...
 
ASPOSE_PDF_SHARED_API void set_RenditionOperation (Aspose::Pdf::Annotations::RenditionOperation value)
 The operation to perform when the action is triggered. More...
 
ASPOSE_PDF_SHARED_API System::String get_JavaScript ()
 Gets JavaScript code associated with the action. More...
 
ASPOSE_PDF_SHARED_API void set_JavaScript (System::String value)
 Sets JavaScript code associated with the action. More...
 
- Public Member Functions inherited from Aspose::Pdf::Annotations::PdfAction
ASPOSE_PDF_SHARED_API System::SharedPtr< ActionCollectionget_Next ()
 Next actions in sequence. More...
 
ASPOSE_PDF_SHARED_API System::String ToString () const override
 Returns string representation of ExplicitDestination object. 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 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...
 

Protected Member Functions

 RenditionAction (System::String mediaFile, System::SharedPtr< ScreenAnnotation > screen)
 Creates the rendition action. More...
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (RenditionAction, CODEPORTING_ARGS(System::String mediaFile, System::SharedPtr< ScreenAnnotation > screen))
 
 RenditionAction (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > action)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (RenditionAction, CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > action))
 
- Protected Member Functions inherited from Aspose::Pdf::Annotations::PdfAction
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > get_EngineDict ()
 
void set_EngineDict (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > value)
 
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > get_EngineObj () const
 
void set_EngineObj (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > value)
 
virtual ASPOSE_PDF_SHARED_API void Execute (const System::SharedPtr< Document > &document)
 
virtual ASPOSE_PDF_SHARED_API ~PdfAction ()
 

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...
 
- Static Protected Member Functions inherited from Aspose::Pdf::Annotations::PdfAction
static System::SharedPtr< PdfActionCreateAction (const System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > &action)
 

Detailed Description

A rendition action that controls the playing of multimedia content.

Constructor & Destructor Documentation

◆ RenditionAction() [1/2]

Aspose::Pdf::Annotations::RenditionAction::RenditionAction ( System::String  mediaFile,
System::SharedPtr< ScreenAnnotation screen 
)
protected

Creates the rendition action.

Parameters
mediaFileThe path to multimedia file.
screenThe ScreenAnnotation object the RenditionAction will be bound with.

◆ RenditionAction() [2/2]

Aspose::Pdf::Annotations::RenditionAction::RenditionAction ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary >  action)
protected

Member Function Documentation

◆ get_JavaScript()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Annotations::RenditionAction::get_JavaScript ( )

Gets JavaScript code associated with the action.

◆ get_Rendition()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Annotations::Rendition> Aspose::Pdf::Annotations::RenditionAction::get_Rendition ( )

Gets rendition associated with the action.

◆ get_RenditionOperation()

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::RenditionOperation Aspose::Pdf::Annotations::RenditionAction::get_RenditionOperation ( )

The operation to perform when the action is triggered.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [1/2]

Aspose::Pdf::Annotations::RenditionAction::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( RenditionAction  ,
CODEPORTING_ARGS(System::String mediaFile, System::SharedPtr< ScreenAnnotation > screen)   
)
protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [2/2]

Aspose::Pdf::Annotations::RenditionAction::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( RenditionAction  ,
CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > action)   
)
protected

◆ set_JavaScript()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::RenditionAction::set_JavaScript ( System::String  value)

Sets JavaScript code associated with the action.

◆ set_RenditionOperation()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::RenditionAction::set_RenditionOperation ( Aspose::Pdf::Annotations::RenditionOperation  value)

The operation to perform when the action is triggered.