Grouping Event

Occurs when the user is grouping.

Syntax

Visual Basic
C#

'Declaration
 
Public Event Grouping As GroupingEventHandler

'Usage
 
Dim instance As FpSpread
Dim handler As GroupingEventHandler
 
AddHandler instance.Grouping, handler

public event GroupingEventHandler Grouping

Event Data

The event handler receives an argument of type GroupingEventArgs containing data related to this event. The following GroupingEventArgs properties provide information specific to this event.

Property	Description
Cancel	Gets or sets whether to cancel the grouping.
GroupComparer	Gets or sets the group comparer.
SortInfo	Gets the sorting information.

Remarks

The GroupingEventHandler receives an argument of type GroupingEventArgs containing data related to this event. This event also fires when the user ungroups the last group.

Example

This example uses the Grouping event.

FpSpread1.ActiveSheetView.AllowColumnMove = true;
FpSpread1.ActiveSheetView.GroupBarVisible = true;
FpSpread1.ActiveSheetView.GroupBarBackColor = Drawing.Color.Salmon;
FpSpread1.ActiveSheetView.GroupBarHeight = 50;
FpSpread1.ActiveSheetView.GroupMaximumLevel = 5;
FpSpread1.ActiveSheetView.AllowGroup = true;
FarPoint.Web.Spread.GroupInfo gi = new FarPoint.Web.Spread.GroupInfo();
gi.BackColor = Drawing.Color.Yellow;
FarPoint.Web.Spread.GroupInf gi2 = new FarPoint.Web.Spread.GroupInfo();
gi2.BackColor = Drawing.Color.Green;
FarPoint.Web.Spread.GroupInfoCollection gic = new FarPoint.Web.Spread.GroupInfoCollection();
gic.Add(gi);
FpSpread1.ActiveSheetView.GroupInfos.Add(gic(0));

protected void FpSpread1_Grouping(object sender, FarPoint.Web.Spread.GroupingEventArgs e)
        {
            e.Cancel = true;
        }

Visual Basic

FpSpread1.ActiveSheetView.AllowColumnMove = True
FpSpread1.ActiveSheetView.GroupBarVisible = True
FpSpread1.ActiveSheetView.GroupBarBackColor = Drawing.Color.Salmon
FpSpread1.ActiveSheetView.GroupBarHeight = 50
FpSpread1.ActiveSheetView.GroupMaximumLevel = 5
FpSpread1.ActiveSheetView.AllowGroup = True
Dim gi As New FarPoint.Web.Spread.GroupInfo
gi.BackColor = Drawing.Color.Yellow
Dim gi2 As New FarPoint.Web.Spread.GroupInfo
gi2.BackColor = Drawing.Color.Green
Dim gic As New FarPoint.Web.Spread.GroupInfoCollection()
gic.Add(gi)
FpSpread1.ActiveSheetView.GroupInfos.Add(gic(0))

Protected Sub FpSpread1_Grouping(ByVal sender As Object, ByVal e As FarPoint.Web.Spread.GroupingEventArgs) Handles FpSpread1.Grouping
            e.Cancel = True
End Sub

Reference

FpSpread Class
FpSpread Members

Product Support Forum | Print this page