Class OutlinesPanel
Represents a panel which is used to position and arrange the grouping elements such as expand buttons, collapse buttons, etc.
Inheritance
Implements
Namespace: Syncfusion.UI.Xaml.Spreadsheet
Assembly: Syncfusion.SfSpreadsheet.WPF.dll
Syntax
public class OutlinesPanel : Panel, IDisposableRemarks
Holds all the operations involved with the Grouping elements.
Constructors
OutlinesPanel()
Initializes a new instance of the OutlinesPanel class.
Declaration
public OutlinesPanel()Fields
GroupLineColorProperty
Dependency property of GroupLineColor
Declaration
public static readonly DependencyProperty GroupLineColorPropertyField Value
| Type |
|---|
| System.Windows.DependencyProperty |
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. |
GroupLineColor
Gets or sets the fill color for lines between groups.
Declaration
public Brush GroupLineColor { get; set; }Property Value
| Type |
|---|
| System.Windows.Media.Brush |
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 SfSpreadsheet SfSpreadsheet { get; set; }Property Value
| Type | Description |
|---|---|
| SfSpreadsheet | 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
ArrangeOverride(Size)
Arranges the content of OutlinesPanel in SfSpreadsheet.
Declaration
protected override Size ArrangeOverride(Size finalSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Size | finalSize | The final size which the panel used to arrange itself. |
Returns
| Type | Description |
|---|---|
| System.Windows.Size | The actual size used. |
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 virtual void Dispose(bool disposing)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | disposing |
MeasureOverride(Size)
When overridden in a derived class, measures the size in layout required for child elements and determines a size for the OutlinesPanelderived class.
Declaration
protected override Size MeasureOverride(Size availableSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Size | availableSize | The size that the panel can occupy. |
Returns
| Type | Description |
|---|---|
| System.Windows.Size | The desired size of OutlinesPanel. |
OnRender(DrawingContext)
Draws the content of a System.Windows.Media.DrawingContext object during the render pass of a OutlinesPanel element.
Declaration
protected override void OnRender(DrawingContext dc)Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Media.DrawingContext | dc | The System.Windows.Media.DrawingContext object to draw. |
Remarks
Draws the horizontal and vertical grouping lines based on the grouping range.