RelationName Property

DataRelation.RelationName Property

 

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

Namespace:   System.Data
Assembly:  System.Data (in System.Data.dll)

public virtual string RelationName { get; set; }

Property Value

Type: System.String

The name of the a DataRelation.

Exception Condition
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.

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

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

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft