Class GridColumnHeaderSection

The section with the ColumnHeaderRow(s):

Inheritance
System.Object
Element
Section
RowElementsSection
ColumnHeaderSection
GridColumnHeaderSection
Inherited Members
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)
Namespace: Syncfusion.Windows.Forms.Grid.Grouping
Assembly: Syncfusion.Grid.Grouping.Windows.dll
Syntax
public class GridColumnHeaderSection : ColumnHeaderSection, IDisposable, IDisposedEvent, IIsDisposedProperty, ITreeTableCounterSource, ITreeTableSummaryArraySource, IRowElementsContainer, IContainerElement, IElement, IElementTreeTableSource, IGridTableCellAppearanceSource
Remarks

A ColumnHeaderSection holds ColumnHeaderRow(s) that are displayed at the top of a table or group. The ColumnHeaderRow is a place holder item where the grouping grid should display column headers.

The ColumnHeaderSection is a container element and has a collection of one or multiple ColumnHeaderRow elements.

If ColumnHeaderSections should be displayed at the top of each group, then ColumnHeaderSections are created when the grouping for a table is initialized. The grouping engine loops through all sorted records and categorizes them. For each new group, the virtual TableDescriptor.CreateGroup factory method is called. The TableDescriptor.CreateGroup method instantiates a ColumnHeaderSection by calling the virtual TableDescriptor.CreateColumnHeaderSection factory method.

One set of ColumnHeaderRows are displayed at the top of the table below the CaptionSection. The rows belong to the ColumnHeaderSection of the TopLevelGroup of a table. The TopLevelGroup is created with the virtual TableDescriptor.CreateGroup factory method. The TableDescriptor.CreateGroup method instantiates a ColumnHeaderSection by calling the virtual TableDescriptor.CreateColumnHeaderSection factory method.

Because the ColumnHeaderSection is a container element and not a display element, it will not be an item returned by the Table.DisplayElements and Table.GroupedElements collection. Instead, the ColumnHeaderSection can be accessed only through the Group.Sections collection of its parent group or TopLevelGroup.

See also:

TableDescriptor.CreateGroup, TableDescriptor.CreateColumnHeaderSection, Table.TopLevelGroup, IContainerElement, Group.Sections

Constructors

GridColumnHeaderSection(Group)

Initializes a new instance of the GridColumnHeaderSection class.

Declaration
public GridColumnHeaderSection(Group parent)
Parameters
Type Name Description
Group parent

The group this section is created in.

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

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

ParentChildTable

Gets a reference to the child table this element belongs.

Declaration
public GridChildTable ParentChildTable { get; }
Property Value
Type
GridChildTable

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 the 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

Methods

Dispose(Boolean)

Release the unmanaged resource.

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

GetBaseAppearance()

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

Declaration
public GridTableCellAppearance GetBaseAppearance()
Returns
Type Description
GridTableCellAppearance

A GridTableCellAppearance of this element.

ResetAppearance()

Discards any changes for the Appearance object.

Declaration
public void ResetAppearance()

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.

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

Implements

System.IDisposable