WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ColumnHeaderSection - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class ColumnHeaderSection

    Defines the class that implements the section of the column headers.

    Inheritance
    System.Object
    Element
    Section
    RowElementsSection
    ColumnHeaderSection
    GridColumnHeaderSection
    Implements
    System.IDisposable
    ITreeTableCounterSource
    ITreeTableSummaryArraySource
    IRowElementsContainer
    Inherited Members
    RowElementsSection.GetSummaries(Table, Boolean)
    RowElementsSection.InvalidateSummariesBottomUp()
    RowElementsSection.InvalidateSummariesTopDown()
    RowElementsSection.InvalidateSummary()
    RowElementsSection.RowElements
    Section.GetCounter()
    Section.ParentElement
    Element.SupportsId()
    Element.Dispose()
    Element.OnDisposed(EventArgs)
    Element.EnsureInitialized(Object)
    Element.EnsureInitialized(Object, Boolean)
    Element.InvalidateCounterBottomUp()
    Element.InvalidateCounter()
    Element.OnElementTreeInvalidateCounterBottomUp()
    Element.GetSummaries(Table)
    Element.GetCustomCount()
    Element.GetVisibleCustomCount()
    Element.IsChildVisible(Element)
    Element.GetVisibleInParent()
    Element.GetVisibleInHierarchy()
    Element.GetChildCount()
    Element.GetCustomPosition()
    Element.GetVisibleCustomPosition()
    Element.ITreeTableSummaryArraySource.GetSummaries(ITreeTableEmptySummaryArraySource, Boolean)
    Element.GetData()
    Element.OnBeginEditCalled()
    Element.OnBeginEditComplete(Boolean)
    Element.OnEndEditCalled()
    Element.OnEndEditComplete(Boolean)
    Element.OnCancelEditCalled()
    Element.OnCancelEditComplete(Boolean)
    Element.OnLeaveRecordCalled()
    Element.OnLeaveRecordComplete(Boolean)
    Element.OnEnterRecordCalled()
    Element.OnEnterRecordComplete(Boolean)
    Element.IsCaption(Element)
    Element.IsRecord(Element)
    Element.IsColumnHeader(Element)
    Element.IsFilterBar(Element)
    Element.IsCaption()
    Element.IsRecord()
    Element.IsColumnHeader()
    Element.IsFilterBar()
    Element.GetCaptionSection(Element)
    Element.GetRecord(Element)
    Element.GetColumnHeaderSection(Element)
    Element.GetFilterBar(Element)
    Element.GetCaptionSection()
    Element.GetRecord()
    Element.GetColumnHeaderSection()
    Element.GetFilterBar()
    Element.Engine
    Element.EngineTable
    Element.ParentTable
    Element.TableLevel
    Element.Id
    Element.Reserved1
    Element.Reserved2
    Element.Reserved3
    Element.Reserved4
    Element.Reserved5
    Element.Reserved6
    Element.Reserved7
    Element.Reserved8
    Element.Reserved9
    Element.Reserved10
    Element.Reserved11
    Element.Reserved16a
    Element.Reserved16b
    Element.Reserved16c
    Element.Info
    Element.Disposing
    Element.IsDisposed
    Element.InDisposed
    Element.ParentTableDescriptor
    Element.ParentDisplayElement
    Element.ParentGroup
    Element.ParentRecord
    Element.ParentChildTable
    Element.ParentSection
    Element.GroupLevel
    Element.ChildTableGroupLevel
    Element.Disposed
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.Grouping
    Assembly: Syncfusion.Grouping.Base.dll
    Syntax
    public class ColumnHeaderSection : RowElementsSection, IDisposable, IDisposedEvent, IIsDisposedProperty, ITreeTableCounterSource, ITreeTableSummaryArraySource, IRowElementsContainer, IContainerElement, IElement, IElementTreeTableSource
    Remarks

    A ColumnHeaderSection holds ColumnHeaderRow(s) that are displayed at the top of a table or group. 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 ColumnHeaderSection(s) should be displayed at the top of each group, ColumnHeaderSection(s) 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 collections. 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

    ColumnHeaderSection(Group)

    Initializes a new instance of the ColumnHeaderSection class in the specified group.

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

    The group this section is created in.

    Properties

    ColumnHeaderRows

    Gets the value of the collection of ColumnHeaderRow elements.

    Declaration
    public ColumnHeaderRowCollection ColumnHeaderRows { get; }
    Property Value
    Type Description
    ColumnHeaderRowCollection

    Kind

    Overrides and gets the kind of display element.

    Declaration
    public override DisplayElementKind Kind { get; }
    Property Value
    Type Description
    DisplayElementKind
    Overrides
    Element.Kind

    Methods

    Dispose(Boolean)

    Overrides and manages the unwanted resources.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing
    Overrides
    RowElementsSection.Dispose(Boolean)

    FieldsToString()

    Gets a concatenated string of all field names of Fields of the TableDescriptor this section belongs to.

    Declaration
    public string FieldsToString()
    Returns
    Type Description
    System.String

    A string with comma-separated field names.

    GetElementCount()

    Returns the number of elements.

    Declaration
    public override int GetElementCount()
    Returns
    Type Description
    System.Int32

    Number of elements.

    Overrides
    RowElementsSection.GetElementCount()

    GetFilteredRecordCount()

    Overrides and gets the number of filtered records.

    Declaration
    public override int GetFilteredRecordCount()
    Returns
    Type Description
    System.Int32

    Number of filtered records.

    Overrides
    RowElementsSection.GetFilteredRecordCount()

    GetRecordCount()

    Overrides and gets the number of records.

    Declaration
    public override int GetRecordCount()
    Returns
    Type Description
    System.Int32

    Returns 0.

    Overrides
    RowElementsSection.GetRecordCount()

    GetVisibleCount()

    Overrides and gets the number of visible elements.

    Declaration
    public override int GetVisibleCount()
    Returns
    Type Description
    System.Int32

    Number of visible elements.

    Overrides
    RowElementsSection.GetVisibleCount()

    GetYAmountCount()

    Overrides and gets the column header section height.

    Declaration
    public override double GetYAmountCount()
    Returns
    Type Description
    System.Double

    Returns Height.

    Overrides
    RowElementsSection.GetYAmountCount()

    InvalidateCounterTopDown(Boolean)

    Overrides and forces re-evaluation of all counters for all the table elements.

    Declaration
    public override void InvalidateCounterTopDown(bool notifyCounterSource)
    Parameters
    Type Name Description
    System.Boolean notifyCounterSource

    When True notifies counter source.

    Overrides
    RowElementsSection.InvalidateCounterTopDown(Boolean)

    OnEnsureInitialized(Object)

    Overrides and determines whether the object is updated or not.

    Declaration
    protected override bool OnEnsureInitialized(object sender)
    Parameters
    Type Name Description
    System.Object sender
    Returns
    Type Description
    System.Boolean

    Boolean value.

    Overrides
    RowElementsSection.OnEnsureInitialized(Object)

    ToString()

    Overrides and gets the string representation of ColumnHeaderSection.

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String

    String representation of the current object.

    Overrides
    RowElementsSection.ToString()

    Implements

    System.IDisposable
    ITreeTableCounterSource
    ITreeTableSummaryArraySource
    IRowElementsContainer
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved