ig.excel.DisplayOptions

Abstract base class which exposes the various display options available for a worksheet which can be saved with both a worksheet and a custom view.

Remarks

This class provides a way to control how a worksheet is displayed when it is viewed in Microsoft Excel.

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.

  • clearSelection

    .clearSelection( );

    Removes any saved selection information.

  • frozenPaneSettings

    .frozenPaneSettings( );
    Return Type:
    ig.excel.FrozenPaneSettings
    Return Type Description:
    The settings which control the frozen panes in the worksheet..

    Gets the settings which control the frozen panes in the worksheet.

    Remarks

    For these settings to be saved in the workbook file, DisplayOptions.panesAreFrozen must be True.

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

    See Also

  • gridlineColor

    .gridlineColor( );
    Return Type:
    string
    Return Type Description:
    The color of the gridlines on the worksheet.

    Gets the color of the gridlines on the worksheet.

    Exceptions

    Exception Description
    ig.InvalidOperationException The workbook is using a custom palette and setting this color would cause the custom palette to use too many colors.

    Remarks

    If the workbook is using a standard palette, the color set may be changed if it is not in the palette. In this case, the closest color in the standard palette will be used.

  • gridlineColor

    .gridlineColor( value:string );
    Return Type:
    string
    Return Type Description:
    The color of the gridlines on the worksheet.

    Sets the color of the gridlines on the worksheet.

    • value
    • Type:string

    Exceptions

    Exception Description
    ig.InvalidOperationException The workbook is using a custom palette and setting this color would cause the custom palette to use too many colors.

    Remarks

    If the workbook is using a standard palette, the color set may be changed if it is not in the palette. In this case, the closest color in the standard palette will be used.

  • panesAreFrozen

    .panesAreFrozen( );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates if the panes in the worksheet are frozen.

    Gets the value which indicates if the panes in the worksheet are frozen.

    Remarks

    Depending on the value of this property, either the DisplayOptions.frozenPaneSettings or the DisplayOptions.unfrozenPaneSettings will be used for the worksheet. The unused settings are ignored and are not saved with the workbook stream.

    See Also

  • panesAreFrozen

    .panesAreFrozen( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates if the panes in the worksheet are frozen.

    Sets the value which indicates if the panes in the worksheet are frozen.

    • value
    • Type:boolean

    Remarks

    Depending on the value of this property, either the DisplayOptions.frozenPaneSettings or the DisplayOptions.unfrozenPaneSettings will be used for the worksheet. The unused settings are ignored and are not saved with the workbook stream.

    See Also

  • reset

    .reset( );

    Resets the display options to their default settings.

    Remarks

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

  • resetCore

    .resetCore( );

    Resets the display options to their default settings.

    Remarks

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

  • showExpansionIndicatorBelowGroupedRows

    .showExpansionIndicatorBelowGroupedRows( );

    Gets the value which indicates whether the expansion indicators should be shown below grouped, or indented rows.

  • showExpansionIndicatorBelowGroupedRows

    .showExpansionIndicatorBelowGroupedRows( value:boolean );

    Sets the value which indicates whether the expansion indicators should be shown below grouped, or indented rows.

    • value
    • Type:boolean

  • showExpansionIndicatorToRightOfGroupedColumns

    .showExpansionIndicatorToRightOfGroupedColumns( );

    Gets the value which indicates whether the expansion indicators should be shown to the right of grouped, or indented rows.

  • showExpansionIndicatorToRightOfGroupedColumns

    .showExpansionIndicatorToRightOfGroupedColumns( value:boolean );

    Sets the value which indicates whether the expansion indicators should be shown to the right of grouped, or indented rows.

    • value
    • Type:boolean

  • showFormulasInCells

    .showFormulasInCells( );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates whether formulas are shown in cells.

    Gets the value which indicates whether formulas are shown in cells.

    Remarks

    If this value is True, the formula string will be displayed in the cell. If the value is False, the result of the formula will be displayed in the cell.

  • showFormulasInCells

    .showFormulasInCells( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates whether formulas are shown in cells.

    Sets the value which indicates whether formulas are shown in cells.

    • value
    • Type:boolean

    Remarks

    If this value is True, the formula string will be displayed in the cell. If the value is False, the result of the formula will be displayed in the cell.

  • showGridlines

    .showGridlines( );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates whether gridlines are shown between cells.

    Gets the value which indicates whether gridlines are shown between cells.

    See Also

  • showGridlines

    .showGridlines( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates whether gridlines are shown between cells.

    Sets the value which indicates whether gridlines are shown between cells.

    • value
    • Type:boolean

    See Also

  • showOutlineSymbols

    .showOutlineSymbols( );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates whether outline symbols are shown for outlined columns and rows.

    Gets the value which indicates whether outline symbols are shown for outlined columns and rows.

    Remarks

    If the outline symbols are displayed, they provide a visual representation of the outline levels or rows and columns in Microsoft Excel. In addition, the outline symbols include the expansion indicators which allow for the expanding and collapsing of outline groups.

    See Also

  • showOutlineSymbols

    .showOutlineSymbols( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates whether outline symbols are shown for outlined columns and rows.

    Sets the value which indicates whether outline symbols are shown for outlined columns and rows.

    • value
    • Type:boolean

    Remarks

    If the outline symbols are displayed, they provide a visual representation of the outline levels or rows and columns in Microsoft Excel. In addition, the outline symbols include the expansion indicators which allow for the expanding and collapsing of outline groups.

    See Also

  • showRowAndColumnHeaders

    .showRowAndColumnHeaders( );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates whether to display row and column headers.

    Gets the value which indicates whether to display row and column headers.

    Remarks

    The row and column headers show the identifier of the row or column. They also allow the user to easily select all cells in a row or column by clicking them.

    See Also

  • showRowAndColumnHeaders

    .showRowAndColumnHeaders( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates whether to display row and column headers.

    Sets the value which indicates whether to display row and column headers.

    • value
    • Type:boolean

    Remarks

    The row and column headers show the identifier of the row or column. They also allow the user to easily select all cells in a row or column by clicking them.

    See Also

  • showRulerInPageLayoutView

    .showRulerInPageLayoutView( );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates whether to show rulers in the page layout view.

    Gets the value which indicates whether to show rulers in the page layout view.

    Remarks

    When this value is True, one ruler will display above the column headers of the active page in page layout view. Another ruler will also display before the row headers of the active page.

    Note: This property will only affect the worksheet view if the DisplayOptions.view is PageLayout.

    Note: The WorksheetView value of PageLayout is only supported in Excel 2007. If a worksheet with that View is viewed in earlier versions of Microsoft Excel, the view will default to Normal view.

    See Also

  • showRulerInPageLayoutView

    .showRulerInPageLayoutView( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates whether to show rulers in the page layout view.

    Sets the value which indicates whether to show rulers in the page layout view.

    • value
    • Type:boolean

    Remarks

    When this value is True, one ruler will display above the column headers of the active page in page layout view. Another ruler will also display before the row headers of the active page.

    Note: This property will only affect the worksheet view if the DisplayOptions.view is PageLayout.

    Note: The WorksheetView value of PageLayout is only supported in Excel 2007. If a worksheet with that View is viewed in earlier versions of Microsoft Excel, the view will default to Normal view.

    See Also

  • showZeroValues

    .showZeroValues( );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates whether zero values are shown in cells.

    Gets the value which indicates whether zero values are shown in cells.

    Remarks

    If this value is True, cells with a value of zero will display their values; otherwise, those cells will display as blanks.

  • showZeroValues

    .showZeroValues( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates whether zero values are shown in cells.

    Sets the value which indicates whether zero values are shown in cells.

    • value
    • Type:boolean

    Remarks

    If this value is True, cells with a value of zero will display their values; otherwise, those cells will display as blanks.

  • unfrozenPaneSettings

    .unfrozenPaneSettings( );
    Return Type:
    ig.excel.UnfrozenPaneSettings
    Return Type Description:
    The settings which control the unfrozen panes in the worksheet.

    Gets the settings which control the unfrozen panes in the worksheet.

    Remarks

    For these settings to be saved in the workbook file, DisplayOptions.panesAreFrozen must be False.

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

    See Also

  • view

    .view( );
    Return Type:
    ig.excel.WorksheetView
    Return Type Description:
    The current view of the worksheet.

    Gets the current view of the worksheet.

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The value assigned is not defined in the WorksheetView enumeration.

    Remarks

    The view determines the overall display of the worksheet in Microsoft Excel.

    Note: The WorksheetView value of PageLayout is only supported in Excel 2007. If a worksheet with that View is viewed in earlier versions of Microsoft Excel, the view will default to Normal view.

    See Also

  • view

    .view( value:ig.excel.WorksheetView );
    Return Type:
    ig.excel.WorksheetView
    Return Type Description:
    The current view of the worksheet.

    Sets the current view of the worksheet.

    • value
    • Type:ig.excel.WorksheetView

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The value assigned is not defined in the WorksheetView enumeration.

    Remarks

    The view determines the overall display of the worksheet in Microsoft Excel.

    Note: The WorksheetView value of PageLayout is only supported in Excel 2007. If a worksheet with that View is viewed in earlier versions of Microsoft Excel, the view will default to Normal view.

    See Also

  • visibility

    .visibility( );
    Return Type:
    ig.excel.WorksheetVisibility
    Return Type Description:
    The visibility of the worksheet.

    Gets the visibility of the worksheet.

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The value assigned is not defined in the WorksheetVisibility enumeration.

    Remarks

    The visibility determines whether the worksheet's tab will appear in the tab bar at the bottom of Microsoft Excel.

  • visibility

    .visibility( value:ig.excel.WorksheetVisibility );
    Return Type:
    ig.excel.WorksheetVisibility
    Return Type Description:
    The visibility of the worksheet.

    Sets the visibility of the worksheet.

    • value
    • Type:ig.excel.WorksheetVisibility

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The value assigned is not defined in the WorksheetVisibility enumeration.

    Remarks

    The visibility determines whether the worksheet's tab will appear in the tab bar at the bottom of Microsoft Excel.

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