Syncfusion.Grouping.Base
Members 


Syncfusion.Grouping Namespace : TableDescriptor Class

TableDescriptor Class

Represents the class that maintains schema information for a table. Collections define fields, expressions, sorted, grouped columns, and related tables.
Object Model
TableDescriptor ClassEngine ClassExpressionFieldEvaluator ClassExpressionFieldDescriptorCollection ClassExpressionFieldDescriptor ClassFieldDescriptorCollection ClassFieldDescriptor ClassSortColumnDescriptorCollection ClassSortColumnDescriptor ClassRelationDescriptor ClassTableDescriptor ClassSortColumnDescriptorCollection ClassSortColumnDescriptor ClassRecordFilterDescriptorCollection ClassRecordFilterDescriptor ClassRelationChildColumnDescriptorCollection ClassRelationChildColumnDescriptor ClassRelationDescriptorCollection ClassRelationDescriptor ClassSortColumnDescriptorCollection ClassSortColumnDescriptor ClassSourceListSet ClassSourceListSetEntry ClassSummaryDescriptorCollection ClassSummaryDescriptor ClassUnboundFieldDescriptorCollection ClassFieldDescriptor Class
Syntax
'Declaration
 
<TypeConverterAttribute(Syncfusion.Grouping.DescriptorBaseConverter)>
Public Class TableDescriptor 
   Inherits SourceListDescriptor
   Implements Syncfusion.ComponentModel.IItemPropertiesSource, ITableEventsTarget 
'Usage
 
Dim instance As TableDescriptor
[TypeConverter(Syncfusion.Grouping.DescriptorBaseConverter)]
public class TableDescriptor : SourceListDescriptor, Syncfusion.ComponentModel.IItemPropertiesSource, ITableEventsTarget  
Remarks
TableDescriptor has several collections that can either be auto-populated from the underlying datasource or manually modified.

Collection Descriptions
Fields The Fields collection is auto-populated from the underlying sourcelist's columns. Normally you will not modify this collection and just use it in its default auto-populated state. A fieldDescriptor holds a name, mapping name, and type of the column in the list.
Relations The Relations collection is auto-populated from the underlying sourcelist's relations. It will extract its information from an ADO.NET datasource. If you have other IList collections that are related, you can add RelationDescriptor manually to this collection and specify the primary and foreign key between the two lists.
ExpressionFields The ExpressionFields collection has ExpressionFields. You need to manually add ExpressionFields. This collection is not auto-populated from the datasource. A fieldDescriptor holds a name and the formula expression of the column.
GroupedColumns The GroupedColumns collections contains SortColumnDescriptor objects. It defines the grouping of the table. Each SortColumnDescriptor has a name that identifies a field in the Fields or ExpressionFields collection, a SortDirection property, and a FieldDescriptor property. The FieldDescriptor is Read-only and looked up in the Fields or ExpressionFields collection using the Name of the SortColumnDescriptor. A custom categorizer can be specified that allows you to group records into ranges of data, e.g. if you want to group by month.
Sortedcolumns The Sortedcolumns collection contains SortColumnDescriptor objects. It specifies the sort order of records within a group.
RecordFilters The RecordFilters collection has RecordFilterDescriptor objects. RecordFilters define selection criteria to hide or show records based on criteria.
Summaries The Summaries collection holds SummaryDescriptors. A SummaryDescriptor has a name, a mapping name that identifies the field (Fields or ExpressionFields collection) for which summaries should be calculated for, and a SummaryType property that defines the type of calculations to be performed. Possible SummaryTypes are: Count, BooleanAggregate, ByteAggregate, CharAggregate, DistinctCount, DoubleAggregate, Int32Aggregate, MaxLength, StringAggregate, Vector, DoubleVector, and Custom. When you specify the SummaryType.Custom type, you need to set the custom method through the CreateSummaryMethod property of the SummaryDescriptor. It is of type CreateSummaryDelegate and is called to create a instance of a summary object.

The Field and Relations collections feature auto-population on demand and reflect changes from the collection they depend on. The auto-population will happen when you access the contents of the collection, e.g. if you query its Count.

GroupedColumns and SortedColumns need to be manually initialized. They are not auto-populated.

SortedColumnDescriptor also lets you specify a custom comparer that implements the IComparer interface.

Inheritance Hierarchy
AssemblyVersion

Syncfusion.Grouping.Base: 18.1460.0.52

See Also