Class GridSummaryRow

A summary row element that is contained in the SummaryRows collection of a GridSummarySection. A summary row is added to a GridSummarySection for every visible GridSummaryRowDescriptor.

Inheritance
System.Object
Element
RowElement
GridSummaryRow
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 GridSummaryRow : RowElement, IDisposable, IDisposedEvent, IIsDisposedProperty, ITreeTableCounterSource, ITreeTableSummaryArraySource, IDisplayElement, IGridTableCellAppearanceSource

Constructors

GridSummaryRow(GridSummarySection, Int32)

Initializes a new instance of the GridSummaryRow class.

Declaration
public GridSummaryRow(GridSummarySection parent, int rowIndex)
Parameters
Type Name Description
GridSummarySection parent

The parent element.
System.Int32 rowIndex

The row index in the SummaryRows collection of the parent GridSummarySection.

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

IsFillRow

Gets the value whether this row displays summary columns in grid cells below a certain header column or if the summary row is one large covered cell that spans the whole row.

Declaration
public bool IsFillRow { get; }
Property Value
Type Description
System.Boolean

Kind

Gets the kind of display element.

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

ParentElement

Gets the parent this element belongs to.

Declaration
public GridSummarySection ParentElement { get; set; }
Property Value
Type Description
GridSummarySection

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

Returns 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

SummaryRowDescriptor

Returns a reference to the GridSummaryRowDescriptor this row belongs to.

Declaration
public GridSummaryRowDescriptor SummaryRowDescriptor { get; }
Property Value
Type Description
GridSummaryRowDescriptor

Methods

GetBaseAppearance()

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

Declaration
public GridTableCellAppearance GetBaseAppearance()
Returns
Type Description
GridTableCellAppearance

A GridTableCellAppearance.

GetElementCount()

Gets the number of elements.

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

returns value 1.
Overrides

GetSummaries(Table, out Boolean)

Gets a collection of summaries for the table.

Declaration
public override ITreeTableSummary[] GetSummaries(Table parentTable, out bool summaryChanged)
Parameters
Type Name Description
Table parentTable

The parent table.
System.Boolean summaryChanged

Returns true if changes were detected.
Returns
Type Description
ITreeTableSummary[]

A collection of summaries.
Overrides

GetVisibleCount()

Gets the number of visible elements.

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

returns the value 1.
Overrides

GetYAmountCount()

Gets the summary row height.

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

Summary row height.
Overrides

OnEnsureInitialized(Object)

This overridden Syncfusion.Grouping.Element.OnEnsureInitialized(System.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 Syncfusion.Grouping.Element.EnsureInitialized(System.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()

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