Aspose::Pdf::Annotations::HideAction Class Reference

Represents a hide action that hides or shows one or more annotations on the screen by setting or clearing their Hidden flags. More...

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

Public Member Functions

ASPOSE_PDF_SHARED_API bool get_IsHidden ()
 Gets status of the annotation(s) to hide/display. More...
 
ASPOSE_PDF_SHARED_API void set_IsHidden (bool value)
 Sets status of the annotation(s) to hide/display. More...
 
ASPOSE_PDF_SHARED_API HideAction (System::SharedPtr< Annotation > annotation)
 Initializes a new instance of the HideAction class for the specified annotation. More...
 
ASPOSE_PDF_SHARED_API HideAction (System::SharedPtr< Annotation > annotation, bool isHidden)
 Initializes a new instance of the HideAction class for the specified annotation and invisibility flag. More...
 
ASPOSE_PDF_SHARED_API HideAction (System::String fieldName)
 Initializes a new instance of the HideAction class for the specified field name. More...
 
ASPOSE_PDF_SHARED_API HideAction (System::String fieldName, bool isHidden)
 Initializes a new instance of the HideAction class for the specified field name and invisibility flag. More...
 
ASPOSE_PDF_SHARED_API HideAction (System::ArrayPtr< System::SharedPtr< Annotation >> annotations)
 Initializes a new instance of the HideAction class for the specified annotations. More...
 
ASPOSE_PDF_SHARED_API HideAction (System::ArrayPtr< System::SharedPtr< Annotation >> annotations, bool isHidden)
 Initializes a new instance of the HideAction class for the specified annotations and for invisibility flag. More...
 
ASPOSE_PDF_SHARED_API HideAction (System::ArrayPtr< System::String > names)
 Initializes a new instance of the HideAction class for the specified field names. More...
 
ASPOSE_PDF_SHARED_API HideAction (System::ArrayPtr< System::String > names, bool isHidden)
 Initializes a new instance of the HideAction class for the specified field names and for invisibility flag. 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

 HideAction (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > action)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (HideAction, 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

Represents a hide action that hides or shows one or more annotations on the screen by setting or clearing their Hidden flags.

Constructor & Destructor Documentation

◆ HideAction() [1/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::HideAction::HideAction ( System::SharedPtr< Annotation annotation)

Initializes a new instance of the HideAction class for the specified annotation.

Parameters
annotationAn annotation to be hidden.

◆ HideAction() [2/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::HideAction::HideAction ( System::SharedPtr< Annotation annotation,
bool  isHidden 
)

Initializes a new instance of the HideAction class for the specified annotation and invisibility flag.

Parameters
annotationAn annotation to be hidden or shown.
isHiddenA flag indicating whether to hide the annotation (true) or show it (false).

◆ HideAction() [3/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::HideAction::HideAction ( System::String  fieldName)

Initializes a new instance of the HideAction class for the specified field name.

Parameters
fieldNameA text string giving the fully qualified field name of an interactive form field.

◆ HideAction() [4/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::HideAction::HideAction ( System::String  fieldName,
bool  isHidden 
)

Initializes a new instance of the HideAction class for the specified field name and invisibility flag.

Parameters
fieldNameA text string giving the fully qualified field name of an interactive form field.
isHiddenA flag indicating whether to hide the field (true) or show it (false).

◆ HideAction() [5/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::HideAction::HideAction ( System::ArrayPtr< System::SharedPtr< Annotation >>  annotations)

Initializes a new instance of the HideAction class for the specified annotations.

Parameters
annotationsAn array of annotations to be hidden.

◆ HideAction() [6/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::HideAction::HideAction ( System::ArrayPtr< System::SharedPtr< Annotation >>  annotations,
bool  isHidden 
)

Initializes a new instance of the HideAction class for the specified annotations and for invisibility flag.

Parameters
annotationsAn array of annotations to be hidden or shown.
isHiddenA flag indicating whether to hide the annotations (true) or show it (false).

◆ HideAction() [7/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::HideAction::HideAction ( System::ArrayPtr< System::String names)

Initializes a new instance of the HideAction class for the specified field names.

Parameters
namesAn array of strings giving the fully qualified field names of an interactive form fields.

◆ HideAction() [8/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::HideAction::HideAction ( System::ArrayPtr< System::String names,
bool  isHidden 
)

Initializes a new instance of the HideAction class for the specified field names and for invisibility flag.

Parameters
namesAn array of strings giving the fully qualified field names of an interactive form fields.
isHiddenA flag indicating whether to hide the fields (true) or show it (false).

◆ HideAction() [9/9]

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

Member Function Documentation

◆ get_IsHidden()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Annotations::HideAction::get_IsHidden ( )

Gets status of the annotation(s) to hide/display.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

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

◆ set_IsHidden()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::HideAction::set_IsHidden ( bool  value)

Sets status of the annotation(s) to hide/display.