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

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.

See

Hierarchy

Hierarchy

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get boundsInPixels(): IgRect
  • Gets or sets the pixel bounds of the workbook's MDI child window when CustomView owning these window options is applied.

    Note: This property will have no affect on the workbook if 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 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.

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

    Throws

    ArgumentException The left or top of the value assigned is outside the bounds of -32768 and 32767.

    Throws

    ArgumentException The width or height of the value assigned is outside the bounds of 0 and 65535.

    See

    CustomView.apply

    Returns IgRect

  • set boundsInPixels(a: IgRect): void
  • Parameters

    Returns void

  • get maximized(): boolean
  • Gets or sets the value indicating whether the workbook's MDI child window will be maximized when the CustomView owning these window options is applied.

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

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

    See

    Returns boolean

  • set maximized(a: boolean): void
  • Parameters

    • a: boolean

    Returns void

  • get scrollBars(): ScrollBars
  • Gets or sets the scroll bars shown in the workbook window.

    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.

    The scroll bars shown in the workbook window.

    Throws

    InvalidEnumArgumentException The assigned value is not defined in the scrollBars enumeration.

    See

    Returns ScrollBars

  • set scrollBars(a: ScrollBars): void
  • Parameters

    Returns void

  • get selectedSheet(): Sheet
  • Gets or sets the selected worksheet of the workbook.

    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.

    The selected worksheet of the workbook.

    Throws

    ArgumentNullException The assigned value is null and this is an instance of WorkbookWindowOptions whose associated workbook has at least one Worksheet.

    Throws

    ArgumentException The assigned value does not belong to the workbook associated with this instance of WindowOptions.

    Returns Sheet

  • set selectedSheet(a: Sheet): void
  • Parameters

    Returns void

  • get selectedWorksheet(): Worksheet
  • Gets or sets the selected worksheet of the workbook.

    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.

    The selected worksheet of the workbook.

    Throws

    ArgumentNullException The assigned value is null and this is an instance of WorkbookWindowOptions whose associated workbook has at least one Worksheet.

    Throws

    ArgumentException The assigned value does not belong to the workbook associated with this instance of WindowOptions.

    Returns Worksheet

  • set selectedWorksheet(a: Worksheet): void
  • Parameters

    Returns void

  • get showFormulaBar(): boolean
  • Gets or sets the value indicating whether Microsoft Excel will display the formula bar when the CustomView owning these window options is applied.

    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.

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

    See

    CustomView.apply

    Returns boolean

  • set showFormulaBar(a: boolean): void
  • Parameters

    • a: boolean

    Returns void

  • get showStatusBar(): boolean
  • Gets or sets the value indicating whether Microsoft Excel will display the status bar when the CustomView owning these window options is applied.

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

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

    See

    CustomView.apply

    Returns boolean

  • set showStatusBar(a: boolean): void
  • Parameters

    • a: boolean

    Returns void

  • get tabBarVisible(): boolean
  • Gets or sets the value indicating whether the worksheet tab bar is visible.

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

    The value indicating whether the worksheet tab bar is visible.

    See

    Returns boolean

  • set tabBarVisible(a: boolean): void
  • Parameters

    • a: boolean

    Returns void

  • get tabBarWidth(): number
  • Gets or sets the width of the worksheet tab bar, expressed in 1/1000ths of the application width.

    This value is only used if 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.

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

    Throws

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

    See

    Returns number

  • set tabBarWidth(a: number): void
  • Parameters

    • a: number

    Returns void

Methods

  • Parameters

    • other: any

    Returns boolean

  • Returns number

  • Resets the window options to their default settings.

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

    Returns void

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns number

  • Parameters

    • a: any
    • b: any

    Returns boolean