GrapeCity.Documents.Excel.IOutlineColumn

IOutlineColumn Interface

Represents the outline column for a worksheet.

An outline column displays hierarchical row data in a tree view. Use OutlineColumn to access the outline column, then configure the column index, visibility options, and level settings for the hierarchy display.

Namespace: GrapeCity.Documents.Excel

Assembly: DS.Documents.Excel.dll

Syntax

public interface IOutlineColumn

Public Interface IOutlineColumn

Examples

worksheet.Range["A1:A3"].Value = new object[,] {{"Name"}, {"Node 1"}, {"Node 1.1"}};
worksheet.Range["A2"].IndentLevel = 1;
IOutlineColumn outlineColumn = worksheet.OutlineColumn;
outlineColumn.ColumnIndex = 0;
outlineColumn.ShowImage = true;

Properties

Name	Description
CollapseIndicator	Gets or sets the image used as the collapse indicator in the outline column. This image is displayed for grouped rows when the outline column shows a collapse indicator for the current outline level.
ColumnIndex	Gets or sets the zero-based index of the column displayed as the outline column. The outline column displays hierarchical rows as a tree structure based on the indent levels in the worksheet.
ExpandIndicator	Gets or sets the image used as the expand indicator in the outline column. This image is displayed for expandable rows when the outline column shows hierarchy indicators.
Images	Gets the images used for each outline level. Use this property to access the image collection for the outline column. Each item in the returned list represents the image displayed for a specific outline level when images are enabled.
MaxLevel	Gets or sets the maximum row outline level for the outline column. The maximum level determines how many hierarchical row levels the outline column supports. The default value is `10`.
ShowCheckBox	Gets or sets whether check boxes are displayed in the outline column. When this property is enabled, the outline column shows a check box for rows in the hierarchical display.
ShowImage	Gets or sets whether images are displayed in the outline column. When this property is enabled, the outline column can show the level images configured through Images for hierarchical rows.
ShowIndicator	Gets or sets whether the outline indicator is displayed in the outline column. The outline indicator shows the expand or collapse state for hierarchical rows displayed in the outline column.

Methods

Name	Description
GetCheckStatus(int)	Gets the check status of the row.
GetCollapsed(int)	Gets whether the specified row is collapsed in the outline column. Use this method to read the collapsed state of a row in the outline hierarchy.
Refresh()	Refreshes the outline column. Rebuilds the row outline hierarchy for the current outline column based on the current indent levels in the worksheet. Use this method after changing the hierarchical data or updating indent levels to apply the latest outline structure.
SetCheckStatus(int, bool)	Sets the check status of the row.
SetCollapsed(int, bool)	Sets whether the specified row is collapsed.