Inherits System::Collections::Generic::ICollection< KeyValuePair< TKey, TValue > >.

Public Types
typedef ICollection< KeyValuePair< TKey, TValue > >	BaseType
	Base interface type. More...

typedef KeyValuePair< TKey, TValue >	KeyValuePairType
	Key value pair type. More...

Public Types inherited from System::Collections::Generic::ICollection< KeyValuePair< TKey, TValue > >
typedef KeyValuePair< TKey, TValue >	ValueType
	Value type name. More...

typedef ICollection< KeyValuePair< TKey, TValue > >	ThisType
	Collection type name. More...

Public Types inherited from System::Collections::Generic::IEnumerable< KeyValuePair< TKey, TValue > >
typedef IEnumerator< KeyValuePair< TKey, TValue > >	IEnumeratorType
	Enumerator type. More...

using	ValueType = KeyValuePair< TKey, TValue >

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

typedef System::Details::SharedMembersType	shared_members_type
	structure to keep list of shared pointers contained in object. More...

Public Member Functions
virtual void	Add (const TKey &key, const TValue &value)=0

virtual bool	ContainsKey (const TKey &key) const =0

virtual bool	Remove (const TKey &key)=0

virtual bool	TryGetValue (const TKey &key, TValue &value) const =0

virtual TValue	idx_get (const TKey &key) const =0

virtual void	idx_set (const TKey &key, TValue value)=0

virtual SharedPtr< ICollection< TKey > >	get_Keys () const

virtual SharedPtr< ICollection< TValue > >	get_Values () const

bool	get_IsFixedSize () const

bool	get_IsSynchronized () const

SharedPtr< Object >	get_SyncRoot ()

virtual void	CopyTo (ArrayPtr< KeyValuePair< TKey, TValue >> arr, int index) override

virtual TValue	GetValueOrDefault (const TKey &key) const
	Returns value if found; or `Value()` otherwise. More...

virtual TValue	GetValueOrDefault (const TKey &key, const TValue &defaultValue) const
	Returns value if found; or `defaultValue` otherwise. More...

virtual TValue	GetValueOrNull (const TKey &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< TKey, TValue > >
virtual int	get_Count () const=0

virtual void	Add (const KeyValuePair< TKey, TValue > &item)=0

virtual void	Clear ()=0
	Deletes all elements from collection. More...

virtual bool	Contains (const KeyValuePair< TKey, TValue > &item) const=0

virtual bool	Remove (const KeyValuePair< TKey, TValue > &item)=0

virtual bool	get_IsReadOnly () const

virtual void	CopyTo (System::ArrayPtr< KeyValuePair< TKey, TValue > > array, int arrayIndex)=0

ICollection &	operator= (ICollection &&)

ICollection &	operator= (const ICollection &)

	ICollection ()
	Default constructor. More...

	ICollection (const ICollection &)
	Copy constructor. More...

	ICollection (ICollection &&)
	Move constructor. More...

virtual	~ICollection ()
	Destructor. More...

Public Member Functions inherited from System::Collections::Generic::IEnumerable< KeyValuePair< TKey, TValue > >
virtual SharedPtr< IEnumerator< KeyValuePair< TKey, TValue > > >	GetEnumerator ()=0

KeyValuePair< TKey, TValue >	LINQ_ElementAt (int index)

KeyValuePair< TKey, TValue >	LINQ_First ()

KeyValuePair< TKey, TValue >	LINQ_FirstOrDefault ()

KeyValuePair< TKey, TValue >	LINQ_FirstOrDefault (std::function< bool(KeyValuePair< TKey, TValue >)> predicate)

KeyValuePair< TKey, TValue >	LINQ_Last ()

KeyValuePair< TKey, TValue >	LINQ_LastOrDefault ()

SharedPtr< List< KeyValuePair< TKey, TValue > > >	LINQ_ToList ()

int	LINQ_Count ()

System::ArrayPtr< KeyValuePair< TKey, TValue > >	LINQ_ToArray ()

bool	LINQ_All (std::function< bool(KeyValuePair< TKey, TValue >)> predicate)

bool	LINQ_Any ()

bool	LINQ_Any (std::function< bool(KeyValuePair< TKey, TValue >)> predicate)

SharedPtr< IEnumerable< KeyValuePair< TKey, TValue > > >	LINQ_Where (std::function< bool(KeyValuePair< TKey, TValue >)> predicate)

bool	LINQ_Contains (KeyValuePair< TKey, TValue > value)

SharedPtr< IEnumerable< ResultType > >	LINQ_Cast ()

SharedPtr< IEnumerable< Result > >	LINQ_Cast ()

SharedPtr< IEnumerable< ResultType > >	LINQ_OfType ()

SharedPtr< IEnumerable< Result > >	LINQ_OfType ()

SharedPtr< IEnumerable< ResultType > >	LINQ_Select (const Func< KeyValuePair< TKey, TValue >, ResultType > &selector)

SharedPtr< IEnumerable< Result > >	LINQ_Select (const Func< Source, Result > &selector)

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 refernce 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 int	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 (unsigned int argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

template<>
bool	Equals (float const &objA, float const &objB)

template<>
bool	Equals (double const &objA, double const &objB)

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)

template<>
bool	ReferenceEquals (String const &str1, String const &str2)

Protected Member Functions
	~IDictionary () override
	Destructor. More...

virtual SharedPtr< ICollection< TKey > >	get_KeysInternal () const
	Implementation of get_Keys() method. More...

virtual SharedPtr< ICollection< TValue > >	get_ValuesInternal () const
	Implementation of get_Values() method. More...

Protected Member Functions inherited from System::Collections::Generic::IEnumerable< KeyValuePair< TKey, TValue > >
	~IEnumerable () override
	Destructor. More...

Additional Inherited Members
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 ()
	Impleemnts C# typeof(System.Object) construct. More...

Detailed Description

template<typename TKey, typename TValue>
class System::Collections::Generic::IDictionary< TKey, TValue >

Interface for dictionary-alike containers. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Template Parameters

TKey	Key type.
TValue	Value type.

Member Typedef Documentation

◆ BaseType

template<typename TKey, typename TValue>

typedef ICollection<KeyValuePair<TKey, TValue> > System::Collections::Generic::IDictionary< TKey, TValue >::BaseType

Base interface type.

◆ KeyValuePairType

template<typename TKey, typename TValue>

typedef KeyValuePair<TKey, TValue> System::Collections::Generic::IDictionary< TKey, TValue >::KeyValuePairType

Key value pair type.

Constructor & Destructor Documentation

◆ ~IDictionary()

template<typename TKey, typename TValue>

System::Collections::Generic::IDictionary< TKey, TValue >::~IDictionary ( )

inlineoverrideprotected

Destructor.

Member Function Documentation

◆ Add()

template<typename TKey, typename TValue>

virtual void System::Collections::Generic::IDictionary< TKey, TValue >::Add	(	const TKey &	key,
		const TValue &	value
	)

pure virtual

Adds key-value pair into container.

Parameters

key	Key to add.
value	Value to add.

Implemented in Aspose::Pdf::Annotations::AppearanceDictionary, Aspose::Pdf::Facades::PdfXmpMetadata, System::Collections::Generic::BaseDictionary< map_t >, and Aspose::Pdf::Metadata.

◆ ContainsKey()

template<typename TKey, typename TValue>

virtual bool System::Collections::Generic::IDictionary< TKey, TValue >::ContainsKey ( const TKey & key ) const

pure virtual

Checks if container contains key.

Parameters

key	Key to look for.

Returns: True if key is present, false otherwise.

Implemented in Aspose::Pdf::Facades::PdfXmpMetadata, Aspose::Pdf::Annotations::AppearanceDictionary, Aspose::Pdf::Metadata, and System::Collections::Generic::BaseDictionary< map_t >.

◆ CopyTo()

template<typename TKey, typename TValue>

virtual void System::Collections::Generic::IDictionary< TKey, TValue >::CopyTo	(	ArrayPtr< KeyValuePair< TKey, TValue >>	arr,
		int	index
	)

inlineoverridevirtual

Copies dictionary contents into existing array elements.

Parameters

arr	Destination array.
index	Destination array start index.

◆ get_IsFixedSize()

template<typename TKey, typename TValue>

bool System::Collections::Generic::IDictionary< TKey, TValue >::get_IsFixedSize ( ) const

inline

Checks if collection size is fixed.

Returns: True if size is fixed, false otherwise.

◆ get_IsSynchronized()

template<typename TKey, typename TValue>

bool System::Collections::Generic::IDictionary< TKey, TValue >::get_IsSynchronized ( ) const

inline

Checks if container is thread-safe.

Returns: True if container access methods are thread-safe, false otherwise.

◆ get_Keys()

template<typename TKey, typename TValue>

virtual SharedPtr<ICollection<TKey> > System::Collections::Generic::IDictionary< TKey, TValue >::get_Keys ( ) const

inlinevirtual

Accesses key collection.

Returns: Pointer to interface providing access to stored keys via ICollection interface.

Reimplemented in Aspose::Pdf::Annotations::AppearanceDictionary, and Aspose::Pdf::Metadata.

◆ get_KeysInternal()

template<typename TKey, typename TValue>

virtual SharedPtr<ICollection<TKey> > System::Collections::Generic::IDictionary< TKey, TValue >::get_KeysInternal ( ) const

inlineprotectedvirtual

Implementation of get_Keys() method.

Reimplemented in System::Collections::Generic::SortedList< TKey, TValue >, Aspose::Pdf::Facades::PdfXmpMetadata, Aspose::Pdf::Annotations::AppearanceDictionary, Aspose::Pdf::Metadata, System::Collections::Generic::Dictionary< TKey, TValue >, System::Collections::Generic::Dictionary< String, String >, System::Collections::Generic::Dictionary< System::String, System::String >, System::Collections::Generic::SortedDictionary< TKey, TValue >, and System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >.

◆ get_SyncRoot()

template<typename TKey, typename TValue>

SharedPtr<Object> System::Collections::Generic::IDictionary< TKey, TValue >::get_SyncRoot ( )

inline

Gets object to use for collection synchronization.

Returns: Pointer to object to use for synchronization.

◆ get_Values()

template<typename TKey, typename TValue>

virtual SharedPtr<ICollection<TValue> > System::Collections::Generic::IDictionary< TKey, TValue >::get_Values ( ) const

inlinevirtual

Accesses value collection.

Returns: Pointer to interface providing access to stored values via ICollection interface.

Reimplemented in Aspose::Pdf::Annotations::AppearanceDictionary, and Aspose::Pdf::Metadata.

◆ get_ValuesInternal()

template<typename TKey, typename TValue>

virtual SharedPtr<ICollection<TValue> > System::Collections::Generic::IDictionary< TKey, TValue >::get_ValuesInternal ( ) const

inlineprotectedvirtual

Implementation of get_Values() method.

Reimplemented in System::Collections::Generic::SortedList< TKey, TValue >, Aspose::Pdf::Facades::PdfXmpMetadata, Aspose::Pdf::Annotations::AppearanceDictionary, Aspose::Pdf::Metadata, System::Collections::Generic::Dictionary< TKey, TValue >, System::Collections::Generic::Dictionary< String, String >, System::Collections::Generic::Dictionary< System::String, System::String >, System::Collections::Generic::SortedDictionary< TKey, TValue >, and System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >.

◆ GetValueOrDefault() [1/2]

template<typename TKey, typename TValue>

virtual TValue System::Collections::Generic::IDictionary< TKey, TValue >::GetValueOrDefault ( const TKey & key ) const

inlinevirtual

Returns value if found; or Value() otherwise.

Reimplemented in System::Collections::Generic::BaseDictionary< map_t >.

◆ GetValueOrDefault() [2/2]

template<typename TKey, typename TValue>

virtual TValue System::Collections::Generic::IDictionary< TKey, TValue >::GetValueOrDefault	(	const TKey &	key,
		const TValue &	defaultValue
	)		const

inlinevirtual

Returns value if found; or defaultValue otherwise.

Reimplemented in System::Collections::Generic::BaseDictionary< map_t >.

◆ GetValueOrNull()

template<typename TKey, typename TValue>

virtual TValue System::Collections::Generic::IDictionary< TKey, TValue >::GetValueOrNull ( const TKey & key ) const

inlinevirtual

Returns value if found; or null otherwise, make sense only for reference types.

Reimplemented in System::Collections::Generic::BaseDictionary< map_t >.

◆ idx_get()

template<typename TKey, typename TValue>

virtual TValue System::Collections::Generic::IDictionary< TKey, TValue >::idx_get ( const TKey & key ) const

pure virtual

Getter function.

Parameters

key	Key to look for.

Returns: Value at specified key.

Implemented in Aspose::Pdf::Facades::PdfXmpMetadata, Aspose::Pdf::Annotations::AppearanceDictionary, Aspose::Pdf::Metadata, and System::Collections::Generic::BaseDictionary< map_t >.

◆ idx_set()

template<typename TKey, typename TValue>

virtual void System::Collections::Generic::IDictionary< TKey, TValue >::idx_set	(	const TKey &	key,
		TValue	value
	)

pure virtual

Setter function.

Parameters

key	Key to look for.
value	Value to set to specified key.

Implemented in Aspose::Pdf::Facades::PdfXmpMetadata, Aspose::Pdf::Annotations::AppearanceDictionary, Aspose::Pdf::Metadata, and System::Collections::Generic::BaseDictionary< map_t >.

◆ Remove()

template<typename TKey, typename TValue>

virtual bool System::Collections::Generic::IDictionary< TKey, TValue >::Remove ( const TKey & key )

pure virtual

Removes key from container.

Parameters

key	Key to remove.

Returns: True if key was found and removed, false otherwise.

Implemented in Aspose::Pdf::Annotations::AppearanceDictionary, Aspose::Pdf::Facades::PdfXmpMetadata, System::Collections::Generic::BaseDictionary< map_t >, and Aspose::Pdf::Metadata.

◆ TryGetValue()

template<typename TKey, typename TValue>

virtual bool System::Collections::Generic::IDictionary< TKey, TValue >::TryGetValue	(	const TKey &	key,
		TValue &	value
	)		const

pure virtual

Looks for value and retreives it if found.

Parameters

key	Key to look for.
value	Reference to store retreived value into.

Returns: True if value was found and retreived, false otherwise.

Implemented in Aspose::Pdf::Facades::PdfXmpMetadata, Aspose::Pdf::Annotations::AppearanceDictionary, Aspose::Pdf::Metadata, and System::Collections::Generic::BaseDictionary< map_t >.

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

template<typename TKey, typename TValue> class System::Collections::Generic::IDictionary< TKey, TValue >

Member Typedef Documentation

◆ BaseType

◆ KeyValuePairType

Constructor & Destructor Documentation

◆ ~IDictionary()

Member Function Documentation

◆ Add()

◆ ContainsKey()

◆ CopyTo()

◆ get_IsFixedSize()

◆ get_IsSynchronized()

◆ get_Keys()

◆ get_KeysInternal()

◆ get_SyncRoot()

◆ get_Values()

◆ get_ValuesInternal()

◆ GetValueOrDefault() [1/2]

◆ GetValueOrDefault() [2/2]

◆ GetValueOrNull()

◆ idx_get()

◆ idx_set()

◆ Remove()

◆ TryGetValue()

template<typename TKey, typename TValue>
class System::Collections::Generic::IDictionary< TKey, TValue >