Ignite UI API Reference

ig.excel.RowColumnBase

Abstract base class for worksheet row and worksheet column.

Dependencies

jquery-1.4.4.js
infragistics.util.js
The current widget has no options.
The current widget has no events.
  • cellFormat

    .cellFormat( );
    Return Type:
    ig.excel.IWorksheetCellFormat
    Return Type Description:
    The default cell format for cells in this row or column.

    Gets the default cell format for cells in this row or column.

    Remarks

    Any default properties of the cell's format will take their value from this format when getting a resolved format.

  • getResolvedCellFormat

    .getResolvedCellFormat( );
    Return Type:
    ig.excel.IWorksheetCellFormat
    Return Type Description:
    A format object describing the actual formatting that will be used when displayed the row or column in Microsoft Excel.

    Gets the resolved cell formatting for the cells in the row or column.

    Exceptions

    Exception Description
    ig.InvalidOperationException If the object was removed from the worksheet.
  • hidden

    .hidden( );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether the row or column is hidden.

    Gets the value indicating whether the row or column is hidden.

    Exceptions

    Exception Description
    ig.InvalidOperationException From the stter if the object was removed from the worksheet.

    Remarks

    The Hidden state also controls the expanded state of rows or columns in outline groups. Basically, an outline group simply provides an easy way to hide and unhide all rows or columns in the group at the same time, via the expansion indicator.
  • hidden

    .hidden( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether the row or column is hidden.

    Sets the value indicating whether the row or column is hidden.

    • value
    • Type:boolean

    Exceptions

    Exception Description
    ig.InvalidOperationException From the stter if the object was removed from the worksheet.

    Remarks

    The Hidden state also controls the expanded state of rows or columns in outline groups. Basically, an outline group simply provides an easy way to hide and unhide all rows or columns in the group at the same time, via the expansion indicator.
  • index

    .index( );
    Return Type:
    number
    Return Type Description:
    The 0-based index of the row or column in the worksheet.

    Gets the 0-based index of the row or column in the worksheet.

  • outlineLevel

    .outlineLevel( );
    Return Type:
    number
    Return Type Description:
    The outline level for the row or column.

    Gets the outline level for the row or column.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The value assigned is outside the valid outline level range of 0 and 7.
    ig.InvalidOperationException From the stter if the object was removed from the worksheet.

    Remarks

    Microsoft Excel supports hierarchical grouping of rows and columns with a maximum of seven levels of hierarchy. To create a group, set adjacent rows or columns to same outline level. When rows or columns are grouped, an outline indicator will provide a visual representation of the outline level. In addition, an outline group has an expansion indicator at one end of the group, which allows the user to easily hide and unhide all rows or column in the group with a single click.

  • outlineLevel

    .outlineLevel( value:number );
    Return Type:
    number
    Return Type Description:
    The outline level for the row or column.

    Sets the outline level for the row or column.

    • value
    • Type:number

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The value assigned is outside the valid outline level range of 0 and 7.
    ig.InvalidOperationException From the stter if the object was removed from the worksheet.

    Remarks

    Microsoft Excel supports hierarchical grouping of rows and columns with a maximum of seven levels of hierarchy. To create a group, set adjacent rows or columns to same outline level. When rows or columns are grouped, an outline indicator will provide a visual representation of the outline level. In addition, an outline group has an expansion indicator at one end of the group, which allows the user to easily hide and unhide all rows or column in the group with a single click.

  • worksheet

    .worksheet( );
    Return Type:
    ig.excel.Worksheet
    Return Type Description:
    The worksheet to which the row or column belongs.

    Gets the worksheet to which the row or column belongs.

Copyright © 1996 - 2019 Infragistics, Inc. All rights reserved.

#