Class GridCaptionSection

The section with the CaptionRow.

Inheritance
System.Object
Element
Section
RowElementsSection
CaptionSection
GridCaptionSection
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 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
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.

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