Class
GridViewRelation

Represents a master-detail relation between two GridViewTemplates based on their column or field names.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.GridView.dll

Syntax:

cs-api-definition
public class GridViewRelation : INotifyPropertyChanged, ICloneable, IComparable

Inheritance: objectGridViewRelation

Implements: ICloneableIComparableINotifyPropertyChanged

Constructors

GridViewRelation()

Initializes a new instance of the GridViewRelation class.

Declaration

cs-api-definition
public GridViewRelation()

GridViewRelation(GridViewTemplate)

Initializes a new instance of the GridViewRelation class.

Declaration

cs-api-definition
public GridViewRelation(GridViewTemplate parent)

Parameters

parent

GridViewTemplate

An instance of GridViewTemplate which is parent in the relation.

GridViewRelation(GridViewTemplate, GridViewTemplate)

Initializes a new instance of the GridViewRelation class.

Declaration

cs-api-definition
public GridViewRelation(GridViewTemplate parentTemplate, GridViewTemplate childTemplate)

Parameters

parentTemplate

GridViewTemplate

The parent template.

childTemplate

GridViewTemplate

The child template.

Properties

ChildColumnNames

Gets or sets a StringCollection containing the names of the columns in the datails data source that takes part in the relation.

Declaration

cs-api-definition
public StringCollection ChildColumnNames { get; set; }

Property Value

StringCollection

ChildTemplate

Gets or sets the child GridViewTemplate in the master-detail relation.

Declaration

cs-api-definition
[TypeConverter(typeof(ReferenceConverter))]
public GridViewTemplate ChildTemplate { get; set; }

Property Value

GridViewTemplate

IsObjectRelational

Gets a value indicating whether this instance is object relational.

Declaration

cs-api-definition
[Browsable(false)]
public bool IsObjectRelational { get; }

Property Value

bool

true if this instance is object relational; otherwise, false.

IsSelfReference

Gets a value indicating whether this is self reference relation.

Declaration

cs-api-definition
[Browsable(false)]
public bool IsSelfReference { get; }

Property Value

bool

true if this relation is self reference; otherwise, false.

IsSelfReferenceLoadOnDemand

Gets a value indicating whether this is self reference relation with load on demand.

Declaration

cs-api-definition
[Browsable(false)]
public bool IsSelfReferenceLoadOnDemand { get; }

Property Value

bool

true if this relation is self reference with load on demand; otherwise, false.

IsValid

Gets a value indicating whether this instance is valid.

Declaration

cs-api-definition
[Browsable(false)]
public bool IsValid { get; }

Property Value

bool

true if this instance is valid; otherwise, false.

ParentColumnNames

Gets or sets a StringCollection containing the names of the columns in the master data source that takes part in the relation.

Declaration

cs-api-definition
public StringCollection ParentColumnNames { get; set; }

Property Value

StringCollection

ParentTemplate

Gets or sets the parent GridViewTemplate in the master-detail relation.

Declaration

cs-api-definition
[TypeConverter(typeof(ReferenceConverter))]
public GridViewTemplate ParentTemplate { get; set; }

Property Value

GridViewTemplate

RelationName

Gets or sets the name of the relation.

Declaration

cs-api-definition
public string RelationName { get; set; }

Property Value

string

Methods

CompareTo(object)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Declaration

cs-api-definition
public int CompareTo(object obj)

Parameters

obj

object

An object to compare with this instance.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes obj in the sort order. Zero This instance occurs in the same position in the sort order as obj. Greater than zero This instance follows obj in the sort order.

Exceptions

ArgumentException

obj is not the same type as this instance.

Implements IComparable.CompareTo(object)

CopyTo(GridViewRelation)

Copies to the specific relation.

Declaration

cs-api-definition
public void CopyTo(GridViewRelation relation)

Parameters

relation

GridViewRelation

The relation.

OnPropertyChanged(PropertyChangedEventArgs)

Raises the PropertyChanged event

Declaration

cs-api-definition
protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)

Parameters

e

PropertyChangedEventArgs

A PropertyChangedEventArgs instance containing event data.

Events

PropertyChanged

Declaration

cs-api-definition
public event PropertyChangedEventHandler PropertyChanged

Event Value

PropertyChangedEventHandler

Implements INotifyPropertyChanged.PropertyChanged