Namespace EasyXLS

Class ExcelDataGroup


  • public class ExcelDataGroup
    extends System.Object
    This class allows to group and outline the cell ranges.
    • Constructor Summary

      Constructors 
      Constructor Description
      ExcelDataGroup()
      Defines an instance of a data group.
      ExcelDataGroup​(int firstRow, int firstColumn, int lastRow, int lastColumn, int groupRowsColumns, bool isCollapsed)
      Defines an instance of a data group having the specified position, group per rows or columns and collapse options.
      ExcelDataGroup​(int firstRow, int firstColumn, int lastRow, int lastColumn, int groupRowsColumns, bool isCollapsed, ExcelAutoFormat xlsAutoFormat)
      Defines an instance of a data group having the specified position, group per rows or columns and collapse options.
      ExcelDataGroup​(System.String range, int groupRowsColumns, bool isCollapsed)
      Defines an instance of a data group having the specified position, group per rows or columns and collapse options.
      ExcelDataGroup​(System.String range, int groupRowsColumns, bool isCollapsed, ExcelAutoFormat xlsAutoFormat)
      Defines an instance of a data group having the specified position, group per rows or columns and collapse options.
    • Method Summary

      Modifier and Type Method Description
      ExcelDataGroup Clone()
      Creates and returns a copy of this object.
      ExcelAutoFormat getAutoFormat()
      Returns the autoformat to be applied.
      int getFirstColumn()
      Returns the first column index of the cells range where the data group is located.
      int getFirstRow()
      Returns the first row index of the cells range where the data group is located.
      int getGroupType()
      Returns the group per rows or columns option.
      int getLastColumn()
      Returns the last column index of the cells range where the data group is located.
      int getLastRow()
      Returns the last row index of the cells range where the data group is located.
      bool IsCollapsed()
      Returns true if the data group is collapsed, false if the data group is expanded.
      void setAutoFormat​(ExcelAutoFormat xlsAutoFormat)
      Sets the autoformat to be applied for the data group.
      void setCollapsed​(bool isCollapsed)
      Sets if the data group is collapsed or expanded.
      void setFirstColumn​(int firstColumn)
      Sets the first column of the cell range where the data group is located.
      void setFirstRow​(int firstRow)
      Sets the first row of the cell range where the data group is located.
      void setGroupType​(int groupRowsColumns)
      Sets the group per rows or columns option.
      void setLastColumn​(int lastColumn)
      Sets the last column of the cell range where the data group is located.
      void setLastRow​(int lastRow)
      Sets the last row of the cell range where the data group is located.
      void setRange​(int firstRow, int firstColumn, int lastRow, int lastColumn)
      Sets the area location of the data group.
      void setRange​(System.String range)
      Sets the area location of the data group.
    • Constructor Detail

      • ExcelDataGroup

        public ExcelDataGroup()
        Defines an instance of a data group.
      • ExcelDataGroup

        public ExcelDataGroup​(System.String range,
                              int groupRowsColumns,
                              bool isCollapsed)
        Defines an instance of a data group having the specified position, group per rows or columns and collapse options.
        Parameters:
        range - the area location of the data group. It can be a cell reference or a range.
        groupRowsColumns - the grouping per rows or columns option. Possible values are available in DataGroup class.
        isCollapsed - true if the data group is collapsed, false if the data group is expanded
      • ExcelDataGroup

        public ExcelDataGroup​(int firstRow,
                              int firstColumn,
                              int lastRow,
                              int lastColumn,
                              int groupRowsColumns,
                              bool isCollapsed)
        Defines an instance of a data group having the specified position, group per rows or columns and collapse options.
        Parameters:
        firstRow - first row index of the cells range
        firstColumn - first column index of the cells range
        lastRow - last row index of the cells range
        lastColumn - last column index of the cells range
        groupRowsColumns - the grouping per rows or columns option. Possible values are available in DataGroup class.
        isCollapsed - true if the data group is collapsed, false if the data group is expanded
      • ExcelDataGroup

        public ExcelDataGroup​(System.String range,
                              int groupRowsColumns,
                              bool isCollapsed,
                              ExcelAutoFormat xlsAutoFormat)
        Defines an instance of a data group having the specified position, group per rows or columns and collapse options.
        Parameters:
        range - the area location of the data group. It can be a cell reference or a range.
        groupRowsColumns - the grouping per rows or columns option. Possible values are available in DataGroup class.
        isCollapsed - true if the data group is collapsed, false if the data group is expanded
        xlsAutoFormat - the autoformat to be applied
      • ExcelDataGroup

        public ExcelDataGroup​(int firstRow,
                              int firstColumn,
                              int lastRow,
                              int lastColumn,
                              int groupRowsColumns,
                              bool isCollapsed,
                              ExcelAutoFormat xlsAutoFormat)
        Defines an instance of a data group having the specified position, group per rows or columns and collapse options.
        Parameters:
        firstRow - first row index of the cells range
        firstColumn - first column index of the cells range
        lastRow - last row index of the cells range
        lastColumn - last column index of the cells range
        groupRowsColumns - the grouping per rows or columns option. Possible values are available in DataGroup class.
        isCollapsed - true if the data group is collapsed, false if the data group is expanded
        xlsAutoFormat - the autoformat to be applied