Class ObjectRelation

Represents a relationship between data objects, providing hierarchical data structure support for data binding scenarios in Telerik WinControls.

Inheritance
System.Object
ObjectRelation
DataSetObjectRelation
SelfReferenceRelation
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls
Assembly: Telerik.WinControls.dll

Syntax

public class ObjectRelation
Remarks

The ObjectRelation class enables the creation of master-detail relationships between different data sources, including DataTable, DataView, BindingSource, and other enumerable collections.

This class is particularly useful in scenarios where you need to establish parent-child relationships between data entities, such as displaying hierarchical data in grid controls or tree structures.

Properties

ChildRelationNames

Declaration
public virtual string[] ChildRelationNames { get; }
Property Value
System.String[]

ChildRelations

Declaration
public ObjectRelationCollecion ChildRelations { get; }
Property Value
ObjectRelationCollecion

List

Declaration
public object List { get; }
Property Value
System.Object

Name

Declaration
public string Name { get; protected set; }
Property Value
System.String

Parent

Gets the parent relation of this object relation in the hierarchical structure.

Declaration
public ObjectRelation Parent { get; protected set; }
Property Value
ObjectRelation

The ObjectRelation that is the parent of this relation, or null if this is a root-level relation.
Remarks

This property enables navigation up the hierarchy in master-detail data scenarios.

ParentRelationNames

Declaration
public virtual string[] ParentRelationNames { get; }
Property Value
System.String[]

Properties

Declaration
public PropertyDescriptorCollection Properties { get; protected set; }
Property Value
System.ComponentModel.PropertyDescriptorCollection

Tag

Gets or sets an object that contains additional data associated with this relation.

Declaration
public object Tag { get; set; }
Property Value
System.Object

An System.Object that contains data to associate with this relation. The default value is null.
Remarks

The Tag property can be used to store any additional information that you want to associate with the object relation. This property is not used internally by the ObjectRelation class.

Methods

GetObjectRelation(Object)

Creates an appropriate ObjectRelation instance based on the type of the specified list.

Declaration
public static ObjectRelation GetObjectRelation(object list)
Parameters
System.Object list

The data source object to create a relation for. Can be a BindingSource, DataTable, DataView, or any other enumerable collection.
Returns
ObjectRelation

An ObjectRelation instance appropriate for the specified data source type. Returns a DataSetObjectRelation for DataTable or DataView objects, otherwise returns a standard ObjectRelation.
Remarks

This factory method automatically determines the most appropriate ObjectRelation type based on the input data source, handling BindingSource unwrapping and DataSet-specific relation creation.

GetObjectRelation(Object, String)

Creates an ObjectRelation instance for a specific data member within a data source.

Declaration
public static ObjectRelation GetObjectRelation(object dataSource, string dataMember)
Parameters
System.Object dataSource

The main data source object containing the data member.
System.String dataMember

The name of the specific data member or table within the data source to create a relation for.
Returns
ObjectRelation

An ObjectRelation instance for the specified data member, or null if the data member cannot be resolved.
Remarks

This factory method is useful for creating relations to specific tables within DataSets or other complex data sources that contain multiple related data entities.

Initialize()

Declaration
protected virtual void Initialize()

Extension Methods