ig.excel.WorkbookWindowOptions
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
-
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.
-
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.
-
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.
-
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.
-
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.