Class RelationKeyDescriptor

A RelationKeyDescriptor defines the mapping between parent and child columns in a master details relation. RelationKeyDescriptor are managed by the RelationKeyDescriptorCollection which is returned by the RelationKeys property of a RelationDescriptor.

Inheritance
System.Object
ShouldSerializeBasedPersisterType
DescriptorBase
RelationKeyDescriptor
Implements
System.ComponentModel.ICustomTypeDescriptor
System.IDisposable
System.ICloneable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Syncfusion.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public class RelationKeyDescriptor : DescriptorBase, ICustomTypeDescriptor, IDisposable, ICloneable, IStandardValuesProvider

Constructors

RelationKeyDescriptor()

Initializes a new instance for RelationKeyDescriptor class.

Declaration
public RelationKeyDescriptor()

Properties

ChildKeyField

The FieldDescriptor for the the key column of the child table.

Declaration
public FieldDescriptor ChildKeyField { get; }
Property Value
Type
FieldDescriptor

ChildKeyFieldName

Gets or sets the name of the key column in the child table.

Declaration
public string ChildKeyFieldName { get; set; }
Property Value
Type
System.String

ParentKeyField

Gets the FieldDescriptor for the the key column of the parent table.

Declaration
public FieldDescriptor ParentKeyField { get; }
Property Value
Type
FieldDescriptor

ParentKeyFieldName

The name of the key column in the parent table.

Declaration
public string ParentKeyFieldName { get; set; }
Property Value
Type
System.String

ParentRelationDescriptor

Gets the RelationDescriptor this key descriptor belongs to.

Declaration
public RelationDescriptor ParentRelationDescriptor { get; }
Property Value
Type
RelationDescriptor

Methods

Clone()

Creates a copy of this descriptor.

Declaration
public RelationKeyDescriptor Clone()
Returns
Type Description
RelationKeyDescriptor

A copy of this descriptor.

Dispose(Boolean)

Releases all resources used by the System.ComponentModel.Component.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides
Remarks

See the documentation for the System.ComponentModel.Component class and its Dispose member.

Equals(Object)

Determines if the specified object and current object are equal.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj

An object to compare.
Returns
Type Description
System.Boolean

True if both objects are equal; False otherwise.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Serves as a hash function for a particular type.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

Hash code for the current object type.
Overrides
System.Object.GetHashCode()

GetName()

Gets the key field name.

Declaration
public override string GetName()
Returns
Type Description
System.String

Key field name.
Overrides

InitializeFrom(RelationKeyDescriptor)

Initializes this object and copies properties from another object.

Declaration
public virtual void InitializeFrom(RelationKeyDescriptor other)
Parameters
Type Name Description
RelationKeyDescriptor other

The source object.

ShouldSerializeChildKeyFieldName()

Determines if a key column for the child table was specified.

Declaration
public bool ShouldSerializeChildKeyFieldName()
Returns
Type Description
System.Boolean

True if a key column for the child table was specified; False otherwise.

ShouldSerializeParentKeyFieldName()

Determines if a key column for the parent table was specified.

Declaration
public bool ShouldSerializeParentKeyFieldName()
Returns
Type Description
System.Boolean

True if a key column for the parent table was specified; False otherwise.

ToString()

Returns a string holding the current object.

Declaration
public override string ToString()
Returns
Type Description
System.String

String representation of the current object.
Overrides

Explicit Interface Implementations

IStandardValuesProvider.GetStandardValues(PropertyDescriptor)

Gets the standard values by using property descriptor.

Declaration
ICollection IStandardValuesProvider.GetStandardValues(PropertyDescriptor pd)
Parameters
Type Name Description
System.ComponentModel.PropertyDescriptor pd

An instance of the System.ComponentModel.PropertyDescriptor class.
Returns
Type Description
System.Collections.ICollection

An array of standard values.

ICloneable.Clone()

Creates the copy of this object.

Declaration
object ICloneable.Clone()
Returns
Type Description
System.Object

Returns the copy.

Implements

System.ComponentModel.ICustomTypeDescriptor
System.IDisposable
System.ICloneable