Class GridStackedHeaderSection

The stackedHeader section that contains one or multiple row elements for showing the stackedHeader below a group in DisplayElement. The stackedHeader information can be determined by calling GetSummaries(Table, out Boolean) on the Group that this stackedHeader section belongs to.

Inheritance
System.Object
Element
Section
RowElementsSection
GridStackedHeaderSection
Inherited Members
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 GridStackedHeaderSection : RowElementsSection, IDisposable, IDisposedEvent, IIsDisposedProperty, ITreeTableCounterSource, ITreeTableSummaryArraySource, IRowElementsContainer, IContainerElement, IElementTreeTableSource, IElement, IGridTableCellAppearanceSource

Constructors

GridStackedHeaderSection(Group)

Initializes a new section in the specified group.

Declaration
public GridStackedHeaderSection(Group group)
Parameters
Type Name Description
Group group

The group this section is created in.

Properties

Appearance

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

Kind

Gets the kind of display element for stacked header row or section.

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

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

If this element is modified, the Appearance returns this object's Appearance; 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

StackedHeaderRows

The collection of GridStackedHeaderRow elements that are contained in this section.

Declaration
public GridStackedHeaderRowCollection StackedHeaderRows { get; }
Property Value
Type Description
GridStackedHeaderRowCollection

Methods

Dispose(Boolean)

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

EnsureInitialized(Object, Boolean)

Ensures the object, nested objects and parent elements reflect any changes made to the engine or table descriptor.

Declaration
public override bool EnsureInitialized(object sender, bool notifyParent)
Parameters
Type Name Description
System.Object sender

The object that triggered the call.
System.Boolean notifyParent

Specifies if the parent element's EnsureInitialized(Object) should also be called.
Returns
Type Description
System.Boolean

True if they reflect the changes.
Overrides

GetBaseAppearance()

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

Declaration
public GridTableCellAppearance GetBaseAppearance()
Returns
Type Description
GridTableCellAppearance

A GridTableCellAppearance.

GetCounter()

Gets the counter for the element.

Declaration
public override ITreeTableCounter GetCounter()
Returns
Type Description
ITreeTableCounter

The counter for the current element.
Overrides

InvalidateCounterTopDown(Boolean)

Resets the counter for all elements.

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

When true notifies the counter source.
Overrides

OnEnsureInitialized(Object)

This overridden OnEnsureInitialized(Object) lets the elements implement element-specific logic to ensure object is up to data.

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

The object that triggered the OnEnsureInitialized(Object) call.
Returns
Type Description
System.Boolean

True if changes were detected and the object was updated; False otherwise.
Overrides

ResetAppearance()

Discards any changes for the Appearance object.

Declaration
public void ResetAppearance()

ShouldCreateChildElementTreeTable()

To create ChildElementTreeTable

Declaration
protected override bool ShouldCreateChildElementTreeTable()
Returns
Type Description
System.Boolean

returns Boolean value true
Overrides
Syncfusion.Grouping.RowElementsSection.ShouldCreateChildElementTreeTable()

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.

ToString()

Returns a string holding the current object.

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

String representation of the current object.
Overrides

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