Represents the window options which are saved with the workbook.

Constructors

Section titled "Constructors"

WorkbookWindowOptions 

new WorkbookWindowOptions(a: Workbook): WorkbookWindowOptions

Returns WorkbookWindowOptions

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

boundsInTwips

Section titled "boundsInTwips"

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

 
get boundsInTwips(): IgRect

Returns IgRect 

set boundsInTwips(a: IgRect): void

Parameters

  • a: IgRect

Returns void

firstVisibleTabIndex

Section titled "firstVisibleTabIndex"

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

 
get firstVisibleTabIndex(): number

Returns number 

set firstVisibleTabIndex(a: number): void

Parameters

  • a: number

Returns void

minimized

Section titled "minimized"

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

 
get minimized(): boolean

Returns boolean 

set minimized(a: boolean): void

Parameters

  • a: boolean

Returns void

objectDisplayStyle

Section titled "objectDisplayStyle"

Inherited from: WindowOptions

Gets or sets the way the objects and shapes are displayed in the workbook. The way the objects and shapes are displayed in the workbook.

 
get objectDisplayStyle(): ObjectDisplayStyle

Returns ObjectDisplayStyle 

set objectDisplayStyle(a: ObjectDisplayStyle): void

Parameters

Returns void

scrollBars

Section titled "scrollBars"

Inherited from: WindowOptions

Gets or sets the scroll bars shown in the workbook window.

 
get scrollBars(): ScrollBars

Returns ScrollBars 

set scrollBars(a: ScrollBars): void

Parameters

Returns void

selectedSheet

Section titled "selectedSheet"

Inherited from: WindowOptions

Gets or sets the selected worksheet of the workbook.

 
get selectedSheet(): Sheet

Returns Sheet 

set selectedSheet(a: Sheet): void

Parameters

Returns void

selectedWorksheet

Section titled "selectedWorksheet"

Inherited from: WindowOptions

Gets or sets the selected worksheet of the workbook.

 
get selectedWorksheet(): Worksheet

Returns Worksheet 

set selectedWorksheet(a: Worksheet): void

Parameters

Returns void

tabBarVisible

Section titled "tabBarVisible"

Inherited from: WindowOptions

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

 
get tabBarVisible(): boolean

Returns boolean 

set tabBarVisible(a: boolean): void

Parameters

  • a: boolean

Returns void

tabBarWidth

Section titled "tabBarWidth"

Inherited from: WindowOptions

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

 
get tabBarWidth(): number

Returns number 

set tabBarWidth(a: number): void

Parameters

  • a: number

Returns void

Methods

Section titled "Methods"

reset

Section titled "reset"

Resets the window options to their default settings.

 
reset(): void

Returns void