Maria GDK 4.7.0.84
Documentation of managed code in develop branch
Loading...
Searching...
No Matches
PropertyBags.PropertyBag.PropertySpecCollection Class Reference

Encapsulates a collection of PropertySpec objects. More...

Inheritance diagram for PropertyBags.PropertyBag.PropertySpecCollection:

Public Member Functions

 PropertySpecCollection ()
 Initializes a new instance of the PropertySpecCollection class.
 
int Add (PropertySpec value)
 Adds a PropertySpec to the end of the PropertySpecCollection.
 
void AddRange (PropertySpec[] array)
 Adds the elements of an array of PropertySpec objects to the end of the PropertySpecCollection.
 
void Clear ()
 Removes all elements from the PropertySpecCollection.
 
bool Contains (PropertySpec item)
 Determines whether a PropertySpec is in the PropertySpecCollection.
 
bool Contains (string name)
 Determines whether a PropertySpec with the specified name is in the PropertySpecCollection.
 
void CopyTo (PropertySpec[] array)
 Copies the entire PropertySpecCollection to a compatible one-dimensional Array, starting at the beginning of the target array.
 
void CopyTo (PropertySpec[] array, int index)
 Copies the PropertySpecCollection or a portion of it to a one-dimensional array.
 
IEnumerator GetEnumerator ()
 Returns an enumerator that can iterate through the PropertySpecCollection.
 
int IndexOf (PropertySpec value)
 Searches for the specified PropertySpec and returns the zero-based index of the first occurrence within the entire PropertySpecCollection.
 
int IndexOf (string name)
 Searches for the PropertySpec with the specified name and returns the zero-based index of the first occurrence within the entire PropertySpecCollection.
 
void Insert (int index, PropertySpec value)
 Inserts a PropertySpec object into the PropertySpecCollection at the specified index.
 
void Remove (PropertySpec obj)
 Removes the first occurrence of a specific object from the PropertySpecCollection.
 
void Remove (string name)
 Removes the property with the specified name from the PropertySpecCollection.
 
void RemoveAt (int index)
 Removes the object at the specified index of the PropertySpecCollection.
 
PropertySpec[] ToArray ()
 Copies the elements of the PropertySpecCollection to a new PropertySpec array.
 

Properties

int Count [get]
 Gets the number of elements in the PropertySpecCollection.
 
bool IsFixedSize [get]
 Gets a value indicating whether the PropertySpecCollection has a fixed size.
 
bool IsReadOnly [get]
 Gets a value indicating whether the PropertySpecCollection is read-only.
 
bool IsSynchronized [get]
 Gets a value indicating whether access to the collection is synchronized (thread-safe).
 
PropertySpec this[int index] [get, set]
 Gets or sets the element at the specified index. In C#, this property is the indexer for the PropertySpecCollection class.
 

Detailed Description

Encapsulates a collection of PropertySpec objects.

Member Function Documentation

◆ Add()

int PropertyBags.PropertyBag.PropertySpecCollection.Add ( PropertySpec  value)
inline

Adds a PropertySpec to the end of the PropertySpecCollection.

Parameters
valueThe PropertySpec to be added to the end of the PropertySpecCollection.
Returns
The PropertySpecCollection index at which the value has been added.

◆ AddRange()

void PropertyBags.PropertyBag.PropertySpecCollection.AddRange ( PropertySpec[]  array)
inline

Adds the elements of an array of PropertySpec objects to the end of the PropertySpecCollection.

Parameters
arrayThe PropertySpec array whose elements should be added to the end of the PropertySpecCollection.

◆ Contains() [1/2]

bool PropertyBags.PropertyBag.PropertySpecCollection.Contains ( PropertySpec  item)
inline

Determines whether a PropertySpec is in the PropertySpecCollection.

Parameters
itemThe PropertySpec to locate in the PropertySpecCollection. The element to locate can be a null reference (Nothing in Visual Basic).
Returns
true if item is found in the PropertySpecCollection; otherwise, false.

◆ Contains() [2/2]

bool PropertyBags.PropertyBag.PropertySpecCollection.Contains ( string  name)
inline

Determines whether a PropertySpec with the specified name is in the PropertySpecCollection.

Parameters
nameThe name of the PropertySpec to locate in the PropertySpecCollection.
Returns
true if item is found in the PropertySpecCollection; otherwise, false.

◆ CopyTo() [1/2]

