Aspose::Pdf::Annotations::AppearanceDictionary Class Referencefinal

Annotation appearance dictionary specifying how the annotation shall be presented visually on the page. More...

Inherits System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XForm > >.

Public Member Functions

ASPOSE_PDF_SHARED_API bool get_IsReadOnly () const override
 Gets a value indicating whether dictionary is read-only. More...
 
ASPOSE_PDF_SHARED_API bool get_IsFixedSize () const
 Gets a value indicating whether dictionary has a fixed size. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::ICollection< System::String > > get_Keys () const override
 Gets keys of the dictionary. If appearance dictionary has subditionaries, then Keys contains (N|R|D).state values, where N - normal appearance, R - rollover appearance, D - down appearance and state - the name of the state (e.g. On, Off for checkboxes). More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::ICollection< System::SharedPtr< XForm > > > get_Values () const override
 Gets the list of the dictionary values. Result collection contains the list of XForm objects. More...
 
ASPOSE_PDF_SHARED_API bool get_IsSynchronized ()
 Gets a value indicating whether access to the dictionary is synchronized (thread safe). More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Objectget_SyncRoot () const
 Gets an object that can be used to synchronize access to the dictionary. More...
 
ASPOSE_PDF_SHARED_API int32_t get_Count () const override
 Gets the number of elements contained in the dictionary. More...
 
ASPOSE_PDF_SHARED_API void Clear () override
 Removes all elements from the dictionary. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::IEnumerator< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< XForm > > > > GetEnumerator () override
 Returns an IDictionaryEnumerator object for the dictionary. More...
 
ASPOSE_PDF_SHARED_API void CopyTo (System::ArrayPtr< System::SharedPtr< XForm >> array, int32_t index)
 Copies the elements of the dictionary to an Array, starting at a particular Array index. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< XFormidx_get (const System::String &key) const override
 Represents convenient form for getting appearance streams. More...
 
ASPOSE_PDF_SHARED_API void idx_set (const System::String &key, System::SharedPtr< XForm > value) override
 Represents convenient form for getting appearance streams. More...
 
ASPOSE_PDF_SHARED_API void Add (const System::String &key, const System::SharedPtr< XForm > &value) override
 Add X form for specifed key. More...
 
ASPOSE_PDF_SHARED_API bool ContainsKey (const System::String &key) const override
 Determines does this dictionary contasins specified key. More...
 
ASPOSE_PDF_SHARED_API bool Remove (const System::String &key) override
 Removes key from the dictionary. More...
 
ASPOSE_PDF_SHARED_API bool TryGetValue (const System::String &key, System::SharedPtr< XForm > &value) const override
 Tries to find key in the dictionary and retreives value if found. More...
 
ASPOSE_PDF_SHARED_API void Add (const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< XForm >> &item) override
 Adds pair with key and value into the dictionary. More...
 
ASPOSE_PDF_SHARED_API bool Contains (const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< XForm >> &item) const override
 Checks does specified key-value pair is contained in the dictionary. More...
 
ASPOSE_PDF_SHARED_API void CopyTo (System::ArrayPtr< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< XForm >>> array, int32_t arrayIndex) override
 Copies the elements of the ICollection to an Array, starting at a particular Array index. More...
 
ASPOSE_PDF_SHARED_API bool Remove (const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< XForm >> &item) override
 Removes key/value pair from the collection. More...
 
- Public Member Functions inherited from System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XForm > >
bool get_IsFixedSize () const
 Checks if collection size is fixed. More...
 
bool get_IsSynchronized () const
 Checks if container is thread-safe. More...
 
virtual void CopyTo (ArrayPtr< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > >> arr, int index) override
 Copies dictionary contents into existing array elements. More...
 
virtual System::SharedPtr< Aspose::Pdf::XFormGetValueOrDefault (const System::String &key) const
 Returns value if found; or Value() otherwise. More...
 
virtual System::SharedPtr< Aspose::Pdf::XFormGetValueOrDefault (const System::String &key, const System::SharedPtr< Aspose::Pdf::XForm > &defaultValue) const
 Returns value if found; or defaultValue otherwise. More...
 
