The purpose of this article is to describe what is grouping and how to work with it through the RadSpreadProcessing model. It contains the following sections:
Grouping is a mechanism to organize data in sections, in order to be able to show and hide the relevant chunks.
Each row or column which is part of a group is assigned an outline level, which determines the level of grouping and from there which rows or columns it is grouped with.
Figure 1: Grouping
In Figure 1, the rows 1, 2, 4 and 8 have outline level value of 1. Rows 5, 6, and 7 have outline level 2. Rows 3 and 9 do not participate in the grouping and have the default value of 0.
The maximum outline level is 7.
There are two available options when grouping. The first option is to simply assign the outline level property of the rows or columns:
Example 1: Grouping columns using outline level
Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets.Add(); worksheet.Columns.SetOutlineLevel(1); worksheet.Columns[1, 2].SetOutlineLevel(2); worksheet.Columns.SetOutlineLevel(1);
Dim workbook = New Workbook() Dim worksheet = workbook.Worksheets.Add() worksheet.Columns(0).SetOutlineLevel(1) worksheet.Columns(1, 2).SetOutlineLevel(2) worksheet.Columns(3).SetOutlineLevel(1)
The other option is to use the Group method exposed by the row/column selection classes.
Example 2: Grouping columns using the group method
Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets.Add(); worksheet.Columns[0, 3].Group(); worksheet.Columns[1, 2].Group();
Dim workbook = New Workbook() Dim worksheet = workbook.Worksheets.Add() worksheet.Columns(0, 3).Group() worksheet.Columns(1, 2).Group()
Figure 2 shows the result of both approaches.
Figure 2: Result from grouping
As with grouping, ungrouping can be done both through setting the outline level property of the row or column selection, or by using the Ungroup method exposed by the same classes.
The following code snippets exemplify the two approaches to make these changes in a file.
Figure 3: Ungrouping result
Example 3: Ungrouping columns using the ungroup method
worksheet.Rows[0, 1].Ungroup(); worksheet.Rows[4, 6].Ungroup();
worksheet.Rows(0, 1).Ungroup() worksheet.Rows(4, 6).Ungroup()
You can achieve the same result with the code in Example 4.
Example 4: Ungrouping columns using outline level
worksheet.Rows[0, 1].ClearOutlineLevel(); worksheet.Rows[4, 6].SetOutlineLevel(1);
worksheet.Rows(0, 1).ClearOutlineLevel() worksheet.Rows(4, 6).SetOutlineLevel(1)
You can get the outline level of a row/column or a group of rows/columns using the code in Example 5:
Example 5: Getting the OutlineLevel
RangePropertyValue<int> outlineLevelRangeValue = worksheet.Rows[0, 1].GetOutlineLevel(); int outLineLevel = outlineLevelRangeValue.Value;
Dim outlineLevelRangeValue As RangePropertyValue(Of Integer) = worksheet.Rows(0, 1).GetOutlineLevel() Dim outLineLevel As Integer = outlineLevelRangeValue.Value
When a selection of rows is grouped, the row immediately below them is automatically designated to be a summary row for this group. In the context of the grouping feature, this means that the plus/minus outline symbol will be aligned with this row. The same is applied to columns, whose summary column is automatically placed to the right of the group.
Figure 4: Summary row
In Figure 4, the summary row for the group of rows 1 to 4 is row 5 and for rows 7 to 10 it is row 11.
If you would like to change the placement of the summary row or column, this can be done through the GroupingProperties class, which exposes the following two boolean properties:
Both properties have a default value of true. The following snippet shows how to set the value of the SummaryColumnIsToRight and what result to expect in the produced file.
Example 6: Setting the position of the summary column to left
worksheet.GroupingProperties.SummaryColumnIsToRight = false;
worksheet.GroupingProperties.SummaryColumnIsToRight = False
Figure 5: Left summary column