Class GridTable

Manages all the records from the underlying source list. The source list can be any IList collection. If it implements IBindingList, the GridTable will listen to the ListChangedEvent and update its internal data whenever changes are made to the source list.

Inheritance

System.Object

Element

Table

GridTableBase

GridTable

Implements

ITreeTableCounterSource

ITreeTableSummaryArraySource

System.IDisposable

IGridTableOptionsSource

IGridTableCellAppearanceSource

Inherited Members

Element.ChildTableGroupLevel

Element.Dispose()

Element.Disposed

Element.Disposing

Element.EnsureInitialized(Object)

Element.GetCaptionSection()

Element.GetCaptionSection(Element)

Element.GetChildCount()

Element.GetColumnHeaderSection()

Element.GetColumnHeaderSection(Element)

Element.GetCounter()

Element.GetCustomCount()

Element.GetCustomPosition()

Element.GetData()

Element.GetFilterBar()

Element.GetFilterBar(Element)

Element.GetRecord()

Element.GetRecord(Element)

Element.GetSummaries(Table)

Element.GetVisibleCustomCount()

Element.GetVisibleCustomPosition()

Element.GetVisibleInHierarchy()

Element.GetVisibleInParent()

Element.GroupLevel

Element.Id

Element.InDisposed

Element.Info

Element.InvalidateCounter()

Element.InvalidateCounterBottomUp()

Element.IsCaption()

Element.IsCaption(Element)

Element.IsChildVisible(Element)

Element.IsColumnHeader()

Element.IsColumnHeader(Element)

Element.IsDisposed

Element.IsFilterBar()

Element.IsFilterBar(Element)

Element.IsRecord()

Element.IsRecord(Element)

Element.ITreeTableSummaryArraySource.GetSummaries(ITreeTableEmptySummaryArraySource, Boolean)

Element.OnBeginEditCalled()

Element.OnBeginEditComplete(Boolean)

Element.OnCancelEditCalled()

Element.OnCancelEditComplete(Boolean)

Element.OnDisposed(EventArgs)

Element.OnElementTreeInvalidateCounterBottomUp()

Element.OnEndEditCalled()

Element.OnEndEditComplete(Boolean)

Element.OnEnterRecordCalled()

Element.OnEnterRecordComplete(Boolean)

Element.OnLeaveRecordCalled()

Element.OnLeaveRecordComplete(Boolean)

Element.ParentChildTable

Element.ParentDisplayElement

Element.ParentElement

Element.ParentGroup

Element.ParentSection

Element.Reserved1

Element.Reserved10

Element.Reserved11

Element.Reserved16a

Element.Reserved16b

Element.Reserved16c

Element.Reserved2

Element.Reserved3

Element.Reserved4

Element.Reserved5

Element.Reserved6

Element.Reserved7

Element.Reserved8

Element.Reserved9

Element.SupportsId()

Element.TableLevel

GridTableBase.BindingContext

GridTableBase.BindingContextChanged

GridTableBase.bindingList_ListChanged(Object, ListChangedEventArgs)

GridTableBase.dt_RowDeleting(Object, DataRowChangeEventArgs)

GridTableBase.GetCurrencyManager()

GridTableBase.OnBindingContextChanged(EventArgs)

GridTableBase.OnSourceListListChanged(TableListChangedEventArgs)

GridTableBase.ResetCurrencyManager()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Table.AddChangedField(ChangedFieldInfo)

Table.AddChildTable()

Table.AddChildTableIfNotExists(Object[])

Table.AddedRelatedTable

Table.AddNew()

Table.AddNewRecord

Table.AllowThreading

Table.BeginEdit()

Table.CancelEdit()

Table.CategorizedRecords

Table.CategorizeElementsVersion

Table.CategorizingRecords

Table.ChangedFieldsArray

Table.ClearCollectionCaches()

Table.CollapseAllGroups()

Table.CollapseAllRecords()

Table.CompareColumnSortOrder(Record, Record, Record, SortColumnDescriptor)

Table.CompareGroupCategories(Group, Record)

Table.CountersDirty

Table.CurrentElement

Table.CurrentRecord

Table.CurrentRecordContextChange

Table.CurrentRecordManager

Table.CurrentRecordManagerReset

Table.DefaultYAmountChanged

Table.DeleteEmptyGroups(DetailsSection, Group)

Table.DeleteRecord(Record)

Table.DisplayElementChanged

Table.DisplayElementChanging

Table.DisplayElements

Table.Elements

Table.EndEdit()

Table.EndIndex

Table.EngineVersion

Table.EnsureInitialized(Object, Boolean)

Table.ExceptionRaised

Table.ExpandAllGroups()

Table.ExpandAllRecords()

Table.FilteredChildTable

Table.FilteredChildTableOrTopLevelGroup

Table.FilteredRecords

Table.GetChangedFields()

Table.GetDependantFields(Int32)

Table.GetElementCount()

Table.GetEmptySummaries()

Table.GetFilteredRecordCount()

Table.GetInnerMostCurrentElement()

Table.GetRecordCount()

Table.GetRecordOrParentRecord(Element)

Table.GetSummaries()

Table.GetSummaries(Table, Boolean)

Table.GetValue(Object, PropertyDescriptor)

Table.GetVisibleCount()

Table.GetYAmountCount()

Table.GroupAdded

Table.GroupCollapsed

Table.GroupCollapsing

Table.GroupExpanded

