FederationMasterDetailInfo.GetDetailedDescription() Method

Creates a text description of the current relation.

Namespace: DevExpress.DataAccess.DataFederation

Assembly: DevExpress.DataAccess.v23.2.dll

NuGet Packages: DevExpress.DataAccess, DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap

Declaration

C#

public string GetDetailedDescription()

VB.NET

Public Function GetDetailedDescription As String

Returns

Type	Description
String	A String that describes the relation.

Remarks

The code snippet below calls the GetDetailedDescription method to display the following relation information:

Orders master-detailed OrderDetail on OrderDetail.OrderID = Orders.OrderID

C#

var relation = new FederationMasterDetailInfo()
{
    MasterQueryName = "Orders",
    DetailQueryName = "OrderDetail",
    KeyColumns = {
        new FederationRelationColumnInfo(){
            ParentKeyColumn="OrderID",
            NestedKeyColumn ="OrderID",
            ConditionOperator= FederationConditionType.Equal
            }
        }
};
Console.WriteLine(relation.GetDetailedDescription());

VB.NET

Dim relation = New FederationMasterDetailInfo("Orders",
                                    "OrderDetail",
                                    New FederationRelationColumnInfo() With
                                    {.ParentKeyColumn = "OrderID",
                                    .NestedKeyColumn = "OrderID",
                                    .ConditionOperator = FederationConditionType.Equal})
Console.WriteLine(relation.GetDetailedDescription())