DataRelationCollection Class
.NET Framework 4
Represents the collection of DataRelation objects for this DataSet.
Namespace:
System.Data
Assembly: System.Data (in System.Data.dll)
The DataRelationCollection type exposes the following members.
| Name | Description | |
|---|---|---|
|
DataRelationCollection | Initializes a new instance of the DataRelationCollection class. |
| Name | Description | |
|---|---|---|
|
Count | Gets the total number of elements in a collection. (Inherited from InternalDataCollectionBase.) |
|
|
IsReadOnly | Gets a value that indicates whether the InternalDataCollectionBase is read-only. (Inherited from InternalDataCollectionBase.) |
|
|
IsSynchronized | Gets a value that indicates whether the InternalDataCollectionBase is synchonized. (Inherited from InternalDataCollectionBase.) |
|
|
Item[Int32] | Gets the DataRelation object at the specified index. |
|
|
Item[String] | Gets the DataRelation object specified by name. |
|
List | Gets the items of the collection as a list. (Inherited from InternalDataCollectionBase.) |
|
|
SyncRoot | Gets an object that can be used to synchronize the collection. (Inherited from InternalDataCollectionBase.) |
| Name | Description | |
|---|---|---|
|
Add(DataRelation) | Adds a DataRelation to the DataRelationCollection. |
|
|
Add(DataColumn, DataColumn) | Creates a DataRelation with a specified parent and child column, and adds it to the collection. |
|
|
Add(DataColumn[], DataColumn[]) | Creates a DataRelation with the specified parent and child columns, and adds it to the collection. |
|
|
Add(String, DataColumn, DataColumn) | Creates a DataRelation with the specified name, and parent and child columns, and adds it to the collection. |
|
|
Add(String, DataColumn[], DataColumn[]) | Creates a DataRelation with the specified name and arrays of parent and child columns, and adds it to the collection. |
|
|
Add(String, DataColumn, DataColumn, Boolean) | Creates a DataRelation with the specified name, parent and child columns, with optional constraints according to the value of the createConstraints parameter, and adds it to the collection. |
|
|
Add(String, DataColumn[], DataColumn[], Boolean) | Creates a DataRelation with the specified name, arrays of parent and child columns, and value specifying whether to create a constraint, and adds it to the collection. |
|
|
AddCore | Performs verification on the table. |
|
|
AddRange | Copies the elements of the specified DataRelation array to the end of the collection. |
|
|
CanRemove | Verifies whether the specified DataRelation can be removed from the collection. |
|
|
Clear | Clears the collection of any relations. |
|
|
Contains | Verifies whether a DataRelation with the specific name (case insensitive) exists in the collection. |
|
|
CopyTo(Array, Int32) | Copies all the elements of the current InternalDataCollectionBase to a one-dimensional Array, starting at the specified InternalDataCollectionBase index. (Inherited from InternalDataCollectionBase.) |
|
|
CopyTo(DataRelation[], Int32) | Copies the collection of DataRelation objects starting at the specified index. |
|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetDataSet | Infrastructure. This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. |
|
|
GetEnumerator | Gets an IEnumerator for the collection. (Inherited from InternalDataCollectionBase.) |
|
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
|
IndexOf(DataRelation) | Gets the index of the specified DataRelation object. |
|
|
IndexOf(String) | Gets the index of the DataRelation specified by name. |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
OnCollectionChanged | Raises the CollectionChanged event. |
|
|
OnCollectionChanging | Raises the CollectionChanged event. |
|
|
Remove(DataRelation) | Removes the specified relation from the collection. |
|
|
Remove(String) | Removes the relation with the specified name from the collection. |
|
|
RemoveAt | Removes the relation at the specified index from the collection. |
|
|
RemoveCore | Performs a verification on the specified DataRelation object. |
|
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
A DataRelationCollection object enables navigation between related parent/child DataTable objects.
You create a DataRelationCollection object by defining it as a property of either the DataSet or the DataTable, instead of by directly using a constructor. (Use the Relations property of the DataSet, or the ParentRelations property of the DataTable.)
To access the collection, use the Relations property of the DataSet object.
As soon as the collection exists you can manage the objects it contains by using methods such as Add, Clear, and Remove.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
