GroupDataModel Class

Represents the group data model.

Inheritance

object

BaseSheetDataModel

GroupDataModel

Implements

INonEmptyCells

IOptimizedEnumerationSupport2

IOptimizedEnumerationSupport

Namespace: FarPoint.Web.Spread.Model

Assembly: FarPoint.Web.Spread.dll

Syntax

public class GroupDataModel : BaseSheetDataModel, INonEmptyCells, IOptimizedEnumerationSupport2, IOptimizedEnumerationSupport, IChartSupport, IGroupSupport, ISheetDataModel, ICanSerializeXml, ISerializeSupport, IAggregationSupport

Public Class GroupDataModel
    Inherits BaseSheetDataModel
    Implements INonEmptyCells, IOptimizedEnumerationSupport2, IOptimizedEnumerationSupport, IChartSupport, IGroupSupport, ISheetDataModel, ICanSerializeXml, ISerializeSupport, IAggregationSupport

Constructors

Name	Description
GroupDataModel()	Creates a new group data model.
GroupDataModel(ISheetDataModel)	Creates a new group data model for the specified sheet data model.

Properties

Name	Description
CanSerializeXml	Gets whether the entire object can be saved to XML and successfully loaded again.
ColumnCount	Gets the number of columns in the group.
EnableGroupFooter	Gets or Sets whether the group model has group footer.
GroupComparer	Gets the group comparer.
Groups	Gets the list of top-level group objects.
NonEmptyColumnCount	Gets the number of columns in the model that contain data (bound or unbound).
NonEmptyRowCount	Gets the number of rows in the model that contain data (bound or unbound).
RowCount	Gets the number of rows in the group.
SortInfo	Gets the sorting information for the group.
SuspendGrouping	Gets or sets whether the grouping is suspended.
TargetModel	Gets the sheet data model for the group target.

Methods

Name	Description
Deserialize(XmlNodeReader)	Loads the object from XML.
Dispose()	Disposes this object.
GetAggregationResult(int, int, int, int, AggregationType, string)	Gets aggregation of the cells in the specified range of cells.
GetAggregationType(int)	Gets the AggregationType at the specified column.
GetColumnName(int)	Gets the name of the specified column in the group.
GetGroup(int)	Gets the group associated with the specified row.
GetGroupFooter(int)	Gets a group footer for a specified row.
GetGroupIndex(int)	Gets index of group that row locates. If row is not in a group, return -1
GetIndex(int)	Gets the model index of the group data model from the specified row.
GetItem(int)	Gets the item in the specified row.
GetModelIndexFromTargetIndex(int)	Gets the group data model index from the target index.
GetNote(int, int)	Gets a user-defined note value for the cell of the specified row and column.
GetTag(int, int)	Gets an application-defined tag value for the cell of the specified row and column.
GetValue(int, int)	Gets the value from the cell in the group.
Group(SortInfo[])	Groups the rows with the specified sort information.
Group(SortInfo[], IComparer)	Groups the rows with the specified sort information and specified comparer.
IsEditable(int, int)	Determines whether the cell in the group is editable.
IsEmpty()	Determines whether the data model is empty.
IsGroup(int)	Determines whether the specified row is a group header (also called group node).
IsGroupFooter(int)	Determines if the specified row is a group footer.
IsRowUsed(int)	Determines whether the specified row has data (is not empty).
NextNonEmptyColumnInRow(int, int)	Gets the index of the next column in a specified row that contains data.
NextNonEmptyRow(int)	Gets the index of the next row that contains data.
Serialize(XmlTextWriter)	Saves the object to XML.
SetAggregationType(int, AggregationType)	Sets the aggregation type at the specified column.
SetNote(int, int, string)	Sets a user-defined note value for the cell at the specified row and column.
SetTag(int, int, object)	Sets an application-defined tag value for the cell of the specified row and column.
SetValue(int, int, object)	Sets the value of the cell in the group.
Sort(SortInfo[])	Sorts the rows (after the Grouped event) according to the specified sorting information.

Events

Name	Description
Aggregate	Occurs when the data model aggregates.