Table.GroupExpanding

Table.GroupRemoving

Table.GroupSummaryInvalidated

Table.HasColumnChangeListener

Table.HasCurrentElement

Table.HasCurrentRecord

Table.HasSourceList

Table.InInitialize

Table.InSetSourceList

Table.InSourceListChanged

Table.InSourceListListChangedHandler

Table.InvalidateCounters(Element)

Table.InvalidateCountersAndSummaries(Element, Boolean)

Table.InvalidateCounterTopDown(Boolean)

Table.InvalidateSummaries(Element, Boolean)

Table.InvalidateSummariesBottomUp()

Table.InvalidateSummariesTopDown()

Table.InvalidateSummary()

Table.InvalidatingCounters

Table.InvalidatingSummaries

Table.IsCurrentRecord(Int32)

Table.IsPassThroughGrouping

Table.IsSameGroup(Group, Element)

Table.IsSameRecord(Record, Int32)

Table.IsSorting

Table.LastChangedRecord

Table.NavigateCurrentRecordDown(Int32)

Table.NavigateCurrentRecordUp(Int32)

Table.NestedDisplayElements

Table.NestedElements

Table.OnCategorizingRecords(TableEventArgs)

Table.OnCurrentRecordManagerReset(TableEventArgs)

Table.OnDefaultYAmountChanged(EventArgs)

Table.OnDisplayElementChanged(DisplayElementChangedEventArgs)

Table.OnDisplayElementChanging(DisplayElementChangingEventArgs)

Table.OnEnsureInitialized(Object)

Table.OnExceptionRaised(ExceptionRaisedEventArgs)

Table.OnGroupAdded(GroupEventArgs)

Table.OnGroupCollapsed(GroupEventArgs)

Table.OnGroupCollapsing(GroupEventArgs)

Table.OnGroupExpanded(GroupEventArgs)

Table.OnGroupExpanding(GroupEventArgs)

Table.OnGroupRemoving(GroupEventArgs)

Table.OnInvalidatingCounters(TableEventArgs)

Table.OnInvalidatingSummaries(TableEventArgs)

Table.OnPrepareItemAdded(Object)

Table.OnQueryCustomCount(CustomCountEventArgs)

Table.OnQueryVisibleCustomCount(CustomCountEventArgs)

Table.OnRecordChanged(Element, Boolean, Boolean)

Table.OnRecordCollapsed(RecordEventArgs)

Table.OnRecordCollapsing(RecordEventArgs)

Table.OnRecordDeleted(RecordEventArgs)

Table.OnRecordDeleting(RecordEventArgs)

Table.OnRecordExpanded(RecordEventArgs)

Table.OnRecordExpanding(RecordEventArgs)

Table.OnRecordValueChanged(RecordValueChangedEventArgs)

Table.OnRecordValueChanging(RecordValueChangingEventArgs)

Table.OnSelectedRecordsChanged(SelectedRecordsChangedEventArgs)

Table.OnSelectedRecordsChanging(SelectedRecordsChangedEventArgs)

Table.OnSortedItemsInGroup(GroupEventArgs)

Table.OnSortingItemsInGroup(GroupEventArgs)

Table.OnSourceListItemAdded(Object, ListChangedEventArgs, TableListChangedEventArgs)

Table.OnSourceListItemDeleted(Object, ListChangedEventArgs, TableListChangedEventArgs)

Table.OnSourceListItemMoved(Object, ListChangedEventArgs, TableListChangedEventArgs)

Table.OnSourceListListChangedCompleted(TableListChangedEventArgs)

Table.OnSourceListPropertyDescriptorChanged(Object, ListChangedEventArgs, TableListChangedEventArgs)

Table.OnSourceListRecordChanged(RecordChangedEventArgs)

Table.OnSourceListRecordChanging(RecordChangedEventArgs)

Table.OriginalSourceList

Table.PassThroughGroupingResult

Table.PopulatePassThroughGroup(Group, IEnumerable, Record)

Table.PopulatePassThroughGroupIfEmpty(Group)

Table.PopulateRecordChildTablesIfEmpty(Record)

Table.PrimaryKeySortedRecords

Table.QueryCustomCount

Table.QueryVisibleCustomCount

Table.RaiseDefaultYAmountChanged()

Table.RaiseDisplayElementChanged(Element, Int32, Int32, Boolean, Boolean, Boolean)

Table.RaiseDisplayElementChanged(Element, Int32, Int32, Boolean, Boolean, Boolean, Boolean)

Table.RaiseDisplayElementChanging(Element, Int32, Int32, Boolean, Boolean, Boolean)

Table.RaiseDisplayElementChanging(Element, Int32, Int32, Boolean, Boolean, Boolean, Boolean)

Table.RaiseRecordValueChanged(RecordValueChangedEventArgs)

Table.RaiseRecordValueChanging(RecordValueChangingEventArgs)

Table.RecordCollapsed

Table.RecordCollapsing

Table.RecordDeleted

Table.RecordDeleting

Table.RecordExpanded

Table.RecordExpanding

Table.Records

Table.RecordsAsDisplayElements

Table.RecordValueChanged

Table.RecordValueChanging

Table.RelatedTables

Table.Reload()

Table.RemovingRelatedTable

Table.ResetCurrentRecord()

Table.SelectedRecords

Table.SelectedRecordsChanged

Table.SelectedRecordsChanging

