DataRow.GetParentRow Method (DataRelation)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the parent row of a DataRow using the specified DataRelation.

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

Public Function GetParentRow (
	relation As DataRelation
) As DataRow

Parameters

relation
Type: System.Data.DataRelation

The DataRelation to use.

Return Value

Type: System.Data.DataRow

The parent DataRow of the current row.

Exception Condition
ArgumentNullException

The relation does not belong to the DataTable.

The row is null.

DataException

A child row has multiple parents.

InvalidConstraintException

This row does not belong to the child table of the DataRelation object.

RowNotInTableException

The row does not belong to a table.

In a DataSet, the collection of all parent DataRelation objects for the data set is returned by the GetParentRows method.

The DataTable also contains a collection of DataRelation objects, returned by the ParentRelations property.

The following example uses the GetParentRow to return the child DataRow objects for every child DataRelation in a DataTable. The value of each column in the row is then printed.

Private Sub GetParentRowForTable _
   (thisTable As DataTable, relation As DataRelation)
    If thisTable Is Nothing Then
        Return
    End If
    ' For each row in the table, print column 1 
    ' of the parent DataRow.
    Dim parentRow As DataRow
    Dim row As DataRow
    For Each row In  thisTable.Rows
        parentRow = row.GetParentRow(relation)
        Console.Write(ControlChars.Tab & " child row: " _
           & row(1).ToString())
        Console.Write(ControlChars.Tab & " parent row: " _
           & parentRow(1).ToString() & ControlChars.Cr)
    Next row
End Sub

Private Sub CallGetParentRowForTable()
    ' An example of calling the function.
    Dim thisTable As DataTable = DataSet1.Tables("Products")
    Dim relation As DataRelation = thisTable.ParentRelations(0)
    GetParentRowForTable(thisTable, relation)
End Sub

.NET Framework
Available since 1.1
Return to top
Show: