Class RelationChildColumnDescriptor
A RelationChildColumnDescriptor defines the sort order of a related table which is defined by the child columns in a a master details relation.
RelationChildColumnDescriptorare managed by the RelationChildColumnDescriptorCollection that is returned by the RelationChildColumns property of a TableDescriptor.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public class RelationChildColumnDescriptor : SortColumnDescriptor, ICustomTypeDescriptor, IDisposable, ICloneable, IStandardValuesProviderConstructors
RelationChildColumnDescriptor()
Initializes a new empty instance for RelationChildColumnDescriptor descriptor class.
Declaration
public RelationChildColumnDescriptor()RelationChildColumnDescriptor(String, String)
Initializes a new empty instance for RelationChildColumnDescriptor descriptor with parent and child column names identifying the fields that establish the relation between two tables.
Declaration
public RelationChildColumnDescriptor(string parentColumnName, string childColumnName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | parentColumnName | Parent column name. |
| System.String | childColumnName | Child column name. |
Properties
Collection
Gets the collection this descriptor belongs to.
Declaration
public RelationChildColumnDescriptorCollection Collection { get; }Property Value
| Type |
|---|
| RelationChildColumnDescriptorCollection |
ParentColumnName
Gets or sets the field name of the column in the parent table that establishes the relation between the two tables.
Declaration
public string ParentColumnName { get; set; }Property Value
| Type |
|---|
| System.String |
ParentFieldDescriptor
The FieldDescriptor for the ParentColumnName.
Declaration
public FieldDescriptor ParentFieldDescriptor { get; }Property Value
| Type |
|---|
| FieldDescriptor |
Methods
Clone()
Creates a copy of this descriptor.
Declaration
public RelationChildColumnDescriptor Clone()Returns
| Type | Description |
|---|---|
| RelationChildColumnDescriptor | A copy of this descriptor. |
Equals(Object)
Determines if the specified object is equivalent to the current object.
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj | The object to compare. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if both objects are equal; False otherwise. |
Overrides
GetHashCode()
Serves as a hash function.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 | Hash code. |
Overrides
InitFieldDescriptor(TableDescriptor)
Initializes a field descriptor.
Declaration
public override bool InitFieldDescriptor(TableDescriptor tableDescriptor)Parameters
| Type | Name | Description |
|---|---|---|
| TableDescriptor | tableDescriptor | Table descriptor. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the field descriptor is initialized successfully. |
Overrides
InitializeFrom(SortColumnDescriptor)
Initializes this object and copies properties from another object.
Declaration
public override void InitializeFrom(SortColumnDescriptor other)Parameters
| Type | Name | Description |
|---|---|---|
| SortColumnDescriptor | other | The source object. |