virtual System::SharedPtr< Aspose::Pdf::XFormGetValueOrNull (const System::String &key) const
 Returns value if found; or null otherwise, make sense only for reference types. More...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > >
virtual void Add (const KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > &item)=0
 Adds element into collection. More...
 
virtual bool Contains (const KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > &item) const=0
 Checks if element is present in collection. More...
 
virtual bool Remove (const KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > &item)=0
 Deletes element from collection. More...
 
virtual void CopyTo (System::ArrayPtr< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > > array, int arrayIndex)=0
 Copies all collection elements to existing array elements. More...
 
ICollectionoperator= (ICollection &&)
 Move assignment operator. More...
 
ICollectionoperator= (const ICollection &)
 Move assignment operator. More...
 
 ICollection ()
 Default constructor. More...
 
 ICollection (const ICollection &)
 Copy constructor. More...
 
 ICollection (ICollection &&)
 Move constructor. More...
 
virtual ~ICollection ()
 Destructor. More...
 
SharedPtr< Objectget_SyncRoot () const
 Gets the object the collection is being synchronized through. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > >
KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > LINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > LINQ_First ()
 Returns the first element of a sequence. More...
 
KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > LINQ_First (const Func< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > >, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > LINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > LINQ_FirstOrDefault (std::function< bool(KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > >)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > LINQ_Last ()
 Returns the last element of a sequence. More...
 
KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > LINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > > > LINQ_ToList ()
 Creates a List<T> from a sequence. More...
 
int LINQ_Count ()
 Returns the number of elements in the sequence (calculated via direct counting). More...
 
int LINQ_Count (const Func< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > >, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > >)> predicate)
 Determines whether all elements of a sequence satisfy a condition. More...
 
bool LINQ_Any ()
 Determines whether a sequence contains any elements. More...
 
bool LINQ_Any (std::function< bool(KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > >)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > > > LINQ_Where (std::function< bool(KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > >)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > value)
 Determines if a sequence contains a specified value. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
SharedPtr< IEnumerable< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > > > LINQ_OrderBy (const Func< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > >, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > > > LINQ_OrderByDescending (const Func< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > >, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > >, ResultType > &selector)
 Transforms elements of a sequence. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > >, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)
 
SharedPtr< IEnumerable< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > > > LINQ_Concat (SharedPtr< IEnumerable< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > >> sequence)
 Concatenates two sequences. More...
 
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > > > > > LINQ_GroupBy (System::Func< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > >, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > >, SharedPtr< IEnumerable< ResultType >>> &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. More...
 
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)
 
iterator begin () noexcept
 Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator begin () const noexcept
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
iterator end () noexcept
 Gets iterator pointing right after the last element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator end () const noexcept
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const noexcept
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const noexcept
 Gets iterator pointing right after the last const-qualified element (if any) of the collection. More...
 
virtual virtualized_iteratorvirtualizeBeginIterator ()
 Gets the implementation of begin iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndIterator ()
 Gets the implementation of end iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeBeginConstIterator () const
 Gets the implementation of begin const iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndConstIterator () const
 Gets the implementation of end const iterator for the current container. 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...
 

Protected Member Functions

ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::ICollection< System::String > > get_KeysInternal () const
 Implementation of get_Keys() method. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::ICollection< System::SharedPtr< XForm > > > get_ValuesInternal () const
 Implementation of get_Values() method. More...
 
 AppearanceDictionary (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > dict)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (AppearanceDictionary, CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > dict))
 
System::SharedPtr< XFormGetForm (System::String key) const
 Retreives form by the string key. More...
 
void SetForm (System::String key, System::SharedPtr< XForm > form)
 Sets form for given key. More...
 
void SetForm (System::ArrayPtr< System::String > key, System::SharedPtr< XForm > form)
 
virtual ASPOSE_PDF_SHARED_API ~AppearanceDictionary ()
 
- Protected Member Functions inherited from System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XForm > >
 ~IDictionary () override
 Destructor. More...
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > >
 ~IEnumerable () override
 Destructor. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator ()
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator () const
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 

Protected Attributes

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > dict
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XForm > >
typedef ICollection< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > > BaseType
 Base interface type. More...
 
typedef KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > KeyValuePairType
 Key value pair type. More...
 
- Public Types inherited from System::Collections::Generic::ICollection< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > >
typedef KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > ValueType
 Value type name. More...
 
typedef ICollection< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > >
typedef IEnumerator< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > > IEnumeratorType
 Enumerator type. More...
 
using ValueType = KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > >
 
using iterator = System::Details::VirtualizedIterator< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > >
 Iterator type. More...
 
using const_iterator = System::Details::VirtualizedConstIterator< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > >
 Const iterator type. More...
 
using virtualized_iterator = System::Details::VirtualizedIteratorBase< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > >
 Inner iterator base type. More...
 
using virtualized_iterator_element = KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > >
 Inner iterator element type. More...
 
- 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...
 

Detailed Description

Annotation appearance dictionary specifying how the annotation shall be presented visually on the page.

Constructor & Destructor Documentation

◆ AppearanceDictionary()

Aspose::Pdf::Annotations::AppearanceDictionary::AppearanceDictionary ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary >  dict)
protected

