Ignite UI API Reference

ig.excel.WorksheetDisplayOptions

Class which exposes the display options which can only be controlled through the worksheet.

Dependencies

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

    .magnificationInNormalView( );
    Return Type:
    number
    Return Type Description:
    The magnification level of the worksheet when it is displayed in normal view.

    Gets the magnification level of the worksheet when it is displayed in normal view.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The assigned value is outside the valid range of magnification levels for a worksheet. The level must be between 10 and 400.

    Remarks

    Magnifications are stored as percentages of the normal viewing magnification. A value of 100 indicates normal magnification whereas a value of 200 indicates a zoom that is twice the normal viewing magnification.

  • magnificationInNormalView

    .magnificationInNormalView( value:number );
    Return Type:
    number
    Return Type Description:
    The magnification level of the worksheet when it is displayed in normal view.

    Sets the magnification level of the worksheet when it is displayed in normal view.

    • value
    • Type:number

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The assigned value is outside the valid range of magnification levels for a worksheet. The level must be between 10 and 400.

    Remarks

    Magnifications are stored as percentages of the normal viewing magnification. A value of 100 indicates normal magnification whereas a value of 200 indicates a zoom that is twice the normal viewing magnification.

  • magnificationInPageBreakView

    .magnificationInPageBreakView( );
    Return Type:
    number
    Return Type Description:
    The magnification level of the worksheet when it is displayed in the page break preview.

    Gets the magnification level of the worksheet when it is displayed in the page break preview.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The assigned value is outside the valid range of magnification levels for a worksheet. The level must be between 10 and 400.

    Remarks

    Magnifications are stored as percentages of the normal viewing magnification. A value of 100 indicates normal magnification whereas a value of 200 indicates a zoom that is twice the normal viewing magnification.

  • magnificationInPageBreakView

    .magnificationInPageBreakView( value:number );
    Return Type:
    number
    Return Type Description:
    The magnification level of the worksheet when it is displayed in the page break preview.

    Sets the magnification level of the worksheet when it is displayed in the page break preview.

    • value
    • Type:number

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The assigned value is outside the valid range of magnification levels for a worksheet. The level must be between 10 and 400.

    Remarks

    Magnifications are stored as percentages of the normal viewing magnification. A value of 100 indicates normal magnification whereas a value of 200 indicates a zoom that is twice the normal viewing magnification.

  • magnificationInPageLayoutView

    .magnificationInPageLayoutView( );
    Return Type:
    number
    Return Type Description:
    The magnification level of the worksheet when it is displayed in page layout view.

    Gets the magnification level of the worksheet when it is displayed in page layout view.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The assigned value is outside the valid range of magnification levels for a worksheet. The level must be between 10 and 400.

    Remarks

    Magnifications are stored as percentages of the normal viewing magnification. A value of 100 indicates normal magnification whereas a value of 200 indicates a zoom that is twice the normal viewing magnification.

  • magnificationInPageLayoutView

    .magnificationInPageLayoutView( value:number );
    Return Type:
    number
    Return Type Description:
    The magnification level of the worksheet when it is displayed in page layout view.

    Sets the magnification level of the worksheet when it is displayed in page layout view.

    • value
    • Type:number

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The assigned value is outside the valid range of magnification levels for a worksheet. The level must be between 10 and 400.

    Remarks

    Magnifications are stored as percentages of the normal viewing magnification. A value of 100 indicates normal magnification whereas a value of 200 indicates a zoom that is twice the normal viewing magnification.

  • orderColumnsRightToLeft

    .orderColumnsRightToLeft( );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether the columns are ordered right to left.

    Gets the value indicating whether the columns are ordered right to left.

    Remarks

    If the columns are ordered right to left, other aspects of the worksheet display differently. The vertical scrollbar will display on the left side of the worksheet and the worksheet tab bar, usually displayed on the left side of the worksheet, will display on the right side.

  • orderColumnsRightToLeft

    .orderColumnsRightToLeft( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether the columns are ordered right to left.

    Sets the value indicating whether the columns are ordered right to left.

    • value
    • Type:boolean

    Remarks

    If the columns are ordered right to left, other aspects of the worksheet display differently. The vertical scrollbar will display on the left side of the worksheet and the worksheet tab bar, usually displayed on the left side of the worksheet, will display on the right side.

  • 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.

  • showWhitespaceInPageLayoutView

    .showWhitespaceInPageLayoutView( );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates whether to show white page between worksheet pages in page layout view.

    Gets the value which indicates whether to show whitespace between worksheet pages in page layout view.

    Remarks

    Note: For this value to affect the display of the worksheet, the DisplayOptions.view must be set to PageLayout. However, if a different view is used, this is still saved with the workbook.

    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.

  • showWhitespaceInPageLayoutView

    .showWhitespaceInPageLayoutView( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates whether to show white page between worksheet pages in page layout view.

    Sets the value which indicates whether to show whitespace between worksheet pages in page layout view.

    • value
    • Type:boolean

    Remarks

    Note: For this value to affect the display of the worksheet, the DisplayOptions.view must be set to PageLayout. However, if a different view is used, this is still saved with the workbook.

    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.

  • tabColorInfo

    .tabColorInfo( );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    The WorkbookColorInfo to use for the associated worksheet's tab in the tab bar of Microsoft Excel.

    Gets the WorkbookColorInfo to use for the associated worksheet's tab in the tab bar of Microsoft Excel.

    Remarks

    If the tab bar is not visible, this color will not be seen.

  • tabColorInfo

    .tabColorInfo( value:ig.excel.WorkbookColorInfo );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    The WorkbookColorInfo to use for the associated worksheet's tab in the tab bar of Microsoft Excel.

    Sets the WorkbookColorInfo to use for the associated worksheet's tab in the tab bar of Microsoft Excel.

    • value
    • Type:ig.excel.WorkbookColorInfo

    Remarks

    If the tab bar is not visible, this color will not be seen.

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

#