Class QueryShowRelationFieldsEventArgs

The Engine.QueryShowRelationFields event affects the auto population of the FieldDescriptorCollection.

It is called for each foreign key relation and lets you control at run-time if the related fields of the child table should be added to the FieldDescriptorCollection. You can set e.Cancel = True to avoid specific fields being added.

Inheritance

System.Object

SyncfusionCancelEventArgs

QueryShowRelationFieldsEventArgs

Inherited Members

SyncfusionCancelEventArgs.ToString()

Namespace: Syncfusion.Grouping

Assembly: Syncfusion.Grouping.Base.dll

Syntax

public sealed class QueryShowRelationFieldsEventArgs : SyncfusionCancelEventArgs

Constructors

QueryShowRelationFieldsEventArgs(TableDescriptor, RelationDescriptor, ShowRelationFields)

Initializes new instance for QueryShowRelationFieldsEventArgs class.

Declaration

public QueryShowRelationFieldsEventArgs(TableDescriptor tableDescriptor, RelationDescriptor relation, ShowRelationFields showRelationFields)

Parameters

Type	Name	Description
TableDescriptor	tableDescriptor
RelationDescriptor	relation
ShowRelationFields	showRelationFields

Properties

Relation

Gets the Relation

Declaration

[TraceProperty(true)]
public RelationDescriptor Relation { get; }

Property Value

Type
RelationDescriptor

ShowRelationFields

Specifies if dependent fields from a related table in a foreign key relation (or related collection) should be added to the main table's FieldDescriptorCollection. You can also control this behavior at run-time with the QueryShowRelationDisplayFields event. Default is ShowRelationFields.ShowDisplayFieldsOnly.

Declaration

[TraceProperty(true)]
public ShowRelationFields ShowRelationFields { get; set; }

Property Value

Type
ShowRelationFields

TableDescriptor

Gets the TableDescriptor

Declaration

[TraceProperty(true)]
public TableDescriptor TableDescriptor { get; }

Property Value

Type
TableDescriptor