WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class OutlinesPanel - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class OutlinesPanel

    Represents a panel which is used to position and arrange the grouping elements such as expand buttons, collapse buttons, etc.

    Inheritance
    System.Object
    OutlinesPanel
    Implements
    System.IDisposable
    Namespace: Syncfusion.Windows.Forms.Spreadsheet
    Assembly: Syncfusion.Spreadsheet.Windows.dll
    Syntax
    public class OutlinesPanel : Panel, IDisposable
    Remarks

    Holds all the operations involved with the Grouping elements.

    Constructors

    OutlinesPanel(SpreadsheetGrid, OutlinesPanel.GroupingOrientaion)

    Declaration
    public OutlinesPanel(SpreadsheetGrid grid, OutlinesPanel.GroupingOrientaion groupingOrientation)
    Parameters
    Type Name Description
    SpreadsheetGrid grid
    OutlinesPanel.GroupingOrientaion groupingOrientation

    Properties

    ActiveGrid

    Gets or sets the instance of the active SpreadsheetGrid which displays the data in SfSpreadsheet.

    Declaration
    public SpreadsheetGrid ActiveGrid { get; set; }
    Property Value
    Type Description
    SpreadsheetGrid

    An instance of SpreadsheetGrid.

    Orientation

    Gets or sets the orientation of the Outlines panel.

    Declaration
    public OutlinesPanel.GroupingOrientaion Orientation { get; set; }
    Property Value
    Type Description
    OutlinesPanel.GroupingOrientaion

    One of the OutlinesPanel.GroupingOrientaion enumeration that specifies the panel orientation.

    Remarks

    The Orientation of the panel is either horizontal or vertical.

    SfSpreadsheet

    Gets or sets the instance of the SfSpreadsheet which is used to view, edit and create excel files.

    Declaration
    public Spreadsheet SfSpreadsheet { get; set; }
    Property Value
    Type Description
    Spreadsheet

    An instance of SfSpreadsheet.

    Methods

    AddGroupingElements(IOutlineWrapper)

    Add the SpreadsheetGroupButton as a OutlinesPanel element and updates the grouping state

    Declaration
    protected virtual void AddGroupingElements(IOutlineWrapper outlineWrapper)
    Parameters
    Type Name Description
    IOutlineWrapper outlineWrapper

    Contains the information about the outline

    AddOutlineLabelButtons(WorksheetImpl)

    Adds the Outline label buttons as OutlinesPanel elements.

    Declaration
    protected virtual void AddOutlineLabelButtons(WorksheetImpl worksheetImpl)
    Parameters
    Type Name Description
    WorksheetImpl worksheetImpl

    An instance of WorksheetImpl

    Remarks

    Invokes the CollapseAllGroupCommand to perform expand/collapse operations based on outline value

    Dispose()

    Dispose all the instance used by the OutlinesPanel class.

    Declaration
    public void Dispose()
    Remarks

    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

    Dispose(Boolean)

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    OnPaint(PaintEventArgs)

    Declaration
    protected override void OnPaint(PaintEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.PaintEventArgs e

    WndProc(ref Message)

    Used to make the HitTestVisible as false

    Declaration
    protected override void WndProc(ref Message m)
    Parameters
    Type Name Description
    System.Windows.Forms.Message m

    Implements

    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved