Aspose::Pdf::Forms::OptionCollection Class Referencefinal

Class representing collection of options of the choice field. More...

Inherits System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Forms::Option > >.

Public Member Functions

bool get_IsSynchronized ()
 Returns true of object is synchronized. More...
 
bool get_IsReadOnly () const
 Gets a value indicating if collection is readonly. More...
 
System::SharedPtr< System::Objectget_SyncRoot () const
 Synchronization object of the collection. More...
 
int32_t get_Count () const
 Gets number of options. More...
 
void CopyTo (System::ArrayPtr< System::SharedPtr< Option >> array, int32_t index)
 Copies options into array. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Option > > > GetEnumerator ()
 Returns enumerator for options in collection. More...
 
System::SharedPtr< Optionget (int32_t index)
 Gets option by index. More...
 
System::SharedPtr< Optionget (System::String name)
 Gets option from colleciton by option name. More...
 
System::SharedPtr< Optionidx_get (int32_t index)
 Gets option by index. More...
 
System::SharedPtr< Optionidx_get (System::String name)
 Gets option by its name. More...
 
void Add (System::SharedPtr< Option > const &item)
 
void Clear ()
 
bool Contains (System::SharedPtr< Option > const &item) const
 
bool Remove (System::SharedPtr< Option > const &item)
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Forms::Option > >
virtual void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Pdf::Forms::Option > > array, int arrayIndex)=0
 
ICollectionoperator= (ICollection &&)
 
