Ignite UI API Reference

ig.excel.CustomViewWindowOptions

Represents the workbook window options which are saved with custom views.

Remarks

The properties explicitly defined on this class and not inherited from the base class, WindowOptions, are options that can be saved with a custom view, but not with a workbook. Therefore, these properties will not be applied when the CustomView.apply method is called.

Dependencies

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

    .boundsInPixels( );
    Return Type:
    object
    Return Type Description:
    The pixel bounds of the workbook's MDI child window when CustomView owning these window options is applied. This will be an object with numeric values for properties 'x', 'y', 'width', 'height', 'left', 'top', 'right', and 'bottom'.

    Gets the pixel bounds of the workbook's MDI child window when CustomView owning these window options is applied.

    Exceptions

    Exception Description
    ig.ArgumentException The left or top of the value assigned is outside the bounds of -32768 and 32767.
    ig.ArgumentException The width or height of the value assigned is outside the bounds of 0 and 65535.

    Remarks

    Note: This property will have no affect on the workbook if CustomViewWindowOptions.maximized is True. However, in this case, the value of this property will still be saved with the workbook.

    Note: This setting cannot be saved with a Workbook in the Excel file. It can only be saved with a CustomView. Therefore, there is no corresponding property in WorkbookWindowOptions and calling Apply on the associated CustomView will not apply this property. Only by applying the custom view through the Microsoft Excel user interface will the setting on this property be applied.

  • boundsInPixels

    .boundsInPixels( value:object );
    Return Type:
    object
    Return Type Description:
    The pixel bounds of the workbook's MDI child window when CustomView owning these window options is applied. This will be an object with numeric values for properties 'x', 'y', 'width', 'height', 'left', 'top', 'right', and 'bottom'.

    Sets the pixel bounds of the workbook's MDI child window when CustomView owning these window options is applied.

    • value
    • Type:object
    • This can be an object with numeric values for properties 'x', 'y', 'width', and 'height' or 'left', 'top', 'right', and 'bottom' such as { x: 1, y: 2, width: 100, height: 200 }.

    Exceptions

    Exception Description
    ig.ArgumentException The left or top of the value assigned is outside the bounds of -32768 and 32767.
    ig.ArgumentException The width or height of the value assigned is outside the bounds of 0 and 65535.

    Remarks

    Note: This property will have no affect on the workbook if CustomViewWindowOptions.maximized is True. However, in this case, the value of this property will still be saved with the workbook.

    Note: This setting cannot be saved with a Workbook in the Excel file. It can only be saved with a CustomView. Therefore, there is no corresponding property in WorkbookWindowOptions and calling Apply on the associated CustomView will not apply this property. Only by applying the custom view through the Microsoft Excel user interface will the setting on this property be applied.

  • maximized

    .maximized( );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether the workbook's MDI child window will be maximized when the CustomView owning these window options is applied.

    Gets the value indicating whether the workbook's MDI child window will be maximized when the CustomView owning these window options is applied.

    Remarks

    Note: This setting cannot be saved with a Workbook in the Excel file. It can only be saved with a CustomView. Therefore, there is no corresponding property in WorkbookWindowOptions and calling Apply on the associated CustomView will not apply this property. Only by applying the custom view through the Microsoft Excel user interface will the setting on this property be applied.

  • maximized

    .maximized( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether the workbook's MDI child window will be maximized when the CustomView owning these window options is applied.

    Sets the value indicating whether the workbook's MDI child window will be maximized when the CustomView owning these window options is applied.

    • value
    • Type:boolean

    Remarks

    Note: This setting cannot be saved with a Workbook in the Excel file. It can only be saved with a CustomView. Therefore, there is no corresponding property in WorkbookWindowOptions and calling Apply on the associated CustomView will not apply this property. Only by applying the custom view through the Microsoft Excel user interface will the setting on this property be applied.

  • reset

    .reset( );

    Resets the window options to their default settings.

    Remarks

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

  • showFormulaBar

    .showFormulaBar( );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether Microsoft Excel will display the formula bar when the CustomView owning these window options is applied.

    Gets the value indicating whether Microsoft Excel will display the formula bar when the CustomView owning these window options is applied.

    Remarks

    Note: This setting cannot be saved with a Workbook in the Excel file. It can only be saved with a CustomView. Therefore, there is no corresponding property in WorkbookWindowOptions and calling CustomView.apply on the associated CustomView will not apply this property. Only by applying the custom view through the Microsoft Excel user interface will the setting on this property be applied.

  • showFormulaBar

    .showFormulaBar( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether Microsoft Excel will display the formula bar when the CustomView owning these window options is applied.

    Sets the value indicating whether Microsoft Excel will display the formula bar when the CustomView owning these window options is applied.

    • value
    • Type:boolean

    Remarks

    Note: This setting cannot be saved with a Workbook in the Excel file. It can only be saved with a CustomView. Therefore, there is no corresponding property in WorkbookWindowOptions and calling CustomView.apply on the associated CustomView will not apply this property. Only by applying the custom view through the Microsoft Excel user interface will the setting on this property be applied.

  • showStatusBar

    .showStatusBar( );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether Microsoft Excel will display the status bar when the CustomView owning these window options is applied.

    Gets the value indicating whether Microsoft Excel will display the status bar when the CustomView owning these window options is applied.

    Remarks

    Note: This setting cannot be saved with a Workbook in the Excel file. It can only be saved with a CustomView. Therefore, there is no corresponding property in WorkbookWindowOptions and calling Apply on the associated CustomView will not apply this property. Only by applying the custom view through the Microsoft Excel user interface will the setting on this property be applied.

  • showStatusBar

    .showStatusBar( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether Microsoft Excel will display the status bar when the CustomView owning these window options is applied.

    Sets the value indicating whether Microsoft Excel will display the status bar when the CustomView owning these window options is applied.

    • value
    • Type:boolean

    Remarks

    Note: This setting cannot be saved with a Workbook in the Excel file. It can only be saved with a CustomView. Therefore, there is no corresponding property in WorkbookWindowOptions and calling Apply on the associated CustomView will not apply this property. Only by applying the custom view through the Microsoft Excel user interface will the setting on this property be applied.

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

#