Table.SettingTableDirty

Table.ShouldCacheRecordData()

Table.ShowRecord(Element, Boolean)

Table.ShowRecord(Record, Boolean)

Table.SimulateListChanged(ListChangedEventArgs)

Table.SimulateListChangedWithSourceList(IList, Group, ListChangedEventArgs)

Table.SortedItemsInGroup

Table.SortingItemsInGroup

Table.SourceList

Table.SourceListAllowEdit

Table.SourceListAllowNew

Table.SourceListAllowRemove

Table.SourceListChanged

Table.SourceListListChanged

Table.SourceListListChangedCompleted

Table.SourceListRecordChanged

Table.SourceListRecordChanging

Table.SourceListVersion

Table.StartIndex

Table.SummariesDirty

Table.TableDirty

Table.TableDirtyOnItemChanged

Table.TableEventsTarget

Table.TableNo

Table.TopLevelGroup

Table.ToString()

Table.UnsortedRecords

Table.UnwireList()

Table.VirtualMode

Table.WireList()

Table.WithoutCounter

Namespace: Syncfusion.Windows.Forms.Grid.Grouping

Assembly: Syncfusion.Grid.Grouping.Windows.dll

Syntax

public class GridTable : GridTableBase, IDisposedEvent, IIsDisposedProperty, ITreeTableCounterSource, ITreeTableSummaryArraySource, IContainerElement, IElementTreeTableSource, IElement, IDisposable, IGridTableOptionsSource, IGridTableCellAppearanceSource

Remarks

See the GridTableBase class for more details overview about this class.

Constructors

GridTable(GridTableDescriptor, GridTable)

Initializes a new instance of the GridTable class this object that belongs to a GridTableDescriptor and optionally belongs to a parent table.

Declaration

public GridTable(GridTableDescriptor tableDescriptor, GridTable relationParentTable)

Parameters

Type	Name	Description
GridTableDescriptor	tableDescriptor	The table descriptor with schema information about the table.
GridTable	relationParentTable	The parent table of this table; NULL if this table is not a child table of a relation.

Fields

CurrentRecordContextChangeTarget

Occurs before and after the status of the current record was changed. Check the Action of the CurrentRecordContextChangeEventArgs to get information on which current record state was changed.

Declaration

public CurrentRecordContextChangeEventHandler CurrentRecordContextChangeTarget

Field Value

Type
CurrentRecordContextChangeEventHandler

Properties

Appearance

Gets or sets the default GridTableCellAppearance with GridTableCellStyleInfo information for cells of this element.

Declaration

public GridTableCellAppearance Appearance { get; set; }

Property Value

Type
GridTableCellAppearance

DefaultCaptionRowHeight

Gets or sets the default height of group caption rows.

Declaration

public override int DefaultCaptionRowHeight { get; set; }

Property Value

Type
System.Int32

Overrides

Table.DefaultCaptionRowHeight

DefaultColumnHeaderRowHeight

Gets or seets the default height of column header rows.

Declaration

public override int DefaultColumnHeaderRowHeight { get; set; }

Property Value

Type
System.Int32

Overrides

Table.DefaultColumnHeaderRowHeight

DefaultEmptySectionHeight

Gets or sets the default height of empty section rows.

Declaration

public override int DefaultEmptySectionHeight { get; set; }

Property Value

Type
System.Int32

Overrides

Table.DefaultEmptySectionHeight

DefaultFilterBarRowHeight

Gets or sets the default height of filter bar rows.

Declaration

public override int DefaultFilterBarRowHeight { get; set; }

Property Value

Type
System.Int32

Overrides

Table.DefaultFilterBarRowHeight

DefaultGroupFooterSectionHeight

Gets or sets the default height of group footer sections.

Declaration

public override int DefaultGroupFooterSectionHeight { get; set; }

Property Value

Type
System.Int32

Overrides

Table.DefaultGroupFooterSectionHeight

DefaultGroupHeaderSectionHeight

Gets or sets the default height of group header sections.

Declaration

public override int DefaultGroupHeaderSectionHeight { get; set; }

Property Value

Type
System.Int32

Overrides

Table.DefaultGroupHeaderSectionHeight

DefaultGroupPreviewSectionHeight

Gets or sets the default height of group preview rows.

Declaration

public override int DefaultGroupPreviewSectionHeight { get; set; }

Property Value

Type
System.Int32

Overrides

Table.DefaultGroupPreviewSectionHeight

DefaultIndentWidth

Gets or sets the default width of group indents.

Declaration

public override int DefaultIndentWidth { get; set; }

Property Value

Type
System.Int32

Overrides

Table.DefaultIndentWidth

DefaultRecordPreviewRowHeight

Gets or sets the default height of record preview rows.

Declaration

public override int DefaultRecordPreviewRowHeight { get; set; }

Property Value

Type
System.Int32

Overrides

Table.DefaultRecordPreviewRowHeight

DefaultRecordRowHeight

Gets or sets the default height of record rows.

Declaration

public override int DefaultRecordRowHeight { get; set; }

Property Value

Type
System.Int32

Overrides

Table.DefaultRecordRowHeight

DefaultRowHeaderWidth

Gets or sets the default width of row headers.

Declaration

public override int DefaultRowHeaderWidth { get; set; }

Property Value

Type
System.Int32

Overrides

Table.DefaultRowHeaderWidth

DefaultSummaryRowHeight

Gets or sets the default height of summary rows.