◆ ~AppearanceDictionary()

virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::AppearanceDictionary::~AppearanceDictionary ( )
protectedvirtual

Member Function Documentation

◆ Add() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AppearanceDictionary::Add ( const System::String key,
const System::SharedPtr< XForm > &  value 
)
overridevirtual

Add X form for specifed key.

Parameters
keyElement key.
valueXForm object value.

Implements System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XForm > >.

◆ Add() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AppearanceDictionary::Add ( const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< XForm >> &  item)
override

Adds pair with key and value into the dictionary.

Parameters
itemItem to be added.

◆ Clear()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AppearanceDictionary::Clear ( )
overridevirtual

◆ Contains()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Annotations::AppearanceDictionary::Contains ( const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< XForm >> &  item) const
override

Checks does specified key-value pair is contained in the dictionary.

Parameters
itemKey-value pair.
Returns
true if this pauir was found.

◆ ContainsKey()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Annotations::AppearanceDictionary::ContainsKey ( const System::String key) const
overridevirtual

Determines does this dictionary contasins specified key.

Parameters
keyKey to search in the dictionary.
Returns
true if key is found.

Implements System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XForm > >.

◆ CopyTo() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AppearanceDictionary::CopyTo ( System::ArrayPtr< System::SharedPtr< XForm >>  array,
int32_t  index 
)

Copies the elements of the dictionary to an Array, starting at a particular Array index.

Parameters
arrayArray where items must be copied.
indexIndex where items must be copied.

◆ CopyTo() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AppearanceDictionary::CopyTo ( System::ArrayPtr< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< XForm >>>  array,
int32_t  arrayIndex 
)
override

Copies the elements of the ICollection to an Array, starting at a particular Array index.

Parameters
arrayThe one-dimensional Array that is the destination of the elements copied from ICollection. The Array must have zero-based indexing.
arrayIndexThe zero-based index in array at which copying begins.

◆ get_Count()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::AppearanceDictionary::get_Count ( ) const
overridevirtual

◆ get_IsFixedSize()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Annotations::AppearanceDictionary::get_IsFixedSize ( ) const

Gets a value indicating whether dictionary has a fixed size.

◆ get_IsReadOnly()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Annotations::AppearanceDictionary::get_IsReadOnly ( ) const
overridevirtual

Gets a value indicating whether dictionary is read-only.

Reimplemented from System::Collections::Generic::ICollection< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > >.

◆ get_IsSynchronized()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Annotations::AppearanceDictionary::get_IsSynchronized ( )

Gets a value indicating whether access to the dictionary is synchronized (thread safe).

◆ get_Keys()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::ICollection<System::String> > Aspose::Pdf::Annotations::AppearanceDictionary::get_Keys ( ) const
overridevirtual

Gets keys of the dictionary. If appearance dictionary has subditionaries, then Keys contains (N|R|D).state values, where N - normal appearance, R - rollover appearance, D - down appearance and state - the name of the state (e.g. On, Off for checkboxes).

Reimplemented from System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XForm > >.

