Click or drag to resize
ExcelColumnRowBaseOutlineLevel Property
Gets or sets outline level.

Namespace:  GemBox.Spreadsheet
Assembly:  GemBox.Spreadsheet (in GemBox.Spreadsheet.dll) Version: 41.3.30.1032
Syntax
public int OutlineLevel { get; set; }

Property Value

Type: Int32
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionValue is out of 0 to 7 range.
Remarks

Exception is thrown if value is out of 0 to 7 range.

Using this property you can create hierarchical groups. Range of consecutive objects (rows or columns) with the same value of outline level belongs to the same group. Default value is zero, which prevents grouping.

When you use outline grouping and you want outline group to be collapsed, you need to set three properties:

OutlineLevel property needs to be set to correct outline level.

If group is collapsed, for all rows in the collapsed group Hidden property needs to be set to .

If group is collapsed, for the row where collapsed (plus) sign is located Collapsed property needs to be set to .

This value is currently ignored when exporting a document to PDF, XPS or image file formats.

Examples

Following code creates two horizontal groups and one vertical group. Horizontal groups have outline button above (default is below), while vertical group is collapsed.

static void GroupingAndOutline(ExcelWorksheet ws)
{
    ws.Cells[0, 0].Value = "Grouping and outline example:";

    //Vertical grouping.
    ws.Cells[2, 0].Value = "GroupA Start";
    ws.Rows[2].OutlineLevel = 1;
    ws.Cells[3, 0].Value = "A";
    ws.Rows[3].OutlineLevel = 1;
    ws.Cells[4, 1].Value = "GroupB Start";
    ws.Rows[4].OutlineLevel = 2;
    ws.Cells[5, 1].Value = "B";
    ws.Rows[5].OutlineLevel = 2;
    ws.Cells[6, 1].Value = "GroupB End";
    ws.Rows[6].OutlineLevel = 2;
    ws.Cells[7, 0].Value = "GroupA End";
    ws.Rows[7].OutlineLevel = 1;
    // Put outline row buttons above groups.
    ws.ViewOptions.OutlineRowButtonsBelow = false;

    //Horizontal grouping (collapsed).
    ws.Cells["E2"].Value = "Gr.C Start";
    ws.Columns["E"].OutlineLevel = 1;
    ws.Columns["E"].Hidden = true;
    ws.Cells["F2"].Value = "C";
    ws.Columns["F"].OutlineLevel = 1;
    ws.Columns["F"].Hidden = true;
    ws.Cells["G2"].Value = "Gr.C End";
    ws.Columns["G"].OutlineLevel = 1;
    ws.Columns["G"].Hidden = true;
    ws.Columns["H"].Collapsed = true;
}
See Also