GrapeCity.Documents.Excel.IGroupInfo

IGroupInfo Interface

Represents information about a worksheet outline group.

An IGroupInfo object describes a grouped row or column range in a worksheet outline. After obtaining a group from RowGroupInfo or ColumnGroupInfo, use it to inspect the group's boundaries and hierarchy, or to expand and collapse the group.

Namespace: GrapeCity.Documents.Excel

Assembly: DS.Documents.Excel.dll

Syntax

public interface IGroupInfo

Public Interface IGroupInfo

Examples

worksheet.Range["1:4"].Group();
IGroupInfo group = worksheet.Outline.RowGroupInfo[0];
int startIndex = group.StartIndex;
int endIndex = group.EndIndex;
group.Collapse();

Properties

Name	Description
Children	Gets the child groups of the current group. Child groups are nested outline groups whose range is contained within the current group. Use this property to traverse the outline hierarchy after retrieving a group from RowGroupInfo or ColumnGroupInfo.
EndIndex	Gets the end index of current group. The returned value identifies the last row or column index included in this group, depending on whether the group belongs to row or column outline information.
IsCollapsed	Gets whether the current group is collapsed.
Level	Gets the level of the current group.
Parent	Gets the parent of current group. Use this property to navigate from a nested group to the group that contains it.
StartIndex	Gets the start index of current group. Use this property together with EndIndex to determine the row or column span covered by the group.

Methods

Name	Description
Collapse()	Collapses current group. This method hides the rows or columns in the current outline group and marks the group as collapsed. If the group is already collapsed, this method does nothing. Use IsCollapsed to determine the current collapse state, or Expand() to show the grouped rows or columns again.
Expand()	Expands current group. Shows the rows or columns in the current outline group again after the group has been collapsed. If the group has a collapsed parent group, this method clears the current group's collapsed state, but the grouped rows or columns remain hidden until the parent group is expanded.

Name

Description

Collapse()

Collapses current group.

This method hides the rows or columns in the current outline group and marks the group as collapsed. If the group is already collapsed, this method does nothing. Use IsCollapsed to determine the current collapse state, or Expand() to show the grouped rows or columns again.

Expand()

Expands current group.

Shows the rows or columns in the current outline group again after the group has been collapsed. If the group has a collapsed parent group, this method clears the current group's collapsed state, but the grouped rows or columns remain hidden until the parent group is expanded.