DataRelation.RelationName Property

Reference

Definition

Namespace:: System.Data

Assembly:: System.Data.Common.dll

Assembly:: System.Data.dll

Assembly:: netstandard.dll

Source:: DataRelation.cs

Source:: DataRelation.cs

Source:: DataRelation.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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; }

[System.Data.DataSysDescription("DataRelationRelationNameDescr")]
public virtual string RelationName { get; set; }

member this.RelationName : string with get, set

[<System.Data.DataSysDescription("DataRelationRelationNameDescr")>]
member this.RelationName : string with get, set

Public Overridable Property RelationName As String

Property Value

String

The name of the a DataRelation.

Attributes: DataSysDescriptionAttribute

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.

Applies to

Jaa