Spread for ASP.NET 7.0 Product Documentation
Grouping Event
See Also  Example Support Options
FarPoint.Web.Spread Assembly > FarPoint.Web.Spread Namespace > FpSpread Class : Grouping Event


Glossary Item Box

Occurs when the user is grouping.

Syntax

Visual Basic (Declaration) 
Public Event Grouping As GroupingEventHandler
Visual Basic (Usage)Copy Code
Dim instance As FpSpread
Dim handler As GroupingEventHandler
 
AddHandler instance.Grouping, handler
C# 
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.

PropertyDescription
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.
C#Copy Code
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 BasicCopy Code
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

Requirements

Target Platforms: Windows 7, Windows 8, Windows Vista, Windows Server 2000, Windows 2000 Professional, Windows XP Professional, Windows NT 4.0 Workstation, SP6, Windows NT 4.0 Server, SP6

See Also

© 2002-2014 ComponentOne, a division of GrapeCity. All Rights Reserved.