• DR-IT Software
  • Products
  • Documentation
  • Product page
  • Examples
  • API reference
  • Support
Show / Hide Table of Contents

Class PaneCollection

Represents the pane collection class used by the spreadsheet model.

Inheritance
object
PaneCollection
Implements
IEnumerable<Pane>
IEnumerable
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: DRIT.Spreadsheet
Assembly: DRIT.Spreadsheet.dll
Syntax
public class PaneCollection : IEnumerable<Pane>, IEnumerable

Properties

ActivePane

Exposes the active pane associated with PaneCollection.

Declaration
public Pane ActivePane { get; set; }
Property Value
Type Description
Pane

The active pane returned by the operation.

BottomLeftPane

Exposes the bottom left pane associated with PaneCollection.

Declaration
public Pane BottomLeftPane { get; }
Property Value
Type Description
Pane

BottomRightPane

Exposes the bottom right pane associated with PaneCollection.

Declaration
public Pane BottomRightPane { get; }
Property Value
Type Description
Pane

Count

Reports the number of items currently held by PaneCollection.

Declaration
public int Count { get; }
Property Value
Type Description
int

The count returned by the operation.

TopLeftPane

Converts the supplied data for use with PaneCollection.

Declaration
public Pane TopLeftPane { get; }
Property Value
Type Description
Pane

TopRightPane

Converts the supplied data for use with PaneCollection.

Declaration
public Pane TopRightPane { get; }
Property Value
Type Description
Pane

Methods

Clear()

Removes all frozen panes and splits.

Declaration
public void Clear()

FreezeColumns(int)

Freeze the specified number of columns on the left.

Declaration
public void FreezeColumns(int columns)
Parameters
Type Name Description
int columns

FreezeFirstColumn()

Exposes the freeze first column associated with PaneCollection.

Declaration
public void FreezeFirstColumn()

FreezePanes(Cell)

Processes the supplied spreadsheet data for this object.

Declaration
public void FreezePanes(Cell cell)
Parameters
Type Name Description
Cell cell

FreezePanes(int, int)

Processes the supplied spreadsheet data for this object.

Declaration
public void FreezePanes(int columns, int rows)
Parameters
Type Name Description
int columns

The columns used by the operation.

int rows

The rows used by the operation.

FreezePanes(string)

Processes the supplied spreadsheet data for this object.

Declaration
public void FreezePanes(string cellLabel)
Parameters
Type Name Description
string cellLabel

The cell label used by the operation.

FreezeRows(int)

Freeze the specified number of rows on the top.

Declaration
public void FreezeRows(int rows)
Parameters
Type Name Description
int rows

FreezeTopRow()

Exposes the freeze top row associated with PaneCollection.

Declaration
public void FreezeTopRow()

GetEnumerator()

Retrieves the requested enumerator from PaneCollection.

Declaration
public IEnumerator<Pane> GetEnumerator()
Returns
Type Description
IEnumerator<Pane>

The get enumerator returned by the operation.

SplitPanes(int, int)

Processes the supplied spreadsheet data for this object.

Declaration
public void SplitPanes(int columns, int rows)
Parameters
Type Name Description
int columns
int rows
Remarks

The active pane will be the top-left pane by default.

SplitPanes(string)

Processes the supplied spreadsheet data for this object.

Declaration
public void SplitPanes(string cellLabel)
Parameters
Type Name Description
string cellLabel

The cell label used by the operation.

UnfreezePanes()

Exposes the unfreeze panes associated with PaneCollection.

Declaration
public void UnfreezePanes()

Implements

IEnumerable<T>
IEnumerable
Back to top

DR-IT Software documentation

DR-IT Software · Products · Documentation index · Product page · Downloads · Support · Licensing

Generated by DocFX