WinForms

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

    Show / Hide Table of Contents

    Class CaptionSection

    Defines and implements the class that supports the section of the Caption row.

    Inheritance
    System.Object
    Element
    Section
    RowElementsSection
    CaptionSection
    GridCaptionSection
    Implements
    System.IDisposable
    ITreeTableCounterSource
    ITreeTableSummaryArraySource
    IRowElementsContainer
    Inherited Members
    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.Engine
    Element.EngineTable
    Element.ParentTable
    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.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 CaptionSection : RowElementsSection, IDisposable, IDisposedEvent, IIsDisposedProperty, ITreeTableCounterSource, ITreeTableSummaryArraySource, IRowElementsContainer, IContainerElement, IElementTreeTableSource, IElement
    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 CaptionSection (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 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

    CaptionSection(Group)

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

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

    The group this section is created in.

    Properties

    CaptionRows

    Gets the value of collection of CaptionRow elements.

    Declaration
    public CaptionRowCollection CaptionRows { get; }
    Property Value
    Type Description
    CaptionRowCollection

    Id

    Gets or sets the value of the Id used to lookup objects.

    Declaration
    public override int Id { get; set; }
    Property Value
    Type Description
    System.Int32
    Overrides
    Element.Id
    Remarks

    Used by internal caches.

    Kind

    Override and gets value of the display element Kind.

    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)

    GetElementCount()

    Overrides and gets the number of elements.

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

    Element count.

    Overrides
    RowElementsSection.GetElementCount()

    GetFilteredRecordCount()

    Overrides and gets the number of filtered records.

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

    Filtered record count.

    Overrides
    RowElementsSection.GetFilteredRecordCount()

    GetRecordCount()

    Overrides and gets the number of records.

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

    Record count.

    Overrides
    RowElementsSection.GetRecordCount()

    GetVisibleCount()

    Overrides and gets the number of visible elements.

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

    Visible element count.

    Overrides
    RowElementsSection.GetVisibleCount()

    GetYAmountCount()

    Overrides and gets the height of the caption.

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

    Caption height.

    Overrides
    RowElementsSection.GetYAmountCount()

    SupportsId()

    Overrides and determines if this object can be uniquely identified using its Id or not.

    Declaration
    public override bool SupportsId()
    Returns
    Type Description
    System.Boolean

    True

    Overrides
    Element.SupportsId()

    Implements

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