ICollectionoperator= (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< System::SharedPtr< Aspose::Pdf::Forms::Option > >
System::SharedPtr< Aspose::Pdf::Forms::OptionLINQ_ElementAt (int index)
 
System::SharedPtr< Aspose::Pdf::Forms::OptionLINQ_First ()
 
System::SharedPtr< Aspose::Pdf::Forms::OptionLINQ_FirstOrDefault ()
 
System::SharedPtr< Aspose::Pdf::Forms::OptionLINQ_FirstOrDefault (std::function< bool(System::SharedPtr< Aspose::Pdf::Forms::Option >)> predicate)
 
System::SharedPtr< Aspose::Pdf::Forms::OptionLINQ_Last ()
 
System::SharedPtr< Aspose::Pdf::Forms::OptionLINQ_LastOrDefault ()
 
SharedPtr< List< System::SharedPtr< Aspose::Pdf::Forms::Option > > > LINQ_ToList ()
 
int LINQ_Count ()
 
System::ArrayPtr< System::SharedPtr< Aspose::Pdf::Forms::Option > > LINQ_ToArray ()
 
bool LINQ_All (std::function< bool(System::SharedPtr< Aspose::Pdf::Forms::Option >)> predicate)
 
bool LINQ_Any ()
 
bool LINQ_Any (std::function< bool(System::SharedPtr< Aspose::Pdf::Forms::Option >)> predicate)
 
SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::Forms::Option > > > LINQ_Where (std::function< bool(System::SharedPtr< Aspose::Pdf::Forms::Option >)> predicate)
 
bool LINQ_Contains (System::SharedPtr< Aspose::Pdf::Forms::Option > 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< System::SharedPtr< Aspose::Pdf::Forms::Option >, 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...
 
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 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 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 (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

 OptionCollection (System::SharedPtr< BaseOptionCollection > options)
 
void AddOption (System::String name)
 Adds option to the colleciton. More...
 
void AddOption (System::String name, bool bigEndian)
 Adds option to the colleciton. More...
 
void AddOption (System::String export_, System::String name)
 Adds option to the colleciton. More...
 
void DeleteOption (System::String name)
 Deletes option by its name. More...
 
void Initialize (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > dict)
 
virtual ~OptionCollection ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Forms::Option > >
 ~IEnumerable () override
 Destructor. More...
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Forms::Option > >
typedef System::SharedPtr< Aspose::Pdf::Forms::OptionValueType
 Value type name. More...
 
typedef ICollection< System::SharedPtr< Aspose::Pdf::Forms::Option > > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Forms::Option > >
typedef IEnumerator< System::SharedPtr< Aspose::Pdf::Forms::Option > > IEnumeratorType
 Enumerator type. More...
 
using ValueType = System::SharedPtr< Aspose::Pdf::Forms::Option >
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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 ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Detailed Description

Class representing collection of options of the choice field.

Constructor & Destructor Documentation

◆ OptionCollection()

Aspose::Pdf::Forms::OptionCollection::OptionCollection ( System::SharedPtr< BaseOptionCollection >  options)
protected

◆ ~OptionCollection()

virtual Aspose::Pdf::Forms::OptionCollection::~OptionCollection ( )
protectedvirtual

Member Function Documentation

◆ Add()

void Aspose::Pdf::Forms::OptionCollection::Add ( System::SharedPtr< Option > const &  item)
virtual

◆ AddOption() [1/3]

void Aspose::Pdf::Forms::OptionCollection::AddOption ( System::String  name)
protected

Adds option to the colleciton.

Parameters
nameName of new option.

◆ AddOption() [2/3]

void Aspose::Pdf::Forms::OptionCollection::AddOption ( System::String  name,
bool  bigEndian 
)
protected

Adds option to the colleciton.

Parameters
nameName of new option.
bigEndianIs big endian encoding

◆ AddOption() [3/3]

void Aspose::Pdf::Forms::OptionCollection::AddOption ( System::String  export_,
System::String  name 
)
protected

Adds option to the colleciton.

Parameters
exportExport identifer of the option.
nameName of the option.

◆ Clear()

void Aspose::Pdf::Forms::OptionCollection::Clear ( )
virtual

◆ Contains()

bool Aspose::Pdf::Forms::OptionCollection::Contains ( System::SharedPtr< Option > const &  item) const
virtual

◆ CopyTo()

void Aspose::Pdf::Forms::OptionCollection::CopyTo ( System::ArrayPtr< System::SharedPtr< Option >>  array,
int32_t  index 
)

Copies options into array.

Parameters
arrayArray where options wil lbe copied.
indexStartign index in array.

◆ DeleteOption()

void Aspose::Pdf::Forms::OptionCollection::DeleteOption ( System::String  name)
protected

Deletes option by its name.

Parameters
nameName of the option to delete.

◆ get() [1/2]

System::SharedPtr<Option> Aspose::Pdf::Forms::OptionCollection::get ( int32_t  index)

Gets option by index.

Parameters
indexOption index. Index should be in range [1..n] where n is options count.
Returns
Retreived option.

◆ get() [2/2]

System::SharedPtr<Option> Aspose::Pdf::Forms::OptionCollection::get ( System::String  name)

Gets option from colleciton by option name.

Parameters
nameOption name.
Returns
Retreived option.

◆ get_Count()

int32_t Aspose::Pdf::Forms::OptionCollection::get_Count ( ) const
virtual

◆ get_IsReadOnly()

bool Aspose::Pdf::Forms::OptionCollection::get_IsReadOnly ( ) const
virtual

Gets a value indicating if collection is readonly.

Reimplemented from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Forms::Option > >.

◆ get_IsSynchronized()

bool Aspose::Pdf::Forms::OptionCollection::get_IsSynchronized ( )

Returns true of object is synchronized.

◆ get_SyncRoot()

System::SharedPtr<System::Object> Aspose::Pdf::Forms::OptionCollection::get_SyncRoot ( ) const

Synchronization object of the collection.

◆ GetEnumerator()

System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<Option> > > Aspose::Pdf::Forms::OptionCollection::GetEnumerator ( )
virtual

Returns enumerator for options in collection.

Returns
Options enumerator.

Implements System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Forms::Option > >.

◆ idx_get() [1/2]

System::SharedPtr<Option> Aspose::Pdf::Forms::OptionCollection::idx_get ( int32_t  index)

Gets option by index.

Parameters
indexIndex of the option.
Returns
Option on the specified index.

◆ idx_get() [2/2]

System::SharedPtr<Option> Aspose::Pdf::Forms::OptionCollection::idx_get ( System::String  name)

Gets option by its name.

Parameters
nameName of the option.
Returns
Found option.

◆ Initialize()

void Aspose::Pdf::Forms::OptionCollection::Initialize ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary >  dict)
protected

◆ Remove()

bool Aspose::Pdf::Forms::OptionCollection::Remove ( System::SharedPtr< Option > const &  item)
virtual