NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

RelationsCollection.Add (String, DataColumn[], DataColumn[], Boolean)

Creates a relation given the parameters and adds it to the collection. An ArgumentNullException is thrown if this relation is null. An ArgumentException is thrown if this relation already belongs to this collection, belongs to another collection, or if this collection already has a relation with the same name (case insensitive). An InvalidRelationException is thrown if the relation can't be created based on the parameters. The CollectionChanged event is fired if it succeeds.

[Visual Basic]
Overloads Overridable Public Function Add( _
   ByVal name As String, _
   ByVal parentColumns() As DataColumn, _
   ByVal childColumns() As DataColumn, _
   ByVal createConstraints As Boolean _
) As DataRelation
[C#]
public virtual DataRelation Add(
   string name,
   DataColumn[] parentColumns,
   DataColumn[] childColumns,
   bool createConstraints
);
[C++]
public: virtual DataRelation* Add(
   String* name,
   DataColumn* parentColumns[],
   DataColumn* childColumns[],
   bool createConstraints
);
[JScript]
public function Add(
   name : String,
   parentColumns : DataColumn[],
   childColumns : DataColumn[],
   createConstraints : Boolean
) : DataRelation;

Parameters

name
The name of the relation.
parentColumns
parent columns of relation.
childColumns
child columns of relation.
createConstraints
whether to create a constraints

Return Value

The created relation.

See Also

RelationsCollection Class | RelationsCollection Members | System.Data Namespace | RelationsCollection.Add Overload List