ig.excel.WorkbookWindowOptions

Represents the window options which are saved with the workbook.

Remarks

The properties explicitly defined on this class and not inherited from the base class, WindowOptions, are options that can be saved with a workbook, but not with a custom view.

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.

  • boundsInTwips

    .boundsInTwips( );
    Return Type:
    object
    Return Type Description:
    The bounds of the workbook's MDI child window in twips (1/20th of a point). This will be an object with numeric values for properties 'x', 'y', 'width', 'height', 'left', 'top', 'right', and 'bottom'.

    Gets the bounds of the workbook's MDI child window in twips (1/20th of a point).

    Exceptions

    Exception Description
    ig.ArgumentException The width or height of the value assigned are less than zero.

    Remarks

    Note: This setting cannot be saved with a CustomView in the Excel file. It can only be saved with a Workbook. Therefore, there is no corresponding property in CustomViewWindowOptions and a newly created CustomView will not be initialized with the setting from this property.

  • boundsInTwips

    .boundsInTwips( value:object );
    Return Type:
    object
    Return Type Description:
    The bounds of the workbook's MDI child window in twips (1/20th of a point). This will be an object with numeric values for properties 'x', 'y', 'width', 'height', 'left', 'top', 'right', and 'bottom'.

    Sets the bounds of the workbook's MDI child window in twips (1/20th of a point).

    • 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 width or height of the value assigned are less than zero.

    Remarks

    Note: This setting cannot be saved with a CustomView in the Excel file. It can only be saved with a Workbook. Therefore, there is no corresponding property in CustomViewWindowOptions and a newly created CustomView will not be initialized with the setting from this property.

  • firstVisibleTabIndex

    .firstVisibleTabIndex( );
    Return Type:
    number
    Return Type Description:
    The index of the first visible tab in the worksheet tab bar.

    Gets the index of the first visible tab in the worksheet tab bar.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The value assigned is less than zero.

    Remarks

    If the worksheet tab bar is not visible, this value will not be used, but it is still saved with the workbook.

    Note: This setting cannot be saved with a CustomView in the Excel file. It can only be saved with a Workbook. Therefore, there is no corresponding property in CustomViewWindowOptions and a newly created CustomView will not be initialized with the setting from this property.

    See Also

  • firstVisibleTabIndex

    .firstVisibleTabIndex( value:number );
    Return Type:
    number
    Return Type Description:
    The index of the first visible tab in the worksheet tab bar.

    Sets the index of the first visible tab in the worksheet tab bar.

    • value
    • Type:number

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The value assigned is less than zero.

    Remarks

    If the worksheet tab bar is not visible, this value will not be used, but it is still saved with the workbook.

    Note: This setting cannot be saved with a CustomView in the Excel file. It can only be saved with a Workbook. Therefore, there is no corresponding property in CustomViewWindowOptions and a newly created CustomView will not be initialized with the setting from this property.

    See Also

  • minimized

    .minimized( );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether the workbook's MDI child window is minimized in Microsoft Excel.

    Gets the value indicating whether the workbook's MDI child window is minimized in Microsoft Excel.

    Remarks

    Note: This setting cannot be saved with a CustomView in the Excel file. It can only be saved with a Workbook. Therefore, there is no corresponding property in CustomViewWindowOptions and a newly created CustomView will not be initialized with the setting from this property.

    See Also

  • minimized

    .minimized( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether the workbook's MDI child window is minimized in Microsoft Excel.

    Sets the value indicating whether the workbook's MDI child window is minimized in Microsoft Excel.

    • value
    • Type:boolean

    Remarks

    Note: This setting cannot be saved with a CustomView in the Excel file. It can only be saved with a Workbook. Therefore, there is no corresponding property in CustomViewWindowOptions and a newly created CustomView will not be initialized with the setting from this property.

    See Also

  • objectDisplayStyle
    Inherited

    .objectDisplayStyle( );
    Return Type:
    ig.excel.ObjectDisplayStyle
    Return Type Description:
    The way the objects and shapes are displayed in the workbook.

    Gets the way the objects and shapes are displayed in the workbook.

    Exceptions

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

    See Also

  • objectDisplayStyle
    Inherited

    .objectDisplayStyle( value:ig.excel.ObjectDisplayStyle );
    Return Type:
    ig.excel.ObjectDisplayStyle
    Return Type Description:
    The way the objects and shapes are displayed in the workbook.

    Sets the way the objects and shapes are displayed in the workbook.

    • value
    • Type:ig.excel.ObjectDisplayStyle

    Exceptions

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

    See Also

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

  • scrollBars
    Inherited

    .scrollBars( );
    Return Type:
    ig.excel.ScrollBars
    Return Type Description:
    The scroll bars shown in the workbook window.

    Gets the scroll bars shown in the workbook window.

    Exceptions

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

    Remarks

    The vertical scroll bar occupies the entire height of the application if it is visible.

    The horizontal scroll bar occupies the width of the application not used by the worksheet tab bar, if it is visible. Otherwise, it occupies the entire width of the application.

    See Also

  • scrollBars
    Inherited

    .scrollBars( value:ig.excel.ScrollBars );
    Return Type:
    ig.excel.ScrollBars
    Return Type Description:
    The scroll bars shown in the workbook window.

    Sets the scroll bars shown in the workbook window.

    • value
    • Type:ig.excel.ScrollBars

    Exceptions

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

    Remarks

    The vertical scroll bar occupies the entire height of the application if it is visible.

    The horizontal scroll bar occupies the width of the application not used by the worksheet tab bar, if it is visible. Otherwise, it occupies the entire width of the application.

    See Also

  • selectedSheet
    Inherited

    .selectedSheet( );
    Return Type:
    ig.excel.Sheet
    Return Type Description:
    The selected worksheet of the workbook.

    Gets the selected worksheet of the workbook.

    Exceptions

    Exception Description
    ig.ArgumentNullException The assigned value is null and this is an instance of WorkbookWindowOptions whose associated WindowOptions.workbook has at least one Worksheet.
    ig.ArgumentException The assigned value does not belong to the workbook associated with this instance of WindowOptions.

    Remarks

    If this is an instance of CustomViewWindowOptions and the SelectedWorksheet value is null, the workbook's selected worksheet will not be changed when the associated CustomView is applied.

    Note: If the selected worksheet does not have its DisplayOptionsBase.visibility set to Visible when the workbook is saved, another worksheet will be selected.

    See Also

  • selectedSheet
    Inherited

    .selectedSheet( value:ig.excel.Sheet );
    Return Type:
    ig.excel.Sheet
    Return Type Description:
    The selected worksheet of the workbook.

    Sets the selected worksheet of the workbook.

    • value
    • Type:ig.excel.Sheet

    Exceptions

    Exception Description
    ig.ArgumentNullException The assigned value is null and this is an instance of WorkbookWindowOptions whose associated WindowOptions.workbook has at least one Worksheet.
    ig.ArgumentException The assigned value does not belong to the workbook associated with this instance of WindowOptions.

    Remarks

    If this is an instance of CustomViewWindowOptions and the SelectedWorksheet value is null, the workbook's selected worksheet will not be changed when the associated CustomView is applied.

    Note: If the selected worksheet does not have its DisplayOptionsBase.visibility set to Visible when the workbook is saved, another worksheet will be selected.

    See Also

  • selectedWorksheet
    Inherited

    .selectedWorksheet( );
    Return Type:
    ig.excel.Worksheet
    Return Type Description:
    The selected worksheet of the workbook.

    Gets the selected worksheet of the workbook.

    Exceptions

    Exception Description
    ig.ArgumentNullException The assigned value is null and this is an instance of WorkbookWindowOptions whose associated WindowOptions.workbook has at least one Worksheet.
    ig.ArgumentException The assigned value does not belong to the workbook associated with this instance of WindowOptions.

    Remarks

    If this is an instance of CustomViewWindowOptions and the SelectedWorksheet value is null, the workbook's selected worksheet will not be changed when the associated CustomView is applied.

    Note: If the selected worksheet does not have its DisplayOptionsBase.visibility set to Visible when the workbook is saved, another worksheet will be selected.

    See Also

  • selectedWorksheet
    Inherited

    .selectedWorksheet( value:ig.excel.Worksheet );
    Return Type:
    ig.excel.Worksheet
    Return Type Description:
    The selected worksheet of the workbook.

    Sets the selected worksheet of the workbook.

    • value
    • Type:ig.excel.Worksheet

    Exceptions

    Exception Description
    ig.ArgumentNullException The assigned value is null and this is an instance of WorkbookWindowOptions whose associated WindowOptions.workbook has at least one Worksheet.
    ig.ArgumentException The assigned value does not belong to the workbook associated with this instance of WindowOptions.

    Remarks

    If this is an instance of CustomViewWindowOptions and the SelectedWorksheet value is null, the workbook's selected worksheet will not be changed when the associated CustomView is applied.

    Note: If the selected worksheet does not have its DisplayOptionsBase.visibility set to Visible when the workbook is saved, another worksheet will be selected.

    See Also

  • tabBarVisible
    Inherited

    .tabBarVisible( );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether the worksheet tab bar is visible.

    Gets the value indicating whether the worksheet tab bar is visible.

    Remarks

    If the value is False, the WindowOptions.tabBarWidth will not be used, but it will still be serialized with the workbook.

    See Also

  • tabBarVisible
    Inherited

    .tabBarVisible( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether the worksheet tab bar is visible.

    Sets the value indicating whether the worksheet tab bar is visible.

    • value
    • Type:boolean

    Remarks

    If the value is False, the WindowOptions.tabBarWidth will not be used, but it will still be serialized with the workbook.

    See Also

  • tabBarWidth
    Inherited

    .tabBarWidth( );
    Return Type:
    number
    Return Type Description:
    The width of the worksheet tab bar, expressed in 1/1000ths of the application width.

    Gets the width of the worksheet tab bar, expressed in 1/1000ths of the application width.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The value assigned is outside the valid range of 0 and 1000.

    Remarks

    This value is only used if WindowOptions.tabBarVisible is True. Regardless of whether the tab bar is visible, the width value is always saved with the workbook.

    A value of 1000 indicates the worksheet tab bar occupies the entire width of the application, while a value of 0 indicates the worksheet tab bar has no width.

    All space not occupied by the worksheet tab bar will be used by the horizontal scroll bar, if it is visible.

    See Also

  • tabBarWidth
    Inherited

    .tabBarWidth( value:number );
    Return Type:
    number
    Return Type Description:
    The width of the worksheet tab bar, expressed in 1/1000ths of the application width.

    Sets the width of the worksheet tab bar, expressed in 1/1000ths of the application width.

    • value
    • Type:number

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The value assigned is outside the valid range of 0 and 1000.

    Remarks

    This value is only used if WindowOptions.tabBarVisible is True. Regardless of whether the tab bar is visible, the width value is always saved with the workbook.

    A value of 1000 indicates the worksheet tab bar occupies the entire width of the application, while a value of 0 indicates the worksheet tab bar has no width.

    All space not occupied by the worksheet tab bar will be used by the horizontal scroll bar, if it is visible.

    See Also

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