void PropertyBags.PropertyBag.PropertySpecCollection.CopyTo ( PropertySpec[]  array)
inline

Copies the entire PropertySpecCollection to a compatible one-dimensional Array, starting at the beginning of the target array.

Parameters
arrayThe one-dimensional Array that is the destination of the elements copied from PropertySpecCollection. The Array must have zero-based indexing.

◆ CopyTo() [2/2]

void PropertyBags.PropertyBag.PropertySpecCollection.CopyTo ( PropertySpec[]  array,
int  index 
)
inline

Copies the PropertySpecCollection or a portion of it to a one-dimensional array.

Parameters
arrayThe one-dimensional Array that is the destination of the elements copied from the collection.
indexThe zero-based index in array at which copying begins.

◆ GetEnumerator()

IEnumerator PropertyBags.PropertyBag.PropertySpecCollection.GetEnumerator ( )
inline

Returns an enumerator that can iterate through the PropertySpecCollection.

Returns
An IEnumerator for the entire PropertySpecCollection.

◆ IndexOf() [1/2]

int PropertyBags.PropertyBag.PropertySpecCollection.IndexOf ( PropertySpec  value)
inline

Searches for the specified PropertySpec and returns the zero-based index of the first occurrence within the entire PropertySpecCollection.

Parameters
valueThe PropertySpec to locate in the PropertySpecCollection.
Returns
The zero-based index of the first occurrence of value within the entire PropertySpecCollection, if found; otherwise, -1.

◆ IndexOf() [2/2]

int PropertyBags.PropertyBag.PropertySpecCollection.IndexOf ( string  name)
inline

Searches for the PropertySpec with the specified name and returns the zero-based index of the first occurrence within the entire PropertySpecCollection.

Parameters
nameThe name of the PropertySpec to locate in the PropertySpecCollection.
Returns
The zero-based index of the first occurrence of value within the entire PropertySpecCollection, if found; otherwise, -1.

◆ Insert()

void PropertyBags.PropertyBag.PropertySpecCollection.Insert ( int  index,
PropertySpec  value 
)
inline

Inserts a PropertySpec object into the PropertySpecCollection at the specified index.

Parameters
indexThe zero-based index at which value should be inserted.
valueThe PropertySpec to insert.

◆ Remove() [1/2]

void PropertyBags.PropertyBag.PropertySpecCollection.Remove ( PropertySpec  obj)
inline

Removes the first occurrence of a specific object from the PropertySpecCollection.

Parameters
objThe PropertySpec to remove from the PropertySpecCollection.

◆ Remove() [2/2]

void PropertyBags.PropertyBag.PropertySpecCollection.Remove ( string  name)
inline

Removes the property with the specified name from the PropertySpecCollection.

Parameters
nameThe name of the PropertySpec to remove from the PropertySpecCollection.

◆ RemoveAt()

void PropertyBags.PropertyBag.PropertySpecCollection.RemoveAt ( int  index)
inline

Removes the object at the specified index of the PropertySpecCollection.

Parameters
indexThe zero-based index of the element to remove.

◆ ToArray()

PropertySpec[] PropertyBags.PropertyBag.PropertySpecCollection.ToArray ( )
inline

Copies the elements of the PropertySpecCollection to a new PropertySpec array.

Returns
A PropertySpec array containing copies of the elements of the PropertySpecCollection.

Property Documentation

◆ Count

int PropertyBags.PropertyBag.PropertySpecCollection.Count
get

Gets the number of elements in the PropertySpecCollection.

The number of elements contained in the PropertySpecCollection.

◆ IsFixedSize

bool PropertyBags.PropertyBag.PropertySpecCollection.IsFixedSize
get

Gets a value indicating whether the PropertySpecCollection has a fixed size.

true if the PropertySpecCollection has a fixed size; otherwise, false.

◆ IsSynchronized

bool PropertyBags.PropertyBag.PropertySpecCollection.IsSynchronized
get

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

true if access to the PropertySpecCollection is synchronized (thread-safe); otherwise, false.

◆ this[int index]

PropertySpec PropertyBags.PropertyBag.PropertySpecCollection.this[int index]
getset

Gets or sets the element at the specified index. In C#, this property is the indexer for the PropertySpecCollection class.

Parameters
indexThe zero-based index of the element to get or set.

The element at the specified index.


The documentation for this class was generated from the following file: