WinForms

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

    Show / Hide Table of Contents

    Class GridCaptionSection

    The section with the CaptionRow.

    Inheritance
    System.Object
    Element
    Section
    RowElementsSection
    CaptionSection
    GridCaptionSection
    Implements
    System.IDisposable
    ITreeTableCounterSource
    ITreeTableSummaryArraySource
    IRowElementsContainer
    IGridTableCellAppearanceSource
    Inherited Members
    CaptionSection.SupportsId()
    CaptionSection.GetVisibleCount()
    CaptionSection.GetYAmountCount()
    CaptionSection.GetElementCount()
    CaptionSection.GetFilteredRecordCount()
    CaptionSection.GetRecordCount()
    CaptionSection.Id
    CaptionSection.Kind
    CaptionSection.CaptionRows
    RowElementsSection.OnEnsureInitialized(Object)
    RowElementsSection.GetSummaries(Table, Boolean)
    RowElementsSection.InvalidateSummariesBottomUp()
    RowElementsSection.InvalidateCounterTopDown(Boolean)
    RowElementsSection.InvalidateSummariesTopDown()
    RowElementsSection.InvalidateSummary()
    RowElementsSection.ToString()
    RowElementsSection.RowElements
    Section.GetCounter()
    Section.ParentElement
    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.TableLevel
    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.ParentDisplayElement
    Element.ParentGroup
    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.Windows.Forms.Grid.Grouping
    Assembly: Syncfusion.Grid.Grouping.Windows.dll
    Syntax
    public class GridCaptionSection : CaptionSection, IDisposable, IDisposedEvent, IIsDisposedProperty, ITreeTableCounterSource, ITreeTableSummaryArraySource, IRowElementsContainer, IContainerElement, IElementTreeTableSource, IElement, IGridTableCellAppearanceSource
    Remarks

    This is the first section within a group which provides the caption bar above the column headers. CaptionSection is a display element and will be an item returned by the Table.DisplayElements and Table.GroupedElements collection.

    CaptionSection is also a Section that can be accessed through the Group.Sections collection of its parent group.

    If a caption should be displayed at the beginning of each group, then CaptionSections 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 CaptionSection by calling the virtual TableDescriptor.CreateCaptionSection factory method.

    Examples

    The following example creates a string based on the CaptionSection's parent group number of direct child elements (as usually shown in the caption element for a group in GroupingGrid). Use the ParentGroup property to get access to the parent Group of this CaptionSection:

                CaptionSection cs;
                object cat = cs.ParentGroup.Category;
                if (cat == null)
                    cat = "(null)";
                string caption = "{2} Item(s)";
                string groupName = cs.ParentGroup.Name;
                if (groupName != "")
                    caption = "{0}: {1} - " + caption;
                return string.Format(caption, groupName, cat, cs.ParentGroup.GetChildCount());

    See also:

    TableDescriptor.CreateGroup, TableDescriptor.CreateCaptionSection, Group.Caption, Group.Sections, IDisplayElement

    Constructors

    GridCaptionSection(Group)

    Initializes a new instance of the GridCaptionSection class.

    Declaration
    public GridCaptionSection(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 Description
    GridTableCellAppearance

    Engine

    Gets the engine this element belongs to.

    Declaration
    public GridEngine Engine { get; }
    Property Value
    Type Description
    GridEngine

    EngineTable

    Gets the GridTable of the engine this element belongs to.

    Declaration
    public GridTable EngineTable { get; }
    Property Value
    Type Description
    GridTable

    ParentChildTable

    Gets a reference to the child table this element belongs.

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

    ParentRecord

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

    Declaration
    public GridRecord ParentRecord { get; }
    Property Value
    Type Description
    GridRecord

    ParentTable

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

    Declaration
    public GridTable ParentTable { get; set; }
    Property Value
    Type Description
    GridTable

    ParentTableDescriptor

    Gets the table descriptor this element belongs to.

    Declaration
    public GridTableDescriptor ParentTableDescriptor { get; }
    Property Value
    Type Description
    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 Description
    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
    CaptionSection.Dispose(Boolean)

    GetBaseAppearance()

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

    Declaration
    public GridTableCellAppearance GetBaseAppearance()
    Returns
    Type Description
    GridTableCellAppearance

    A GridTableCellAppearance.

    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 Description
    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
    ITreeTableCounterSource
    ITreeTableSummaryArraySource
    IRowElementsContainer
    IGridTableCellAppearanceSource
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved