Represents a collection item class. The collection item contains the data described by the collection schema. More...

#include "FileSpecification.h"

Classes
class	Value
	Represents a class for a value of colection item. More...

Public Member Functions
ASPOSE_PDF_SHARED_API bool	get_IsEmpty ()
	Gets a value indicating whether the collection item is empty. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::ICollection< System::String > >	get_AllNames ()
	Gets a collection of all the names of collection item values. More...

ASPOSE_PDF_SHARED_API bool	HasName (System::String name)
	Checks if the given name exists in the collection item. More...

ASPOSE_PDF_SHARED_API bool	TryGetIntValue (System::String name, System::SharedPtr< CollectionItem::Value< int32_t >> &value)
	Tries to get the integer value for a specified name from the collection item. More...

ASPOSE_PDF_SHARED_API bool	TryGetDoubleValue (System::String name, System::SharedPtr< CollectionItem::Value< double >> &value)
	Tries to get the double value for the specified name from the collection item. More...

ASPOSE_PDF_SHARED_API bool	TryGetTextValue (System::String name, System::SharedPtr< CollectionItem::Value< System::String >> &value)
	Tries to get the text value with the specified name from the collection item. More...

ASPOSE_PDF_SHARED_API bool	TryGetDateTimeValue (System::String name, System::SharedPtr< CollectionItem::Value< System::DateTime >> &value)
	Tries to get the value of type DateTime from the collection item by the specified name. 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
	CollectionItem ()
	Creates a collection item class instance. More...

	MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (CollectionItem, CODEPORTING_ARGS())

	CollectionItem (System::SharedPtr< Engine::Data::IPdfDictionary > collectionItemDict)
	Creates a collection item class instance. More...

	MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (CollectionItem, CODEPORTING_ARGS(System::SharedPtr< Engine::Data::IPdfDictionary > collectionItemDict))

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...

Detailed Description

Represents a collection item class. The collection item contains the data described by the collection schema.

Constructor & Destructor Documentation

◆ CollectionItem() [1/2]

Aspose::Pdf::CollectionItem::CollectionItem ( )

protected

Creates a collection item class instance.

◆ CollectionItem() [2/2]

Aspose::Pdf::CollectionItem::CollectionItem ( System::SharedPtr< Engine::Data::IPdfDictionary > collectionItemDict )

protected

Creates a collection item class instance.

Parameters

collectionItemDict The collection item dictionary.

Member Function Documentation

◆ get_AllNames()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::ICollection<System::String> > Aspose::Pdf::CollectionItem::get_AllNames ( )

Gets a collection of all the names of collection item values.

◆ get_IsEmpty()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::CollectionItem::get_IsEmpty ( )

Gets a value indicating whether the collection item is empty.

This property returns true if the collection item does not contain any values, including string values, double values, integer values, and date values. If any of these value types are present in the collection item, this property returns false.

Returns: true if the collection item is empty; otherwise, false.

◆ HasName()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::CollectionItem::HasName ( System::String name )

Checks if the given name exists in the collection item.

Parameters

name	The name to check.

Returns: True if the name exists in the collection item, otherwise false.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [1/2]

Aspose::Pdf::CollectionItem::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION	(	CollectionItem	,
		CODEPORTING_ARGS()
	)

protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [2/2]

Aspose::Pdf::CollectionItem::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION	(	CollectionItem	,
		CODEPORTING_ARGS(System::SharedPtr< Engine::Data::IPdfDictionary > collectionItemDict)
	)

protected

◆ TryGetDateTimeValue()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::CollectionItem::TryGetDateTimeValue	(	System::String	name,
		System::SharedPtr< CollectionItem::Value< System::DateTime >> &	value
	)

Tries to get the value of type DateTime from the collection item by the specified name.

Parameters

name	The name of the value to retrieve.
value	When this method returns, contains the value associated with the specified name, if the name is found; otherwise, null. This parameter is passed uninitialized.

Returns: true if the value associated with the specified name is successfully retrieved; otherwise, false.

◆ TryGetDoubleValue()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::CollectionItem::TryGetDoubleValue	(	System::String	name,
		System::SharedPtr< CollectionItem::Value< double >> &	value
	)

Tries to get the double value for the specified name from the collection item.

Parameters

name	The name of the value to retrieve.
value	When this method returns, contains the double value associated with the specified name, if the name is found; otherwise, null. This parameter is passed uninitialized.

Returns: true if the value is successfully retrieved; otherwise, false.

◆ TryGetIntValue()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::CollectionItem::TryGetIntValue	(	System::String	name,
		System::SharedPtr< CollectionItem::Value< int32_t >> &	value
	)

Tries to get the integer value for a specified name from the collection item.

Parameters

name	The name of the value to retrieve.
value	When this method returns, contains the value associated with the specified name, if the name is found; otherwise, null.

Returns: true if the value associated with the specified name is found; otherwise, false.

◆ TryGetTextValue()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::CollectionItem::TryGetTextValue	(	System::String	name,
		System::SharedPtr< CollectionItem::Value< System::String >> &	value
	)

Tries to get the text value with the specified name from the collection item.

Parameters

name	The name of the text value.
value	When this method returns, contains the text value associated with the specified name, if the name is found; otherwise, null.

Returns: true if the text value with the specified name is found; otherwise, false.

Classes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CollectionItem() [1/2]

◆ CollectionItem() [2/2]

Member Function Documentation

◆ get_AllNames()

◆ get_IsEmpty()

◆ HasName()

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [1/2]

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [2/2]

◆ TryGetDateTimeValue()

◆ TryGetDoubleValue()

◆ TryGetIntValue()

◆ TryGetTextValue()