Declaration

public override int DefaultSummaryRowHeight { get; set; }

Property Value

Type
System.Int32

Overrides

Table.DefaultSummaryRowHeight

DefaultTableIndentWidth

Gets or sets the default width of table indents.

Declaration

public override int DefaultTableIndentWidth { get; set; }

Property Value

Type
System.Int32

Overrides

Table.DefaultTableIndentWidth

Engine

Gets the engine this element belongs to.

Declaration

public GridEngine Engine { get; }

Property Value

Type
GridEngine

EngineTable

Gets the GridTable of the engine this element belongs to.

Declaration

public GridTable EngineTable { get; }

Property Value

Type
GridTable

Kind

Gets the kind of display element.

Declaration

public override DisplayElementKind Kind { get; }

Property Value

Type
DisplayElementKind

Overrides

Element.Kind

LastColumnWidth

Gets the column width of the last column. The last column in the grid is used to fill empty space after the last record field. This is needed for hierarchical display, when a nested table is wider than the current table.

Declaration

public int LastColumnWidth { get; }

Property Value

Type
System.Int32

ParentRecord

Gets a reference to the parent record this element belongs to.

Declaration

public GridRecord ParentRecord { get; }

Property Value

Type
GridRecord

ParentTable

Gets or sets a reference to the parent table this section belongs to.

Declaration

public GridTable ParentTable { get; set; }

Property Value

Type
GridTable

ParentTableDescriptor

Gets the table descriptor this element belongs to.

Declaration

public GridTableDescriptor ParentTableDescriptor { get; }

Property Value

Type
GridTableDescriptor

ReadOnlyAppearance

Gets the appearance of this element, If this element is modified; otherwise it returns a GridTableCellAppearance of the first parent element with appearance in the hierarchy.

Declaration

public GridTableCellAppearance ReadOnlyAppearance { get; }

Property Value

Type
GridTableCellAppearance

RelationParentTable

Gets the parent table of this table or NULL if this table is not a child table of a relation.

Declaration

public GridTable RelationParentTable { get; }

Property Value

Type
GridTable

TableDescriptor

Gets the table descriptor.

Declaration

public GridTableDescriptor TableDescriptor { get; }

Property Value

Type
GridTableDescriptor

TableModel

Gets or sets the GridTableModel that is used to display this table in a grid.

Declaration

public GridTableModel TableModel { get; set; }

Property Value

Type
GridTableModel

TableOptions

Gets or sets the table-wide properties like the width of the indent column, or whether header rows should be visible.

Declaration

public GridTableOptionsStyleInfo TableOptions { get; set; }

Property Value

Type
GridTableOptionsStyleInfo

Methods

AddElementToRepaintQueue(Element)

Used internally.

Declaration

public void AddElementToRepaintQueue(Element element)

Parameters

Type	Name	Description
Element	element

CreateTableCellStyle(GridTableCellStyleInfoIdentity)

Create a GridTableCellStyleInfo and fills in values based on the given GridTableCellStyleInfoIdentity. Call this method if you want to manually setup the GridTableCellStyleInfoIdentity with its TableCellType and other cell-specific information and then fill its cell value, format etc. The cell does not have to be visible in the grid.

Declaration

public GridTableCellStyleInfo CreateTableCellStyle(GridTableCellStyleInfoIdentity tableCellIdentity)

Parameters

Type	Name	Description
GridTableCellStyleInfoIdentity	tableCellIdentity	The GridTableCellStyleInfoIdentity

Returns

Type	Description
GridTableCellStyleInfo	A GridTableCellStyleInfo.

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

Overrides

GridTableBase.Dispose(Boolean)

Engine_PropertyChanged(Object, DescriptorPropertyChangedEventArgs)

Declaration

