DataRelation.RelationName Property

Definition

Namespace:

System.Data

Assembly:

System.Data.Common.dll

Source:

DataRelation.cs

Gets or sets the name used to retrieve a DataRelation from the DataRelationCollection.

public:
 virtual property System::String ^ RelationName { System::String ^ get(); void set(System::String ^ value); };

public virtual string RelationName { get; set; }

member this.RelationName : string with get, set

Public Overridable Property RelationName As String

Property Value

String

The name of the a DataRelation.

Exceptions

ArgumentException

null or empty string ("") was passed into a DataColumn that is a DataRelation.

DuplicateNameException

The DataRelation belongs to a collection that already contains a DataRelation with the same name.

Examples

The following example uses the RelationName property to retrieve a DataRelation from a DataRelationCollection.

Private Sub GetRelation()
    ' Get the collection of a DataSet.
    Dim collection As DataRelationCollection = _
        DataSet1.Relations

    ' Add a relation named CustomerOrders.
    Dim myRel As DataRelation = _
        collection("CustomerOrders")

    ' Print the RelationName.
    Console.WriteLine(myRel.RelationName.ToString())
End Sub

Remarks

Use the RelationName property to retrieve a DataRelation from the DataRelationCollection.

See also

• DataSet
• DataRelationCollection
• Item[Int32]