Class RelationKeyDescriptorCollection

A collection of RelationKeyDescriptor that are children of a RelationDescriptor. A RelationKeyDescriptor defines the mapping between parent and child columns in a master details relation. An instance of this collection is returned by the RelationKeys property of a RelationDescriptor.

Inheritance
System.Object
RelationKeyDescriptorCollection
Implements
System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public class RelationKeyDescriptorCollection : IList, ICollection, IEnumerable

Constructors

RelationKeyDescriptorCollection()

Initializes a new instance for RelationKeyDescriptorCollection collection.

Declaration
public RelationKeyDescriptorCollection()

Properties

Count

Gets the number of elements contained in the collection. 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.

Declaration
public int Count { get; }
Property Value
Type
System.Int32
Remarks

If changes in the RelationDescriptor or TableDescriptor are detected, the method will reinitialize the collection before returning the count.

IsFixedSize

Returns False since this collection has no fixed size.

Declaration
public bool IsFixedSize { get; }
Property Value
Type
System.Boolean

IsReadOnly

Returns False.

Declaration
public bool IsReadOnly { get; }
Property Value
Type
System.Boolean

IsSynchronized

Gets IsSynchronized as False.

Declaration
public bool IsSynchronized { get; }
Property Value
Type
System.Boolean

Item[Int32]

Gets or sets the element at the zero-based index.

Declaration
public RelationKeyDescriptor this[int index] { get; set; }
Parameters
Type Name Description
System.Int32 index
Property Value
Type
RelationKeyDescriptor

Methods

Add(RelationKeyDescriptor)

Adds a RelationKeyDescriptor to the end of the collection.

Declaration
public int Add(RelationKeyDescriptor value)
Parameters
Type Name Description
RelationKeyDescriptor value

The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
Returns
Type Description
System.Int32

The zero-based collection index at which the value has been added.

Add(String, String)

Adds a RelationChildColumnDescriptor to the end of the collection.

Declaration
public int Add(string parentKeyFieldName, string childKeyFieldName)
Parameters
Type Name Description
System.String parentKeyFieldName

The name of the index field in the parent table.
System.String childKeyFieldName

The name of the index field in the child table.
Returns
Type Description
System.Int32

The zero-based collection index at which the value has been added.

AddRange(RelationKeyDescriptor[])

Adds multiple elements at the end of the collection.

Declaration
public void AddRange(RelationKeyDescriptor[] values)
Parameters
Type Name Description
RelationKeyDescriptor[] values

The array whose elements should be added to the end of the collection. The array and its elements cannot be NULL references (Nothing in Visual Basic).

Clear()

Removes all elements from the collection.

Declaration
public void Clear()

Contains(RelationKeyDescriptor)

Determines if the element belongs to this collection.

Declaration
public bool Contains(RelationKeyDescriptor value)
Parameters
Type Name Description
RelationKeyDescriptor value

The Object to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
Returns
Type Description
System.Boolean

True if item is found in the collection; otherwise, False.

CopyTo(RelationKeyDescriptor[], Int32)

Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.

Declaration
public void CopyTo(RelationKeyDescriptor[] array, int index)
Parameters
Type Name Description
RelationKeyDescriptor[] 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.

Dispose()

Disposes of the object and collection items.

Declaration
public void Dispose()

Equals(Object)

Determines if the specified object and current object are equal.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj

An object to compare.
Returns
Type Description
System.Boolean

True if both objects are equal; False otherwise.
Overrides
System.Object.Equals(System.Object)

GetEnumerator()

Returns an enumerator for the entire collection.

Declaration
public RelationKeyDescriptorCollectionEnumerator GetEnumerator()
Returns
Type Description
RelationKeyDescriptorCollectionEnumerator

An Enumerator for the entire collection.
Remarks

Enumerators only allow reading of the data in the collection. Enumerators cannot be used to modify the underlying collection.

GetHashCode()

Serves as a hash function for a particular type.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

Hash code for the current object type.
Overrides
System.Object.GetHashCode()

IndexOf(RelationKeyDescriptor)

Returns the zero-based index of the occurrence of the element in the collection.

Declaration
public int IndexOf(RelationKeyDescriptor value)
Parameters
Type Name Description
RelationKeyDescriptor value

The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
Returns
Type Description
System.Int32

The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.

InitializeFrom(RelationKeyDescriptorCollection)

Copies settings from another collection.

Declaration
public void InitializeFrom(RelationKeyDescriptorCollection other)
Parameters
Type Name Description
RelationKeyDescriptorCollection other

The source collection.

Insert(Int32, RelationKeyDescriptor)

Inserts a descriptor element into the collection at the specified index.

Declaration
public void Insert(int index, RelationKeyDescriptor value)
Parameters
Type Name Description
System.Int32 index

The zero-based index at which the element should be inserted.
RelationKeyDescriptor value

The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).

Remove(RelationKeyDescriptor)

Removes the specified descriptor element from the collection.

Declaration
public void Remove(RelationKeyDescriptor value)
Parameters
Type Name Description
RelationKeyDescriptor value

The element to remove from the collection. If the value is NULL or the element is not contained in the collection, the method will do nothing.

RemoveAt(Int32)

Removes the element at the specified index of the collection.

Declaration
public void RemoveAt(int index)
Parameters
Type Name Description
System.Int32 index

The zero-based index of the element to remove.

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)

Copies the elements of the System.Collections.ICollection to an System.Array, starting at a particular System.Array index.

Declaration
void ICollection.CopyTo(Array array, int index)
Parameters
Type Name Description
System.Array array

The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ICollection. The System.Array must have zero-based indexing.
System.Int32 index

ICollection.SyncRoot

Returns null

Declaration
object ICollection.SyncRoot { get; }
Returns
Type
System.Object

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type Description
System.Collections.IEnumerator

An System.Collections.IEnumerator object that can be used to iterate through the collection.

IList.Add(Object)

Add the specific value to the Collection.

Declaration
int IList.Add(object value)
Parameters
Type Name Description
System.Object value

The object to insert into the System.Collections.IList.
Returns
Type Description
System.Int32

Returns the IList collection.

IList.Contains(Object)

Determines whether the System.Collections.IList contains a specific value.

Declaration
bool IList.Contains(object value)
Parameters
Type Name Description
System.Object value

The object to locate in the System.Collections.IList.
Returns
Type Description
System.Boolean

true if the System.Object is found in the System.Collections.IList; 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 the index of a specific item in the System.Collections.IList.

Declaration
int IList.IndexOf(object value)
Parameters
Type Name Description
System.Object value

The object to locate in the System.Collections.IList.
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 System.Collections.IList at the specified index.

Declaration
void IList.Insert(int index, object value)
Parameters
Type Name Description
System.Int32 index

The zero-based index at which value should be inserted.
System.Object value

The object to insert into the System.Collections.IList.

IList.Item[Int32]

Gets or sets 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 to get or set.
Returns
Type Description
System.Object

The element at the specified index.

IList.Remove(Object)

Removes the first occurrence of a specific object from the System.Collections.IList.

Declaration
void IList.Remove(object value)
Parameters
Type Name Description
System.Object value

The object to remove from the System.Collections.IList.

IList.set_Item(Int32, Object)

Declaration
void IList.set_Item(int index, object value)
Parameters
Type Name Description
System.Int32 index
System.Object value

Implements

System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable

Extension Methods