protected override void Engine_PropertyChanged(object sender, DescriptorPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender
DescriptorPropertyChangedEventArgs	e

Overrides

Syncfusion.Grouping.Table.Engine_PropertyChanged(System.Object, Syncfusion.Grouping.DescriptorPropertyChangedEventArgs)

GetBaseAppearance()

Returns a GridTableCellAppearance of the first parent element with appearance in the hierarchy.

Declaration

public GridTableCellAppearance GetBaseAppearance()

Returns

Type	Description
GridTableCellAppearance	A GridTableCellAppearance.

GetColumnDescriptorAt(Element, Int32)

Returns the record field cell's GridColumnDescriptor at the specified display element and column.

Declaration

public GridColumnDescriptor GetColumnDescriptorAt(Element element, int colIndex)

Parameters

Type	Name	Description
Element	element	The Element.
System.Int32	colIndex	Column index.

Returns

Type	Description
GridColumnDescriptor	The column descriptor.

GetColumnDescriptorAt(GridRangeInfo)

Returns the record field cell's GridColumnDescriptor at the specified grid row and column.

Declaration

public GridColumnDescriptor GetColumnDescriptorAt(GridRangeInfo cell)

Parameters

Type	Name	Description
GridRangeInfo	cell	Record field cell.

Returns

Type	Description
GridColumnDescriptor	The column descriptor.

GetColumnDescriptorAt(Int32, Int32)

Returns the record field cell's GridColumnDescriptor at the specified grid row and column.

Declaration

public GridColumnDescriptor GetColumnDescriptorAt(int rowIndex, int colIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex	Row index.
System.Int32	colIndex	Column index.

Returns

Type	Description
GridColumnDescriptor	The column descriptor.

GetColumnMaxLength(GridColumnDescriptor)

Returns the calculated maximum length in characters for the specified column. The length is taken from a previous call to OnInitializeColumnsMaxLengthFirstNRecords or from a MaxLengthSummary that automatically tracks changes to fields in the column.

Declaration

public int GetColumnMaxLength(GridColumnDescriptor column)

Parameters

Type	Name	Description
GridColumnDescriptor	column	The Column.

Returns

Type	Description
System.Int32	Maximum length of the column.

GetColumnMaxLength(GridColumnDescriptor, FieldDescriptor)

Returns the calculated maximum length in characters for the specified field. The length is taken from a previous call to OnInitializeColumnsMaxLengthFirstNRecords or from a MaxLengthSummary that automatically tracks changes to fields in the column.

Declaration

public virtual int GetColumnMaxLength(GridColumnDescriptor column, FieldDescriptor rfield)

Parameters

Type	Name	Description
GridColumnDescriptor	column	The column.
FieldDescriptor	rfield	The FieldDescriptor provides the mapping information to a column.

Returns

Type	Description
System.Int32	Maximum length of the column.

GetColumnsNRowsMaxLength(String)

Returns the maximum length for the given field name in the first n records of the data source. n is defined by TableOptions.ColumnsMaxLengthFirstNRecords property.

Declaration

public int GetColumnsNRowsMaxLength(string fieldName)

Parameters

Type	Name	Description
System.String	fieldName	Field name.

Returns

Type	Description
System.Int32	Maximum length of the field.

GetCoveredRange(Int32, Int32)

Determines if the cell belongs to a covered range and returns the covered range of the cell or the cell itself as GridRangeInfo if it is not a covered range.

Declaration

public GridRangeInfo GetCoveredRange(int rowIndex, int colIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex	The row index of the cell.
System.Int32	colIndex	The column index of the cell.

Returns

Type	Description
GridRangeInfo	Returns the covered range the cell belongs; if cell is not part of a covered range the cell itself is returned as GridRangeInfo.

GetElementRangeInfo(Element)

Returns the GridRangeInfo with the range of cells that an element spans.

Declaration

public GridRangeInfo GetElementRangeInfo(Element e)

Parameters

Type	Name	Description
Element	e	The element.

Returns

Type	Description
GridRangeInfo	The GridRangeInfo with the range of cells that an element spans.

GetHeaderColumnDescriptorAt(GridRangeInfo)

Returns the header column's GridColumnDescriptor at the specified grid row and column.

Declaration

public GridColumnDescriptor GetHeaderColumnDescriptorAt(GridRangeInfo cell)

Parameters

Type	Name	Description
GridRangeInfo	cell	The GridRangeInfo.

Returns

Type	Description
GridColumnDescriptor	The header column descriptor.

GetHeaderColumnDescriptorAt(Int32)

Returns the header column's GridColumnDescriptor for the specified grid column in the first row of the GridColumnHeaderSection or NULL if no GridColumnHeaderSection is found or the grid column is not a column header.

Declaration

public GridColumnDescriptor GetHeaderColumnDescriptorAt(int colIndex)

Parameters

Type	Name	Description
System.Int32	colIndex	Column index.

Returns

Type	Description
GridColumnDescriptor	The header column descriptor.

GetHeaderColumnDescriptorAt(Int32, Int32)

Returns the header columns GridColumnDescriptor at the specified grid row and column or NULL if the specified row is not a ColumnHeaderRow or the grid column is not a column header.

Declaration

public GridColumnDescriptor GetHeaderColumnDescriptorAt(int rowIndex, int colIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex	Row index.
System.Int32	colIndex	Column index.

Returns

Type	Description
GridColumnDescriptor	The header column descriptor.

GetInvokeRequiredControl()

Determines if the current thread is the same UI thread as the parent control or if the current method call should be marshaled.

Declaration

protected override Control GetInvokeRequiredControl()

Returns

Type	Description
System.Windows.Forms.Control	A control that can be used to marshal the current method by calling its Invoke method.

Overrides

GridTableBase.GetInvokeRequiredControl()

GetMaxLengthSampleRecords()

Returns list of sample records.

Declaration

protected virtual IList GetMaxLengthSampleRecords()

Returns

Type	Description
System.Collections.IList	list

GetNestedTableCellType(NestedTable)

Returns the cell type name for a NestedTable based on its TableDescriptor name. The returned name is "RT" + relatedTable.TableDescriptor.Name.

Declaration

public string GetNestedTableCellType(NestedTable nestedTable)

Parameters

Type	Name	Description
NestedTable	nestedTable	The nested table.

Returns

Type	Description
System.String	The cell type name.

GetPreferredColumnWidth(Graphics, GridColumnDescriptor)

Returns the preferred column width in pixels for the specified column taking the length of the column header text and the value returned by GetColumnMaxLength into consideration.

Declaration

public int GetPreferredColumnWidth(Graphics g, GridColumnDescriptor column)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics context.
GridColumnDescriptor	column	The Column.

Returns

Type	Description
System.Int32	Preferred column width.

GetPreferredColumnWidth(Graphics, GridColumnDescriptor, Int32)

Returns the preferred column width in pixels for the specified column taking the length of the column header text and the value returned by GetColumnMaxLength into consideration.

Declaration

public virtual int GetPreferredColumnWidth(Graphics g, GridColumnDescriptor column, int maxWidth)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	The System.Drawing.Graphics
GridColumnDescriptor	column	The GridColumnDescriptor
System.Int32	maxWidth	Width of the max.

Returns

Type	Description
System.Int32	Preferred column width.

GetRecordColumnStyle(Record, GridColumnDescriptor)

Creates a style object and initializes its identity to emulate how the value would appear in a cell in the grid.

Declaration

public GridTableCellStyleInfo GetRecordColumnStyle(Record record, GridColumnDescriptor column)

Parameters

Type	Name	Description
Record	record	The Record.
GridColumnDescriptor	column	The Column.

Returns

Type	Description
GridTableCellStyleInfo	A style object for the specified column in the given record.

GetRelativeRowIndex(RowElement)

Returns the relative row index in the RowElements collection if displayElement is a RecordRow or ColumnHeader row. (A record can have column sets with multiple rows per record)

Declaration

public int GetRelativeRowIndex(RowElement rowElement)

Parameters

Type	Name	Description
RowElement	rowElement	The row element

Returns

Type	Description
System.Int32	The relative row index of the element.

GetRowHeaderRange(Element)

Returns the GridRangeInfo that spans the cells where a row header for the specified element should be displayed. Can span multiple rows if a table has multiple rows per record.

Declaration

public GridRangeInfo GetRowHeaderRange(Element element)

Parameters

Type	Name	Description
Element	element	The display element.

Returns

Type	Description
GridRangeInfo	The cell range.

GetStackedHeaderAt(Int32, Int32)

Returns the header columns GridStackedHeaderDescriptor at the specified grid row and column or NULL if the specified row is not a GridStackedHeaderRow or the grid column is not a column header.

Declaration

public GridStackedHeaderDescriptor GetStackedHeaderAt(int rowIndex, int colIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex	Row index.
System.Int32	colIndex	Column index.

Returns

Type	Description
GridStackedHeaderDescriptor	The stacked header.

GetStackedHeaderDescriptorAt(Element, Int32)

Returns the record field cell's GridStackedHeaderDescriptor at the specified display element and column.

Declaration

public GridStackedHeaderDescriptor GetStackedHeaderDescriptorAt(Element element, int colIndex)

Parameters

Type	Name	Description
Element	element	The element.
System.Int32	colIndex	Column index.

Returns

Type	Description
GridStackedHeaderDescriptor	The stacked header.

GetSummaryColumnCollection(Int32)

Returns an array of GridSummaryColumnDescriptor objects that are affected by changes to the field and need to be redrawn.

Declaration

public GridSummaryColumnDescriptorCollection GetSummaryColumnCollection(int fieldIndex)

Parameters

Type	Name	Description
System.Int32	fieldIndex	Field index.

Returns

Type	Description
GridSummaryColumnDescriptorCollection	An array of summary column descriptors.

GetTableCellStyle(Element, Int32)

Returns the style information with TableCellIdentity for the given element and x-coordinate.

Declaration

public GridTableCellStyleInfo GetTableCellStyle(Element element, int xPosition)

Parameters

Type	Name	Description
Element	element	The element
System.Int32	xPosition	The x position in client coordinate.

Returns

Type	Description
GridTableCellStyleInfo	The style element with identity information for the cell that is displayed at the specified coordinate.

Remarks

PointToTableCellStyle(Point) PointToNestedDisplayElement(Point)

GetTableCellStyle(Element, String)

Returns the GridTableCellStyleInfo for a specified grid row and column.

Declaration

public GridTableCellStyleInfo GetTableCellStyle(Element el, string fieldName)

Parameters

Type	Name	Description
Element	el	The element.
System.String	fieldName	The column.

Returns

Type	Description
GridTableCellStyleInfo	A GridTableCellStyleInfo.

GetTableCellStyle(ISummarySection, String)

Returns the GridTableCellStyleInfo for a specified grid row and column.

Declaration

public GridTableCellStyleInfo GetTableCellStyle(ISummarySection el, string fieldName)

Parameters

Type	Name	Description
ISummarySection	el	The element.
System.String	fieldName	The column.

Returns

Type	Description
GridTableCellStyleInfo	A GridTableCellStyleInfo.

GetTableCellStyle(Record, FieldDescriptor)

Returns the GridTableCellStyleInfo for a specified grid row and column.

Declaration

public GridTableCellStyleInfo GetTableCellStyle(Record record, FieldDescriptor field)

Parameters

Type	Name	Description
Record	record	The record.
FieldDescriptor	field	The field for the column.

Returns

Type	Description
GridTableCellStyleInfo	A GridTableCellStyleInfo.

GetTableCellStyle(Record, GridColumnDescriptor)

Returns the GridTableCellStyleInfo for a specified grid row and column.

Declaration

public GridTableCellStyleInfo GetTableCellStyle(Record record, GridColumnDescriptor column)

Parameters

Type	Name	Description
Record	record	The record.
GridColumnDescriptor	column	The column.

Returns

Type	Description
GridTableCellStyleInfo	A GridTableCellStyleInfo.

GetTableCellStyle(Record, GridVisibleColumnDescriptor)

Returns the GridTableCellStyleInfo for a specified grid row and column.

Declaration

public GridTableCellStyleInfo GetTableCellStyle(Record record, GridVisibleColumnDescriptor visibleColumn)

Parameters

Type	Name	Description
Record	record	The record.
GridVisibleColumnDescriptor	visibleColumn	The column.

Returns

Type	Description
GridTableCellStyleInfo	A GridTableCellStyleInfo.

GetTableCellStyle(Record, String)

Returns the GridTableCellStyleInfo for a specified grid row and column.

Declaration

public GridTableCellStyleInfo GetTableCellStyle(Record record, string fieldName)

Parameters

Type	Name	Description
Record	record	The record.
System.String	fieldName	The name of field for the column (e.g. GridColumnDescriptor.MappingName returns the field name).

Returns

Type	Description
GridTableCellStyleInfo	A GridTableCellStyleInfo.

GetTableCellStyle(Int32, Int32)

Returns the GridTableCellStyleInfo for a specified grid row and column.

Declaration

public GridTableCellStyleInfo GetTableCellStyle(int rowIndex, int colIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex	The row index.
System.Int32	colIndex	The column index.

Returns

Type	Description
GridTableCellStyleInfo	A GridTableCellStyleInfo.

GetTotalWidthOfRowHeadersAndIndent()

Calculates the width of row headers and all indent columns before the first record column.

Declaration

public int GetTotalWidthOfRowHeadersAndIndent()

Returns

Type	Description
System.Int32	Total width.

GetTotalWidthOfRowHeadersAndIndent(Boolean)

Calculates the width of row headers and all indent columns before the first record column.

Declaration

public int GetTotalWidthOfRowHeadersAndIndent(bool includeWidthOfParentTableIndent)

Parameters

Type	Name	Description
System.Boolean	includeWidthOfParentTableIndent	Specifies if width of nested table indents and parent table row headers should be added.

Returns

Type	Description
System.Int32	Total width.

GetTotalWidthOfTable(Boolean)

Calculates the width of the table considering all indent columns and visible columns.

Declaration

public int GetTotalWidthOfTable(bool checkNestedTables)

Parameters

Type	Name	Description
System.Boolean	checkNestedTables	True if nested tables should also be considered.

Returns

Type	Description
System.Int32	Total width.

OnAddedRelatedTable(TableEventArgs)

Declaration

protected override void OnAddedRelatedTable(TableEventArgs e)

Parameters

Type	Name	Description
TableEventArgs	e

Overrides

OnCategorizedRecords(TableEventArgs)

Declaration

protected override void OnCategorizedRecords(TableEventArgs e)

Parameters

Type	Name	Description
TableEventArgs	e

Overrides

GridTableBase.OnCategorizedRecords(TableEventArgs)

OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs)

Declaration

protected override void OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs e)

Parameters

Type	Name	Description
CurrentRecordContextChangeEventArgs	e

Overrides

GridTableBase.OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs)

OnEnsureSortFields()

Declaration

protected override void OnEnsureSortFields()

Overrides

Syncfusion.Grouping.Table.OnEnsureSortFields()

OnGroupSummaryInvalidated(GroupEventArgs)

Declaration

protected override void OnGroupSummaryInvalidated(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e

Overrides

Table.OnGroupSummaryInvalidated(GroupEventArgs)

OnInitializeColumnsMaxLengthFirstNRecords(Hashtable)

This method is called internally when GridColumnsMaxLengthStrategy.FirstNRecords has been specified and the column lengths for each field need to be initialized.

Declaration

protected virtual void OnInitializeColumnsMaxLengthFirstNRecords(Hashtable columnsMaxLengthFirstNRecordsTable)

Parameters

Type	Name	Description
System.Collections.Hashtable	columnsMaxLengthFirstNRecordsTable	The hashtable uses the FieldDescriptor.Name as key and the column length in characters as value.

OnPopulatedChildTable(ChildTable)

Declaration

protected override void OnPopulatedChildTable(ChildTable childTable)

Parameters

Type	Name	Description
ChildTable	childTable

Overrides

Table.OnPopulatedChildTable(ChildTable)

OnPrepareRemoving(Object)

Declaration

protected override void OnPrepareRemoving(object row)

Parameters

Type	Name	Description
System.Object	row

Overrides

Table.OnPrepareRemoving(Object)

OnQueryCellStyleInfo(GridTableCellStyleInfoEventArgs)

Raises the QueryCellStyleInfo event.

Declaration

protected virtual void OnQueryCellStyleInfo(GridTableCellStyleInfoEventArgs e)

Parameters

Type	Name	Description
GridTableCellStyleInfoEventArgs	e	A GridTableCellStyleInfoEventArgs that contains the event data.

OnQueryCoveredRange(GridTableQueryCoveredRangeEventArgs)

Raises the QueryCoveredRange event and calculates the covered range for a cell. Examples for covered ranges are the caption bar of a group, a summary row with GridSummaryStyle.FillRow, or the first record field cell of an add new record (which spans over the record field and plus minus button of groups below).

Declaration

protected virtual void OnQueryCoveredRange(GridTableQueryCoveredRangeEventArgs e)

Parameters

Type	Name	Description
GridTableQueryCoveredRangeEventArgs	e	A GridQueryCoveredRangeEventArgs that contains the event data.

OnRemovingRelatedTable(TableEventArgs)

Declaration

protected override void OnRemovingRelatedTable(TableEventArgs e)

Parameters

Type	Name	Description
TableEventArgs	e

Overrides

Table.OnRemovingRelatedTable(TableEventArgs)

OnSourceListChanged(TableEventArgs)

Declaration

protected override void OnSourceListChanged(TableEventArgs e)

Parameters

Type	Name	Description
TableEventArgs	e

Overrides

GridTableBase.OnSourceListChanged(TableEventArgs)

OnSourceListItemChanged(Object, ListChangedEventArgs, TableListChangedEventArgs)

Declaration

protected override void OnSourceListItemChanged(object sender, ListChangedEventArgs e, TableListChangedEventArgs te)

Parameters

Type	Name	Description
System.Object	sender
System.ComponentModel.ListChangedEventArgs	e
TableListChangedEventArgs	te

Overrides

Table.OnSourceListItemChanged(Object, ListChangedEventArgs, TableListChangedEventArgs)

OnSourceListReset(Object, ListChangedEventArgs, TableListChangedEventArgs)

Declaration

protected override void OnSourceListReset(object sender, ListChangedEventArgs e, TableListChangedEventArgs te)

Parameters

Type	Name	Description
System.Object	sender
System.ComponentModel.ListChangedEventArgs	e
TableListChangedEventArgs	te

Overrides

Table.OnSourceListReset(Object, ListChangedEventArgs, TableListChangedEventArgs)

PopulatePassThroughGroupsUntilFoundNRecords(Group, Int32)

Populates pass through groups for specified number of records.

Declaration

public void PopulatePassThroughGroupsUntilFoundNRecords(Group g, int count)

Parameters

Type	Name	Description
Group	g	The parent group.
System.Int32	count	The record count.

ResetAppearance()

Discards any changes for the Appearance object.

Declaration

public void ResetAppearance()

ResetRepaintElementsInQueue()

Clears the internal repaint elements queue. Call this method if you made changes to the table and you experience an exception triggered by a RepaintElementsInQueue method call. The method lets you work around any issues if elements are in the queue that have just been deleted from the table.

Declaration

public void ResetRepaintElementsInQueue()

ResetTableOptions()

Discards any changes for the TableOptions object.

Declaration

public void ResetTableOptions()

ShouldSerializeAppearance()

Determines whether Appearance has been modified and contents should be serialized at design-time.

Declaration

public bool ShouldSerializeAppearance()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeTableOptions()

Determines whether TableOptions were modified and contents should be serialized at design-time.

Declaration

public bool ShouldSerializeTableOptions()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

UnwireTableDescriptor()

Declaration

protected override void UnwireTableDescriptor()

Overrides

Table.UnwireTableDescriptor()

WireTableDescriptor()

Declaration

protected override void WireTableDescriptor()

Overrides

Table.WireTableDescriptor()

Events

QueryCellStyleInfo

Occurs for each cell before a GridTableControl starts painting and lets users customize the display of cells.

Declaration

public event GridTableCellStyleInfoEventHandler QueryCellStyleInfo

Event Type

Type
GridTableCellStyleInfoEventHandler

Remarks

Handling through a GridTableCellStyleInfoEventArgs

QueryCoveredRange

Occurs to determine if the cell belongs to a covered range and returns the covered range of the cell or the cell itself as GridRangeInfo if it is not a covered range.

Declaration

public event GridTableQueryCoveredRangeEventHandler QueryCoveredRange

Event Type

Type
GridTableQueryCoveredRangeEventHandler

Explicit Interface Implementations

IGridTableCellAppearanceSource.GetAppearance()

Declaration

GridTableCellAppearance IGridTableCellAppearanceSource.GetAppearance()

Returns

Type
GridTableCellAppearance

IGridTableCellAppearanceSource.RaiseAppearanceChanged(GridTableCellStyleInfoChangedEventArgs)

Declaration

void IGridTableCellAppearanceSource.RaiseAppearanceChanged(GridTableCellStyleInfoChangedEventArgs e)

Parameters

Type	Name	Description
GridTableCellStyleInfoChangedEventArgs	e

IGridTableCellAppearanceSource.RaiseAppearanceChanging(GridTableCellStyleInfoChangedEventArgs)

Declaration

void IGridTableCellAppearanceSource.RaiseAppearanceChanging(GridTableCellStyleInfoChangedEventArgs e)

Parameters

Type	Name	Description
GridTableCellStyleInfoChangedEventArgs	e

IGridTableOptionsSource.GetParentTableOptionsSource()

Declaration

IGridTableOptionsSource IGridTableOptionsSource.GetParentTableOptionsSource()

Returns

Type
IGridTableOptionsSource

IGridTableOptionsSource.HasTableOptions

Declaration

bool IGridTableOptionsSource.HasTableOptions { get; }

Returns

Type
System.Boolean

IGridTableOptionsSource.RaiseTableOptionsChanged(GridTableOptionsChangedEventArgs)

Declaration

void IGridTableOptionsSource.RaiseTableOptionsChanged(GridTableOptionsChangedEventArgs e)

Parameters

Type	Name	Description
GridTableOptionsChangedEventArgs	e

IGridTableOptionsSource.RaiseTableOptionsChanging(GridTableOptionsChangedEventArgs)

Declaration

void IGridTableOptionsSource.RaiseTableOptionsChanging(GridTableOptionsChangedEventArgs e)

Parameters

Type	Name	Description
GridTableOptionsChangedEventArgs	e

Implements

ITreeTableCounterSource

ITreeTableSummaryArraySource

System.IDisposable

IGridTableOptionsSource

IGridTableCellAppearanceSource