Asposecpplib
System::Text::RegularExpressions::CaptureCollection Class Reference

List of captures done by single capturing group. 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. More...

Inherits System::Collections::Generic::List< CapturePtr >.

Public Types

typedef System::Collections::Generic::List< CapturePtrBase
 Base type. More...
 
- Public Types inherited from System::Collections::Generic::List< CapturePtr >
typedef CapturePtr ValueType
 This type. More...
 
typedef IList< CapturePtr > BaseType
 Interface type. More...
 
typedef std::vector< CapturePtr, ASPOSE_COLLECTION_ALLOCATOR_TYPE > vector_t
 Underlying data type. More...
 
typedef vector_t::iterator iterator
 Iterator type. More...
 
typedef vector_t::const_iterator const_iterator
 Const iterator type. More...
 
typedef vector_t::reverse_iterator reverse_iterator
 Reverse iterator type. More...
 
typedef vector_t::const_reverse_iterator const_reverse_iterator
 Const reverse iterator type. More...
 
typedef SharedPtr< IEnumerable< CapturePtr > > IEnumerablePtr
 Container holding elements of same type we hold. More...
 
typedef SharedPtr< IEnumerator< CapturePtr > > IEnumeratorPtr
 Enumerator type. More...
 

Public Member Functions

int get_Count () const override
 Gets number of captures. More...
 
bool Add (const CapturePtr item)
 Disables collection ammendment. More...
 
void Clear () override
 Disables cleaning collection. More...
 
bool Remove (const CapturePtr item)
 Disables collection ammendment. More...
 
bool get_IsReadOnly () const override
 Marks collection as read-only. More...
 
bool get_IsSynchronized () const
 Marks collection as unsynchronized. More...
 
void AddCapture (const CapturePtr item)
 Service method to add capture into collection. More...
 
- Public Member Functions inherited from System::Collections::Generic::List< CapturePtr >
 List ()
 Creates empty list. More...
 
 List (int capacity)
 Creates list with pre-defined capacity. More...
 
 List (IEnumerablePtr collection)
 Copy constructor. More...
 
void AddInitializer (int size, const CapturePtr inits[])
 Adds elements to list; used when translating initializers. More...
 
iterator begin () noexcept
 Gets iterator to the first element of collection. More...
 
const_iterator begin () const noexcept
 Gets iterator to the first element of the const-qualified collection. More...
 
iterator end () noexcept
 Gets iterator for a non-existent element behind the end of the collection. More...
 
const_iterator end () const noexcept
 Gets iterator for a non-existent element behind the end of the const-qualified collection. More...
 
const_iterator cbegin () const noexcept
 Gets iterator to the first const-qualified element of collection. More...
 
const_iterator cend () const noexcept
 Gets iterator for a non-existent const-qualified element behind the end of the collection. More...
 
reverse_iterator rbegin () noexcept
 Gets a reverse iterator to the last element of collection (first in reverse). More...
 
const_reverse_iterator rbegin () const noexcept
 Gets a reverse iterator to the last element of the const-qualified collection (first in reverse). More...
 
reverse_iterator rend () noexcept
 Gets a reverse iterator for a non-existent element before the start of the collection. More...
 
const_reverse_iterator rend () const noexcept
 Gets a reverse iterator for a non-existent element before the start of the const-qualified collection. More...
 
const_reverse_iterator crbegin () const noexcept
 Gets a reverse iterator to the last const-qualified element of collection (first in reverse). More...
 
const_reverse_iterator crend () const noexcept
 Gets a reverse iterator for a non-existent const-qualified element before the start of the collection. More...
 
IEnumeratorPtr GetEnumerator () override
 Gets enumerator to iterate through list elements. More...
 
int get_Count () const override
 Gets number of elements in current list. More...
 
void Add (const CapturePtr &item) override
 Adds element to the end of list. More...
 
void Clear () override
 Deletes all elements. More...
 
bool Contains (const CapturePtr &item) const override
 Checks if item is present in list. More...
 
bool Remove (const CapturePtr &item) override
 Removes first instance of specific item from list. More...
 
void CopyTo (System::ArrayPtr< CapturePtr > array, int arrayIndex) override
 Copies list elements into existing array elements. More...
 
void CopyTo (const System::ArrayPtr< CapturePtr > &array)
 Copies all elements into existing array elements. More...
 
void CopyTo (int index, const System::ArrayPtr< CapturePtr > &array, int arrayIndex, int count)
 Copies elements starting from the specified index into existing array elements. More...
 
int IndexOf (const CapturePtr &item) const override
 Gets first index of specific item. More...
 
int IndexOf (const CapturePtr &item, int index) const
 Looks for specific item in list. More...
 
void Insert (int index, const CapturePtr &item) override
 Inserts item at specified position. More...
 
void RemoveAt (int index) override
 Removes item at specified position. More...
 
CapturePtr idx_get (int index) const override
 Gets element at specific position. More...
 
void idx_set (int index, CapturePtr value) override
 Sets element at specific position. More...
 
int get_Capacity () const
 Gets current list capacity. More...
 
void set_Capacity (int capacity)
 Sets list capacity. More...
 
void AddRange (IEnumerablePtr collection)
 Adds all elements from collection (or itself) to the end of current list. More...
 
