Class RelationChildColumnDescriptorCollection
A collection from RelationChildColumnDescriptor that are children of a TableDescriptor. A RelationChildColumnDescriptor defines the sort order of a related table which is defined by the child columns in a a master details relation.
An instance of this collection is returned by the RelationChildColumns property of a TableDescriptor.
Implements
Inherited Members
Namespace: Syncfusion.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public class RelationChildColumnDescriptorCollection : SortColumnDescriptorCollection, IDisposable, IList, ICollection, IEnumerable, IInsideCollectionEditorProperty, ICloneable, ICustomTypeDescriptorFields
Empty
A Read-only and empty collection.
Declaration
public static readonly RelationChildColumnDescriptorCollection EmptyField Value
| Type |
|---|
| RelationChildColumnDescriptorCollection |
Properties
Item[Int32]
Gets or sets the element at the zero-based index.
Declaration
public RelationChildColumnDescriptor this[int index] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index |
Property Value
| Type |
|---|
| RelationChildColumnDescriptor |
Item[String]
Gets or sets the element with the specified name.
Declaration
public RelationChildColumnDescriptor this[string name] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name |
Property Value
| Type |
|---|
| RelationChildColumnDescriptor |
Methods
Add(String, String)
Adds a RelationChildColumnDescriptor to the end of the collection.
Declaration
public int Add(string parentColumnName, string childColumnName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | parentColumnName | The name of the index field in the parent table. |
| System.String | childColumnName | 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(RelationChildColumnDescriptor[])
Adds multiple elements at the end of the collection.
Declaration
public void AddRange(RelationChildColumnDescriptor[] columnDescriptors)Parameters
| Type | Name | Description |
|---|---|---|
| RelationChildColumnDescriptor[] | columnDescriptors | 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). |
CheckOutOfDate()
Called internally to ensure all field descriptors are up to date after table descriptor is changed.
Declaration
protected override bool CheckOutOfDate()Returns
| Type | Description |
|---|---|
| System.Boolean | True if field descriptors need to be reinitialized |
Overrides
CheckType(Object)
Checks the type of object.
Declaration
protected override void CheckType(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj | The Object. |
Overrides
Clone()
Creates a copy of the collection and all its elements.
Declaration
public RelationChildColumnDescriptorCollection Clone()Returns
| Type | Description |
|---|---|
| RelationChildColumnDescriptorCollection | A copy of the collection and all its elements. |
Equals(Object)
Determines if the specified object is equivalent to the current object.
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
GetEnumerator()
Returns an enumerator for the entire collection.
Declaration
public RelationChildColumnDescriptorCollectionEnumerator GetEnumerator()Returns
| Type | Description |
|---|---|
| RelationChildColumnDescriptorCollectionEnumerator | An Enumerator for the entire collection. |
Remarks
Enumerators only allow reading the data in the collection. Enumerators cannot be used to modify the underlying collection.
GetHashCode()
Serves as a hash function.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 | Hash code. |
Overrides
InitializeFrom(RelationKeyDescriptorCollection)
Copies settings from another collection and raises Changing and Changed events if differences to the other collections are detected.
Declaration
public void InitializeFrom(RelationKeyDescriptorCollection other)Parameters
| Type | Name | Description |
|---|---|---|
| RelationKeyDescriptorCollection | other | The source collection. |
InitializeFrom(RelationKeyDescriptorCollection, Boolean)
Copies settings from another collection and raises Changing and Changed events if differences to the other collections are detected.
Declaration
public bool InitializeFrom(RelationKeyDescriptorCollection other, bool raiseChangeEvents)Parameters
| Type | Name | Description |
|---|---|---|
| RelationKeyDescriptorCollection | other | The source collection. |
| System.Boolean | raiseChangeEvents | Specifies if Changing and Changed events should be raised. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the operation is successfully completed. |