ig.excel.UnfrozenPaneSettings

Class which controls the way unfrozen 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_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.ext_core.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
  • firstColumnInLeftPane

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

    Gets the first visible column in the left 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 left pane(s) of the worksheet and is used regardless of whether or not the worksheet is split vertically.

  • firstColumnInLeftPane

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

    Sets the first visible column in the left 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 left pane(s) of the worksheet and is used regardless of whether or not the worksheet is split vertically.

  • firstRowInTopPane

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

    Gets the first visible row in the top 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 top pane(s) of the worksheet and is used regardless of whether or not the worksheet is split horizontally.

  • firstRowInTopPane

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

    Sets the first visible row in the top 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 top pane(s) of the worksheet and is used regardless of whether or not the worksheet is split horizontally.

  • leftPaneWidth

    .leftPaneWidth( );
    Return Type:
    number
    Return Type Description:
    The width of the left pane, or zero if there is no horizontal pane split.

    Gets the width of the left pane in twips (1/20th of a point).

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException Thrown when the width specified is outside the valid width range (0 to 65535).

    Remarks

    If this value is zero, the left pane occupies the entire visible area of the worksheet. Otherwise, the left pane occupies the specified width and the right pane occupies the remaining area of the worksheet.

  • leftPaneWidth

    .leftPaneWidth( value:number );
    Return Type:
    number
    Return Type Description:
    The width of the left pane, or zero if there is no horizontal pane split.

    Sets the width of the left pane in twips (1/20th of a point).

    • value
    • Type:number

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException Thrown when the width specified is outside the valid width range (0 to 65535).

    Remarks

    If this value is zero, the left pane occupies the entire visible area of the worksheet. Otherwise, the left pane occupies the specified width and the right pane occupies the remaining area of the worksheet.

  • resetCore

    .resetCore( );

    Resets the unfrozen pane settings to their defaults.

    Remarks

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

  • topPaneHeight

    .topPaneHeight( );
    Return Type:
    number
    Return Type Description:
    The height of the top pane, or zero if there is no vertical pane split.

    Gets the height of the top pane in twips (1/20th of a point).

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException Thrown when the height specified is outside the valid height range (0 to 65535).

    Remarks

    If this value is zero, the top pane occupies the entire visible area of the worksheet. Otherwise, the top pane occupies the specified height and the bottom pane occupies the remaining area of the worksheet.

  • topPaneHeight

    .topPaneHeight( value:number );
    Return Type:
    number
    Return Type Description:
    The height of the top pane, or zero if there is no vertical pane split.

    Sets the height of the top pane in twips (1/20th of a point).

    • value
    • Type:number

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException Thrown when the height specified is outside the valid height range (0 to 65535).

    Remarks

    If this value is zero, the top pane occupies the entire visible area of the worksheet. Otherwise, the top pane occupies the specified height and the bottom pane occupies the remaining area of the worksheet.

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