Class CurrentRecordPropertyCollection
Represents a class that provides a collection of CurrentRecordProperty elements that provides storage for modified values for the current Record in a CurrentRecordManager. An instance of this collection is returned by the Properties property of a CurrentRecordManager object.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public class CurrentRecordPropertyCollection : IList, ICollection, IEnumerable
Fields
Empty
A Read-only and empty collection.
Declaration
public static CurrentRecordPropertyCollection Empty
Field Value
| Type |
|---|
| CurrentRecordPropertyCollection |
Properties
Count
Gets the number of elements contained in collection.
Declaration
public int Count { get; }
Property Value
| Type |
|---|
| System.Int32 |
Remarks
The property also ensures that the collection is in sync with the underlying table if changes have been made to the table or the TableDescriptor.
If changes in the TableDescriptor are detected, the method will reinitialize the field descriptors before returning the count.
IsFixedSize
Gets a value indicating whether the collection is of fixed size or not.
Declaration
public bool IsFixedSize { get; }
Property Value
| Type |
|---|
| System.Boolean |
IsReadOnly
Gets a value indicating whether the collection is read-only or not.
Declaration
public bool IsReadOnly { get; }
Property Value
| Type |
|---|
| System.Boolean |
IsSynchronized
Gets a value indicating whether the object can be used to synchronize access to the collection or not.
Declaration
public bool IsSynchronized { get; }
Property Value
| Type |
|---|
| System.Boolean |
Item[FieldDescriptor]
Gets the element for the descriptor.
Declaration
public CurrentRecordProperty this[FieldDescriptor fd] { get; set; }
Parameters
| Type | Name | Description |
|---|---|---|
| FieldDescriptor | fd |
Property Value
| Type |
|---|
| CurrentRecordProperty |
Exceptions
| Type | Condition |
|---|---|
| System.InvalidOperationException | Since the collection is read-only, if the set operation is performed the exception occurs. |
Item[Int32]
Gets the element at the zero-based index.
Declaration
public CurrentRecordProperty this[int index] { get; set; }
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index |
Property Value
| Type |
|---|
| CurrentRecordProperty |
Exceptions
| Type | Condition |
|---|---|
| System.InvalidOperationException | Since the collection is read-only, if the set operation is performed the exception occurs. |
Item[String]
Gets the element for the field with the specified name.
Declaration
public CurrentRecordProperty this[string name] { get; set; }
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name |
Property Value
| Type |
|---|
| CurrentRecordProperty |
Exceptions
| Type | Condition |
|---|---|
| System.InvalidOperationException | Since the collection is read-only, if the set operation is performed the exception occurs. |
Methods
Contains(CurrentRecordProperty)
Determines if the element belongs to this collection or not.
Declaration
public bool Contains(CurrentRecordProperty value)
Parameters
| Type | Name | Description |
|---|---|---|
| CurrentRecordProperty | value | The object to be checked. The value can be a NULL reference (Nothing in Visual Basic). |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the item is in the collection;Otherwise False. |
CopyTo(CurrentRecordProperty[], Int32)
Copies the elements of the collection from a specific array index.
Declaration
public void CopyTo(CurrentRecordProperty[] array, int index)
Parameters
| Type | Name | Description |
|---|---|---|
| CurrentRecordProperty[] | array | The one-dimensional array that is the destination of the elements copied from ArrayList. The array must have zero-based indexing. |
| System.Int32 | index | The zero-based index in array at which copying begins. |
GetEnumerator()
Gets an enumerator that iterates through a collection.
Declaration
public CurrentRecordPropertyCollectionEnumerator GetEnumerator()
Returns
| Type | Description |
|---|---|
| CurrentRecordPropertyCollectionEnumerator | An instance of the CurrentRecordPropertyCollectionEnumerator class. |
Remarks
Enumerators only allow reading of the data in the collection. Enumerators cannot be used to modify the underlying collection.
IndexOf(CurrentRecordProperty)
Determines and gets the index of the specific item in the collection.
Declaration
public int IndexOf(CurrentRecordProperty value)
Parameters
| Type | Name | Description |
|---|---|---|
| CurrentRecordProperty | value | The item to be located in the collection. The value can be a NULL reference (Nothing in Visual Basic). |
Returns
| Type | Description |
|---|---|
| System.Int32 | The index of value if found in the list; Otherwise, -1. |
Explicit Interface Implementations
ICollection.CopyTo(Array, Int32)
Copies the elements of the collection from a specific array index.
Declaration
void ICollection.CopyTo(Array array, int index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Array | array | The single-dimensional array that stores the items. |
| System.Int32 | index | The zero-based array index. |
ICollection.SyncRoot
Gets an object that can be used to synchronize access to the collection.
Declaration
object ICollection.SyncRoot { get; }
Returns
| Type |
|---|
| System.Object |
IEnumerable.GetEnumerator()
Gets an enumerator that iterates through a collection.
Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
| Type | Description |
|---|---|
| System.Collections.IEnumerator | An instance of the System.Collections.IEnumerator class that can be used to iterate through the collection. |
IList.Add(Object)
Adds the item to the collection.
Declaration
int IList.Add(object value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | value | The item to be added in the collection. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The position into which the new element was inserted, or -1 to indicate that the item is not inserted. |
Exceptions
| Type | Condition |
|---|---|
| System.InvalidOperationException | The collection is read-only. |
IList.Clear()
Clears the entire collection.
Declaration
void IList.Clear()
Exceptions
| Type | Condition |
|---|---|
| System.InvalidOperationException | The collection is read-only. |
IList.Contains(Object)
Determines a value indicating whether the specified item is in the collection or not.
Declaration
bool IList.Contains(object value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | value | The object to be checked. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the item is in the collection;Otherwise False. |
IList.get_Item(Int32)
Declaration
object IList.get_Item(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index |
Returns
| Type |
|---|
| System.Object |
IList.IndexOf(Object)
Determines and gets the index of the specific item in the collection.
Declaration
int IList.IndexOf(object value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | value | The item to be located in the collection. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The index of value if found in the list; Otherwise, -1. |
IList.Insert(Int32, Object)
Inserts an item to the collection at the specified index.
Declaration
void IList.Insert(int index, object value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The zero-based index of the item to be added. |
| System.Object | value | The item to be added. |
Exceptions
| Type | Condition |
|---|---|
| System.InvalidOperationException | The collection is read-only. |
IList.Item[Int32]
Gets the element at the specified index.
Declaration
object IList.this[] { get; set; }
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The zero-based index of the element. |
Returns
| Type | Description |
|---|---|
| System.Object | The element at the specified index. |
Exceptions
| Type | Condition |
|---|---|
| System.InvalidOperationException | Since the collection is read-only, if the set operation is performed the exception occurs. |
IList.Remove(Object)
Removes the item from the collection.
Declaration
void IList.Remove(object value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | value | The item to be removed. |
Exceptions
| Type | Condition |
|---|---|
| System.InvalidOperationException | The collection is read-only. |
IList.RemoveAt(Int32)
Removes the collection item at the specific index.
Declaration
void IList.RemoveAt(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The index value |
Exceptions
| Type | Condition |
|---|---|
| System.InvalidOperationException | The collection is read-only. |
IList.set_Item(Int32, Object)
Declaration
void IList.set_Item(int index, object value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | |
| System.Object | value |