ig.excel.FrozenPaneSettings

Class which controls the way frozen panes are arranged and used for a worksheet.

Remarks

Note: Frozen and unfrozen panes cannot be used simultaneously, so depending whether the panes are frozen or unfrozen, these settings may not be used or saved.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.

  • firstColumnInRightPane
    Inherited

    .firstColumnInRightPane( );
    Return Type:
    number
    Return Type Description:
    The zero-based index of the first visible column in the right pane(s).

    Gets the first visible column in the right pane(s) of the worksheet.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The assigned value is outside the valid column range (0 to one less than Workbook.maxExcelColumnCount or Workbook.maxExcel2007ColumnCount, depending on the workbook's Workbook.currentFormat).

    Remarks

    This affects the scroll position for the right pane(s) of the worksheet and is only used if the worksheet is split vertically.

  • firstColumnInRightPane
    Inherited

    .firstColumnInRightPane( value:number );
    Return Type:
    number
    Return Type Description:
    The zero-based index of the first visible column in the right pane(s).

    Sets the first visible column in the right pane(s) of the worksheet.

    • value
    • Type:number

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The assigned value is outside the valid column range (0 to one less than Workbook.maxExcelColumnCount or Workbook.maxExcel2007ColumnCount, depending on the workbook's Workbook.currentFormat).

    Remarks

    This affects the scroll position for the right pane(s) of the worksheet and is only used if the worksheet is split vertically.

  • firstRowInBottomPane
    Inherited

    .firstRowInBottomPane( );
    Return Type:
    number
    Return Type Description:
    The zero-based index of the first visible row in the bottom pane(s).

    Gets the first visible row in the bottom pane(s) of the worksheet.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The assigned value is outside the valid row range (0 to one less than Workbook.maxExcelRowCount or Workbook.maxExcel2007RowCount, depending on the workbook's Workbook.currentFormat).

    Remarks

    This affects the scroll position for the bottom pane(s) of the worksheet and is only used if the worksheet is split horizontally.

  • firstRowInBottomPane
    Inherited

    .firstRowInBottomPane( value:number );
    Return Type:
    number
    Return Type Description:
    The zero-based index of the first visible row in the bottom pane(s).

    Sets the first visible row in the bottom pane(s) of the worksheet.

    • value
    • Type:number

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The assigned value is outside the valid row range (0 to one less than Workbook.maxExcelRowCount or Workbook.maxExcel2007RowCount, depending on the workbook's Workbook.currentFormat).

    Remarks

    This affects the scroll position for the bottom pane(s) of the worksheet and is only used if the worksheet is split horizontally.

  • frozenColumns

    .frozenColumns( );
    Return Type:
    number
    Return Type Description:
    The number of columns frozen at the left of the worksheet.

    Gets the number of columns frozen at the left of the worksheet.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The assigned value is not a valid column count (0 to Workbook.maxExcelColumnCount or Workbook.maxExcel2007ColumnCount, depending on the workbook's Workbook.currentFormat).

    Remarks

    The frozen columns will always remain in view, regardless of the horizontal scroll position of the worksheet.

    Note: If the number of frozen columns specified is more than the amount of visible columns in the worksheet, the worksheet may not scroll correctly.

  • frozenColumns

    .frozenColumns( value:number );
    Return Type:
    number
    Return Type Description:
    The number of columns frozen at the left of the worksheet.

    Sets the number of columns frozen at the left of the worksheet.

    • value
    • Type:number

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The assigned value is not a valid column count (0 to Workbook.maxExcelColumnCount or Workbook.maxExcel2007ColumnCount, depending on the workbook's Workbook.currentFormat).

    Remarks

    The frozen columns will always remain in view, regardless of the horizontal scroll position of the worksheet.

    Note: If the number of frozen columns specified is more than the amount of visible columns in the worksheet, the worksheet may not scroll correctly.

  • frozenRows

    .frozenRows( );
    Return Type:
    number
    Return Type Description:
    The number of rows frozen at the top of the worksheet.

    Gets the number of rows frozen at the top of the worksheet.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The assigned value is not a valid row count (0 to Workbook.maxExcelRowCount or Workbook.maxExcel2007RowCount, depending on the workbook's Workbook.currentFormat).

    Remarks

    The frozen rows will always remain in view, regardless of the vertical scroll position of the worksheet.

    Note: If the number of frozen rows specified is more than the amount of visible rows in the worksheet, the worksheet may not scroll correctly.

  • frozenRows

    .frozenRows( value:number );
    Return Type:
    number
    Return Type Description:
    The number of rows frozen at the top of the worksheet.

    Sets the number of rows frozen at the top of the worksheet.

    • value
    • Type:number

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The assigned value is not a valid row count (0 to Workbook.maxExcelRowCount or Workbook.maxExcel2007RowCount, depending on the workbook's Workbook.currentFormat).

    Remarks

    The frozen rows will always remain in view, regardless of the vertical scroll position of the worksheet.

    Note: If the number of frozen rows specified is more than the amount of visible rows in the worksheet, the worksheet may not scroll correctly.

  • reset
    Inherited

    .reset( );

    Resets the pane settings to their defaults.

    Remarks

    The defaults used for each setting are the same defaults with which Microsoft Excel creates a blank worksheet.

  • resetCore

    .resetCore( );

    Resets the frozen pane settings to their defaults.

    Remarks

    The defaults used for each setting are the same defaults with which Microsoft Excel creates a blank worksheet.

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