◆ get_KeysInternal()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::ICollection<System::String> > Aspose::Pdf::Annotations::AppearanceDictionary::get_KeysInternal ( ) const
protectedvirtual

◆ get_SyncRoot()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Object> Aspose::Pdf::Annotations::AppearanceDictionary::get_SyncRoot ( ) const

Gets an object that can be used to synchronize access to the dictionary.

◆ get_Values()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::ICollection<System::SharedPtr<XForm> > > Aspose::Pdf::Annotations::AppearanceDictionary::get_Values ( ) const
overridevirtual

Gets the list of the dictionary values. Result collection contains the list of XForm objects.

Reimplemented from System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XForm > >.

◆ get_ValuesInternal()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::ICollection<System::SharedPtr<XForm> > > Aspose::Pdf::Annotations::AppearanceDictionary::get_ValuesInternal ( ) const
protectedvirtual

◆ GetEnumerator()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::IEnumerator<System::Collections::Generic::KeyValuePair<System::String, System::SharedPtr<XForm> > > > Aspose::Pdf::Annotations::AppearanceDictionary::GetEnumerator ( )
overridevirtual

Returns an IDictionaryEnumerator object for the dictionary.

Returns
Enumerator of the dictionary.

Implements System::Collections::Generic::IEnumerable< KeyValuePair< System::String, System::SharedPtr< Aspose::Pdf::XForm > > >.

◆ GetForm()

System::SharedPtr<XForm> Aspose::Pdf::Annotations::AppearanceDictionary::GetForm ( System::String  key) const
protected

Retreives form by the string key.

Parameters
keyString key.
Returns
Retreived form.

◆ idx_get()

ASPOSE_PDF_SHARED_API System::SharedPtr<XForm> Aspose::Pdf::Annotations::AppearanceDictionary::idx_get ( const System::String key) const
overridevirtual

Represents convenient form for getting appearance streams.

Parameters
keyRepresents path to appearance stream. If appearance dictionary has subdictionaries, then path must contain 2 parts (Keys), else path has only one part.
Returns
XForm object (appearance stream) which corresponds to the given key.

Implements System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XForm > >.

◆ idx_set()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::AppearanceDictionary::idx_set ( const System::String key,
System::SharedPtr< XForm value 
)
overridevirtual

Represents convenient form for getting appearance streams.

Parameters
keyRepresents path to appearance stream. If appearance dictionary has subdictionaries, then path must contain 2 parts (Keys), else path has only one part.
Returns
XForm object (appearance stream) which corresponds to the given key.

Implements System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XForm > >.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

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

◆ Remove() [1/2]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Annotations::AppearanceDictionary::Remove ( const System::String key)
overridevirtual

Removes key from the dictionary.

Parameters
keyKey to be removed from the dictionary.
Returns
true if key was successfully removed.

Implements System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XForm > >.

◆ Remove() [2/2]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Annotations::AppearanceDictionary::Remove ( const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< XForm >> &  item)
override

Removes key/value pair from the collection.

Parameters
itemKey/value pair to be removed.
Returns
true if pair was found and removed.

◆ SetForm() [1/2]

void Aspose::Pdf::Annotations::AppearanceDictionary::SetForm ( System::String  key,
System::SharedPtr< XForm form 
)
protected

Sets form for given key.

Parameters
keyString key.
formForm to be associated with the key.

◆ SetForm() [2/2]

void Aspose::Pdf::Annotations::AppearanceDictionary::SetForm ( System::ArrayPtr< System::String key,
System::SharedPtr< XForm form 
)
protected

◆ TryGetValue()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Annotations::AppearanceDictionary::TryGetValue ( const System::String key,
System::SharedPtr< XForm > &  value 
) const
overridevirtual

Tries to find key in the dictionary and retreives value if found.

Parameters
keyKey to search in the dictionary.
valueRetreived value.
Returns
true if key was found.

Implements System::Collections::Generic::IDictionary< System::String, System::SharedPtr< Aspose::Pdf::XForm > >.

Member Data Documentation

◆ dict

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> Aspose::Pdf::Annotations::AppearanceDictionary::dict
protected