SharedPtr< System::Collections::ObjectModel::ReadOnlyCollection< CapturePtr > > AsReadOnly ()
 Gets read-only reference to this collection. More...
 
int BinarySearch (const CapturePtr &item) const
 Looks for item in a sorted list. More...
 
int BinarySearch (const CapturePtr &item, const SharedPtr< System::Collections::Generic::IComparer< CapturePtr > > &comparer) const
 Looks for item in a sorted list. More...
 
int BinarySearch (int index, int count, const CapturePtr &item, const SharedPtr< System::Collections::Generic::IComparer< CapturePtr > > &comparer) const
 Looks for item in a sorted list. More...
 
SharedPtr< List< OutputType > > ConvertAll (Converter< CapturePtr, OutputType > converter)
 Creates a list of elements converted to different type. More...
 
bool Exists (System::Predicate< CapturePtr > match)
 Checks if element adhering to specific predicate exists in list. More...
 
CapturePtr Find (System::Predicate< CapturePtr > predicate)
 Looks for element adhering to specific predicate. More...
 
ListPtr< CapturePtr > FindAll (System::Predicate< CapturePtr > match)
 Looks for elements adhering to specific predicate. More...
 
int FindIndex (System::Predicate< CapturePtr > match)
 Looks for element adhering to specific predicate. More...
 
int FindIndex (int startIndex, System::Predicate< CapturePtr > match)
 Looks for element adhering to specific predicate. More...
 
int FindIndex (int startIndex, int count, System::Predicate< CapturePtr > match)
 Looks for element adhering to specific predicate. More...
 
CapturePtr FindLast (System::Predicate< CapturePtr > match)
 Looks for last element adhering to specific predicate. More...
 
void ForEach (System::Action< CapturePtr > action)
 Applies action to all elements in list. More...
 
ThisPtr GetRange (int index, int count)
 Creates slice of list. More...
 
void InsertRange (int index, IEnumerablePtr collection)
 Inserts data range at specific position. More...
 
int32_t LastIndexOf (const CapturePtr &item) const
 Searches for the specified object and returns the zero-based index of the last occurrence within the entire list. More...
 
int32_t LastIndexOf (const CapturePtr &item, int32_t index) const
 Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List that extends from the first element to the specified index. More...
 
int32_t LastIndexOf (const CapturePtr &item, int32_t index, int32_t count) const
 Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List that contains the specified number of elements and ends at the specified index. More...
 
int RemoveAll (Predicate< CapturePtr > match)
 Removes all elements matching specific predicate. More...
 
void RemoveRange (int index, int count)
 Removes slice of list. More...
 
void Reverse ()
 Reverses elements order of the whole list. More...
 
void Reverse (int index, int count)
 Reverses elements order of the list slice. More...
 
void Sort (const SharedPtr< System::Collections::Generic::IComparer< CapturePtr > > &comparator)
 Sorts elements in the list. More...
 
void Sort ()
 Sorts elements in the list using default comparator. More...
 
void Sort (int index, int count, SharedPtr< System::Collections::Generic::IComparer< CapturePtr > > comparator)
 Sorts elements in the list slice. More...
 
void Sort (Comparison< CapturePtr > comparison, bool)
 Sorts elements in the list. More...
 
ArrayPtr< CapturePtr > ToArray () const
 Converst list to array. More...
 
void TrimExcess ()
 Makes list capacity to fit its size. More...
 
bool TrueForAll (System::Predicate< CapturePtr > match)
 Determines whether every element in the collection matches the conditions defined by the specified predicate. More...
 
vector_t::reference operator[] (int index)
 Accessor function. More...
 
vector_t::const_reference operator[] (int index) const
 Accessor function. More...
 
vector_tdata ()
 Underlying data structure access function. More...
 
const vector_tdata () const
 Underlying data structure access function. More...
 
void _add_range (std::initializer_list< CapturePtr > list)
 C++ specific. More...
 

Detailed Description

List of captures done by single capturing group. 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.

Member Typedef Documentation

◆ Base

Member Function Documentation

◆ Add()

bool System::Text::RegularExpressions::CaptureCollection::Add ( const CapturePtr  item)
inline

Disables collection ammendment.

Parameters
itemItem to add; ignored.
Returns
Always returns false.

◆ AddCapture()

void System::Text::RegularExpressions::CaptureCollection::AddCapture ( const CapturePtr  item)
inline

Service method to add capture into collection.

Parameters
itemItem to add.

◆ Clear()

void System::Text::RegularExpressions::CaptureCollection::Clear ( )
inlineoverride

Disables cleaning collection.

◆ get_Count()

int System::Text::RegularExpressions::CaptureCollection::get_Count ( ) const
inlineoverride

Gets number of captures.

Returns
Contained captures number.

◆ get_IsReadOnly()

bool System::Text::RegularExpressions::CaptureCollection::get_IsReadOnly ( ) const
inlineoverride

Marks collection as read-only.

Returns
Always returns true.

◆ get_IsSynchronized()

bool System::Text::RegularExpressions::CaptureCollection::get_IsSynchronized ( ) const
inline

Marks collection as unsynchronized.

Returns
Always returns false.

◆ Remove()

bool System::Text::RegularExpressions::CaptureCollection::Remove ( const CapturePtr  item)
inline

Disables collection ammendment.

Parameters
itemItem to remove; ignored.
Returns
Always returns false.