# GC.Spread.Sheets.IWorkbookOptions

## Content

# Interface: IWorkbookOptions

[Spread](../modules/GC.Spread).[Sheets](../modules/GC.Spread.Sheets).IWorkbookOptions

## Table of contents

### Properties

- [allSheetsListVisible](GC.Spread.Sheets.IWorkbookOptions#allsheetslistvisible)
- [allowAutoCreateHyperlink](GC.Spread.Sheets.IWorkbookOptions#allowautocreatehyperlink)
- [allowAutoExtendFilterRange](GC.Spread.Sheets.IWorkbookOptions#allowautoextendfilterrange)
- [allowContextMenu](GC.Spread.Sheets.IWorkbookOptions#allowcontextmenu)
- [allowCopyPasteExcelStyle](GC.Spread.Sheets.IWorkbookOptions#allowcopypasteexcelstyle)
- [allowDragHeaderToMove](GC.Spread.Sheets.IWorkbookOptions#allowdragheadertomove)
- [allowDynamicArray](GC.Spread.Sheets.IWorkbookOptions#allowdynamicarray)
- [allowExtendPasteRange](GC.Spread.Sheets.IWorkbookOptions#allowextendpasterange)
- [allowInvalidFormula](GC.Spread.Sheets.IWorkbookOptions#allowinvalidformula)
- [allowSheetReorder](GC.Spread.Sheets.IWorkbookOptions#allowsheetreorder)
- [allowUndo](GC.Spread.Sheets.IWorkbookOptions#allowundo)
- [allowUserDeselect](GC.Spread.Sheets.IWorkbookOptions#allowuserdeselect)
- [allowUserDragDrop](GC.Spread.Sheets.IWorkbookOptions#allowuserdragdrop)
- [allowUserDragFill](GC.Spread.Sheets.IWorkbookOptions#allowuserdragfill)
- [allowUserDragMerge](GC.Spread.Sheets.IWorkbookOptions#allowuserdragmerge)
- [allowUserEditFormula](GC.Spread.Sheets.IWorkbookOptions#allowusereditformula)
- [allowUserResize](GC.Spread.Sheets.IWorkbookOptions#allowuserresize)
- [allowUserZoom](GC.Spread.Sheets.IWorkbookOptions#allowuserzoom)
- [autoFitType](GC.Spread.Sheets.IWorkbookOptions#autofittype)
- [backColor](GC.Spread.Sheets.IWorkbookOptions#backcolor)
- [backgroundImage](GC.Spread.Sheets.IWorkbookOptions#backgroundimage)
- [backgroundImageLayout](GC.Spread.Sheets.IWorkbookOptions#backgroundimagelayout)
- [builtInFileIcons](GC.Spread.Sheets.IWorkbookOptions#builtinfileicons)
- [calcOnDemand](GC.Spread.Sheets.IWorkbookOptions#calcondemand)
- [calculationMode](GC.Spread.Sheets.IWorkbookOptions#calculationmode)
- [columnResizeMode](GC.Spread.Sheets.IWorkbookOptions#columnresizemode)
- [copyPasteHeaderOptions](GC.Spread.Sheets.IWorkbookOptions#copypasteheaderoptions)
- [customList](GC.Spread.Sheets.IWorkbookOptions#customlist)
- [cutCopyIndicatorBorderColor](GC.Spread.Sheets.IWorkbookOptions#cutcopyindicatorbordercolor)
- [cutCopyIndicatorVisible](GC.Spread.Sheets.IWorkbookOptions#cutcopyindicatorvisible)
- [defaultDragFillType](GC.Spread.Sheets.IWorkbookOptions#defaultdragfilltype)
- [defaultSheetTabStyles](GC.Spread.Sheets.IWorkbookOptions#defaultsheettabstyles)
- [dynamicReferences](GC.Spread.Sheets.IWorkbookOptions#dynamicreferences)
- [enableAccessibility](GC.Spread.Sheets.IWorkbookOptions#enableaccessibility)
- [enableFormulaTextbox](GC.Spread.Sheets.IWorkbookOptions#enableformulatextbox)
- [formulaFormatHint](GC.Spread.Sheets.IWorkbookOptions#formulaformathint)
- [grayAreaBackColor](GC.Spread.Sheets.IWorkbookOptions#grayareabackcolor)
- [hideSelection](GC.Spread.Sheets.IWorkbookOptions#hideselection)
- [highlightInvalidData](GC.Spread.Sheets.IWorkbookOptions#highlightinvaliddata)
- [incrementalCalculation](GC.Spread.Sheets.IWorkbookOptions#incrementalcalculation)
- [iterativeCalculation](GC.Spread.Sheets.IWorkbookOptions#iterativecalculation)
- [iterativeCalculationMaximumChange](GC.Spread.Sheets.IWorkbookOptions#iterativecalculationmaximumchange)
- [iterativeCalculationMaximumIterations](GC.Spread.Sheets.IWorkbookOptions#iterativecalculationmaximumiterations)
- [newTabVisible](GC.Spread.Sheets.IWorkbookOptions#newtabvisible)
- [pasteSkipInvisibleRange](GC.Spread.Sheets.IWorkbookOptions#pasteskipinvisiblerange)
- [pivotAreaReference](GC.Spread.Sheets.IWorkbookOptions#pivotareareference)
- [referenceStyle](GC.Spread.Sheets.IWorkbookOptions#referencestyle)
- [resizeZeroIndicator](GC.Spread.Sheets.IWorkbookOptions#resizezeroindicator)
- [rowResizeMode](GC.Spread.Sheets.IWorkbookOptions#rowresizemode)
- [scrollByPixel](GC.Spread.Sheets.IWorkbookOptions#scrollbypixel)
- [scrollIgnoreHidden](GC.Spread.Sheets.IWorkbookOptions#scrollignorehidden)
- [scrollPixel](GC.Spread.Sheets.IWorkbookOptions#scrollpixel)
- [scrollbarAppearance](GC.Spread.Sheets.IWorkbookOptions#scrollbarappearance)
- [scrollbarMaxAlign](GC.Spread.Sheets.IWorkbookOptions#scrollbarmaxalign)
- [scrollbarShowMax](GC.Spread.Sheets.IWorkbookOptions#scrollbarshowmax)
- [showDragDropTip](GC.Spread.Sheets.IWorkbookOptions#showdragdroptip)
- [showDragFillSmartTag](GC.Spread.Sheets.IWorkbookOptions#showdragfillsmarttag)
- [showDragFillTip](GC.Spread.Sheets.IWorkbookOptions#showdragfilltip)
- [showHorizontalScrollbar](GC.Spread.Sheets.IWorkbookOptions#showhorizontalscrollbar)
- [showResizeTip](GC.Spread.Sheets.IWorkbookOptions#showresizetip)
- [showScrollTip](GC.Spread.Sheets.IWorkbookOptions#showscrolltip)
- [showVerticalScrollbar](GC.Spread.Sheets.IWorkbookOptions#showverticalscrollbar)
- [tabEditable](GC.Spread.Sheets.IWorkbookOptions#tabeditable)
- [tabNavigationVisible](GC.Spread.Sheets.IWorkbookOptions#tabnavigationvisible)
- [tabStripPosition](GC.Spread.Sheets.IWorkbookOptions#tabstripposition)
- [tabStripRatio](GC.Spread.Sheets.IWorkbookOptions#tabstripratio)
- [tabStripVisible](GC.Spread.Sheets.IWorkbookOptions#tabstripvisible)
- [tabStripWidth](GC.Spread.Sheets.IWorkbookOptions#tabstripwidth)
- [useTouchLayout](GC.Spread.Sheets.IWorkbookOptions#usetouchlayout)

## Properties

### <a id="allsheetslistvisible" name="allsheetslistvisible"></a> allSheetsListVisible

• **allSheetsListVisible**: [`AllSheetsListVisibility`](../enums/GC.Spread.Sheets.AllSheetsListVisibility)

Whether the spreadsheet shows a special tab to allow the user to open the dialog to display all sheets.

___

### <a id="allowautocreatehyperlink" name="allowautocreatehyperlink"></a> allowAutoCreateHyperlink

• **allowAutoCreateHyperlink**: `boolean`

Whether to enable auto creating hyperlink in the spreadsheet.

___

### <a id="allowautoextendfilterrange" name="allowautoextendfilterrange"></a> allowAutoExtendFilterRange

• **allowAutoExtendFilterRange**: `boolean`

indicates whether filter can auto extend range like Excel.

___

### <a id="allowcontextmenu" name="allowcontextmenu"></a> allowContextMenu

• **allowContextMenu**: `boolean`

Whether to allow the user to open the built-in context menu.

___

### <a id="allowcopypasteexcelstyle" name="allowcopypasteexcelstyle"></a> allowCopyPasteExcelStyle

• **allowCopyPasteExcelStyle**: `boolean`

Whether the user can copy style from Spread Sheets then paste to Excel, or copy style from Excel then paste to Spread Sheets.

___

### <a id="allowdragheadertomove" name="allowdragheadertomove"></a> allowDragHeaderToMove

• **allowDragHeaderToMove**: [`AllowDragHeaderToMove`](../enums/GC.Spread.Sheets.AllowDragHeaderToMove)

Specifies how to allow drag header to move.

___

### <a id="allowdynamicarray" name="allowdynamicarray"></a> allowDynamicArray

• **allowDynamicArray**: `boolean`

Whether to enable the dynamic array.

___

### <a id="allowextendpasterange" name="allowextendpasterange"></a> allowExtendPasteRange

• **allowExtendPasteRange**: `boolean`

Whether extend paste range if the paste range is not enough for pasting.

___

### <a id="allowinvalidformula" name="allowinvalidformula"></a> allowInvalidFormula

• **allowInvalidFormula**: `boolean`

indicates whether allow input invalid formula string.

___

### <a id="allowsheetreorder" name="allowsheetreorder"></a> allowSheetReorder

• **allowSheetReorder**: `boolean`

Whether the user can reorder the sheets in the Spread component.

___

### <a id="allowundo" name="allowundo"></a> allowUndo

• **allowUndo**: `boolean`

Whether to allow the user to undo edits.

___

### <a id="allowuserdeselect" name="allowuserdeselect"></a> allowUserDeselect

• **allowUserDeselect**: `boolean`

Whether to allow the user to can use deselect in selection.

___

### <a id="allowuserdragdrop" name="allowuserdragdrop"></a> allowUserDragDrop

• **allowUserDragDrop**: `boolean`

Whether to allow the user to drag and drop range data.

___

### <a id="allowuserdragfill" name="allowuserdragfill"></a> allowUserDragFill

• **allowUserDragFill**: `boolean`

Whether to allow the user to drag fill a range.

___

### <a id="allowuserdragmerge" name="allowuserdragmerge"></a> allowUserDragMerge

• **allowUserDragMerge**: `boolean`

Whether to allow the user to drag merge cells.

___

### <a id="allowusereditformula" name="allowusereditformula"></a> allowUserEditFormula

• **allowUserEditFormula**: `boolean`

Whether the user can edit formulas in a cell in the spreadsheet.

___

### <a id="allowuserresize" name="allowuserresize"></a> allowUserResize

• **allowUserResize**: `boolean`

Whether to allow the user to resize columns and rows.

___

### <a id="allowuserzoom" name="allowuserzoom"></a> allowUserZoom

• **allowUserZoom**: `boolean`

Whether to zoom the display by scrolling the mouse wheel while pressing the Ctrl key.

___

### <a id="autofittype" name="autofittype"></a> autoFitType

• **autoFitType**: [`AutoFitType`](../enums/GC.Spread.Sheets.AutoFitType)

Whether content will be formatted to fit in cells or in cells and headers.

___

### <a id="backcolor" name="backcolor"></a> backColor

• **backColor**: `string`

A color string used to represent the background color of the Spread component, such as "red", "#FFFF00", "rgb(255,0,0)", "Accent 5", and so on.

___

### <a id="backgroundimage" name="backgroundimage"></a> backgroundImage

• **backgroundImage**: `string`

The background image of the Spread component.

___

### <a id="backgroundimagelayout" name="backgroundimagelayout"></a> backgroundImageLayout

• **backgroundImageLayout**: [`ImageLayout`](../enums/GC.Spread.Sheets.ImageLayout)

The background image layout for the Spread component.

___

### <a id="builtinfileicons" name="builtinfileicons"></a> builtInFileIcons

• **builtInFileIcons**: [`IBuiltInFileIcons`](GC.Spread.Sheets.IBuiltInFileIcons)

All built-in file icons.

___

### <a id="calcondemand" name="calcondemand"></a> calcOnDemand

• **calcOnDemand**: `boolean`

Whether to calculate formulas only when they are demanded.

___

### <a id="calculationmode" name="calculationmode"></a> calculationMode

• **calculationMode**: [`CalculationMode`](../enums/GC.Spread.Sheets.CalculationMode)

The recalculation behavior of the workbook. The default is auto.

___

### <a id="columnresizemode" name="columnresizemode"></a> columnResizeMode

• **columnResizeMode**: [`ResizeMode`](../enums/GC.Spread.Sheets.ResizeMode)

Specifies the way to resize column.

___

### <a id="copypasteheaderoptions" name="copypasteheaderoptions"></a> copyPasteHeaderOptions

• **copyPasteHeaderOptions**: [`CopyPasteHeaderOptions`](../enums/GC.Spread.Sheets.CopyPasteHeaderOptions)

Which headers are included when data is copied to or pasted.

___

### <a id="customlist" name="customlist"></a> customList

• `Optional` **customList**: `string`[][]

The list for user to customize drag fill, prioritize matching this list in each fill. Each array item is type of string array.

___

### <a id="cutcopyindicatorbordercolor" name="cutcopyindicatorbordercolor"></a> cutCopyIndicatorBorderColor

• **cutCopyIndicatorBorderColor**: `string`

The border color for the indicator displayed when the user cuts or copies the selection.

___

### <a id="cutcopyindicatorvisible" name="cutcopyindicatorvisible"></a> cutCopyIndicatorVisible

• **cutCopyIndicatorVisible**: `boolean`

Whether to display an indicator when copying or cutting the selected item.

___

### <a id="defaultdragfilltype" name="defaultdragfilltype"></a> defaultDragFillType

• **defaultDragFillType**: [`AutoFillType`](../enums/GC.Spread.Sheets.Fill.AutoFillType)

The default fill type.

___

### <a id="defaultsheettabstyles" name="defaultsheettabstyles"></a> defaultSheetTabStyles

• **defaultSheetTabStyles**: [`SheetTabStyles`](../modules/GC.Spread.Sheets#sheettabstyles)

The default sheet tab styles.

___

### <a id="dynamicreferences" name="dynamicreferences"></a> dynamicReferences

• **dynamicReferences**: `boolean`

Whether to calculate functions with dynamic reference.

___

### <a id="enableaccessibility" name="enableaccessibility"></a> enableAccessibility

• **enableAccessibility**: `boolean`

Whether to enable the accessibility support in the spreadsheet.

___

### <a id="enableformulatextbox" name="enableformulatextbox"></a> enableFormulaTextbox

• **enableFormulaTextbox**: `boolean`

Whether to enable the formula text box in the spreadsheet.

___

### <a id="formulaformathint" name="formulaformathint"></a> formulaFormatHint

• **formulaFormatHint**: `boolean`

indicates whether automatically generate the format when formula inputs.

___

### <a id="grayareabackcolor" name="grayareabackcolor"></a> grayAreaBackColor

• **grayAreaBackColor**: `string`

A color string used to represent the background color of the gray area , such as "red", "#FFFF00", "rgb(255,0,0)", "Accent 5", and so on.

___

### <a id="hideselection" name="hideselection"></a> hideSelection

• **hideSelection**: `boolean`

Whether to display the selection highlighting when the Spread component does not have focus.

___

### <a id="highlightinvaliddata" name="highlightinvaliddata"></a> highlightInvalidData

• **highlightInvalidData**: `boolean`

Whether to highlight invalid data.

___

### <a id="incrementalcalculation" name="incrementalcalculation"></a> incrementalCalculation

• **incrementalCalculation**: `boolean`

Whether to incremental calculate formulas without blocking UI.

___

### <a id="iterativecalculation" name="iterativecalculation"></a> iterativeCalculation

• **iterativeCalculation**: `boolean`

Whether to enable the iterative calculation.

___

### <a id="iterativecalculationmaximumchange" name="iterativecalculationmaximumchange"></a> iterativeCalculationMaximumChange

• **iterativeCalculationMaximumChange**: `number`

The Maximum Change when iterative calculation.

___

### <a id="iterativecalculationmaximumiterations" name="iterativecalculationmaximumiterations"></a> iterativeCalculationMaximumIterations

• **iterativeCalculationMaximumIterations**: `number`

The Maximum Iterations when iterative calculation.

___

### <a id="newtabvisible" name="newtabvisible"></a> newTabVisible

• **newTabVisible**: `boolean`

Whether the spreadsheet displays the special tab to let users insert new sheets.

___

### <a id="pasteskipinvisiblerange" name="pasteskipinvisiblerange"></a> pasteSkipInvisibleRange

• **pasteSkipInvisibleRange**: `boolean`

Whether paste skip invisible range. Default is false.

___

### <a id="pivotareareference" name="pivotareareference"></a> pivotAreaReference

• **pivotAreaReference**: [`PivotAreaReference`](../enums/GC.Spread.Pivot.PivotAreaReference)

Whether automatically generate the getPivotData formula or cell reference when choose pivot table data area. Default is getPivotData.

___

### <a id="referencestyle" name="referencestyle"></a> referenceStyle

• **referenceStyle**: [`ReferenceStyle`](../enums/GC.Spread.Sheets.ReferenceStyle)

The style for cell and range references in cell formulas on this sheet.

___

### <a id="resizezeroindicator" name="resizezeroindicator"></a> resizeZeroIndicator

• **resizeZeroIndicator**: [`ResizeZeroIndicator`](../enums/GC.Spread.Sheets.ResizeZeroIndicator)

The drawing policy when the row or column is resized to zero.

___

### <a id="rowresizemode" name="rowresizemode"></a> rowResizeMode

• **rowResizeMode**: [`ResizeMode`](../enums/GC.Spread.Sheets.ResizeMode)

Specifies the way to resize row.

___

### <a id="scrollbypixel" name="scrollbypixel"></a> scrollByPixel

• **scrollByPixel**: `boolean`

Whether to enable the precision scrolling by pixel.

___

### <a id="scrollignorehidden" name="scrollignorehidden"></a> scrollIgnoreHidden

• **scrollIgnoreHidden**: `boolean`

Whether the scroll bar ignores hidden rows or columns.

___

### <a id="scrollpixel" name="scrollpixel"></a> scrollPixel

• **scrollPixel**: `number`

Decides scrolling by that number of pixels at a time when scrollByPixel is true. The final scrolling pixels are the result of scrolling delta multiply scrollPixel. For example, the scrolling delta is 3, and the scrollPixel is 5, the final scrolling pixels are 15.

___

### <a id="scrollbarappearance" name="scrollbarappearance"></a> scrollbarAppearance

• `Optional` **scrollbarAppearance**: [`ScrollbarAppearance`](../enums/GC.Spread.Sheets.ScrollbarAppearance)

The scrollbar appearance, contains skin and mobile two enums. Default is skin.

___

### <a id="scrollbarmaxalign" name="scrollbarmaxalign"></a> scrollbarMaxAlign

• **scrollbarMaxAlign**: `boolean`

Whether the scroll bar aligns with the last row and column of the active sheet.

___

### <a id="scrollbarshowmax" name="scrollbarshowmax"></a> scrollbarShowMax

• **scrollbarShowMax**: `boolean`

Whether the displayed scroll bars are based on the entire number of columns and rows in the sheet.

___

### <a id="showdragdroptip" name="showdragdroptip"></a> showDragDropTip

• **showDragDropTip**: `boolean`

Whether to display the drag-drop tip.

___

### <a id="showdragfillsmarttag" name="showdragfillsmarttag"></a> showDragFillSmartTag

• **showDragFillSmartTag**: `boolean`

Whether to display the drag fill dialog.

___

### <a id="showdragfilltip" name="showdragfilltip"></a> showDragFillTip

• **showDragFillTip**: `boolean`

Whether to display the drag-fill tip.

___

### <a id="showhorizontalscrollbar" name="showhorizontalscrollbar"></a> showHorizontalScrollbar

• **showHorizontalScrollbar**: `boolean`

Whether to display the horizontal scroll bar.

___

### <a id="showresizetip" name="showresizetip"></a> showResizeTip

• **showResizeTip**: [`ShowResizeTip`](../enums/GC.Spread.Sheets.ShowResizeTip)

How to display the resize tip.

___

### <a id="showscrolltip" name="showscrolltip"></a> showScrollTip

• **showScrollTip**: [`ShowScrollTip`](../enums/GC.Spread.Sheets.ShowScrollTip)

How to display the scroll tip.

___

### <a id="showverticalscrollbar" name="showverticalscrollbar"></a> showVerticalScrollbar

• **showVerticalScrollbar**: `boolean`

Whether to display the vertical scroll bar.

___

### <a id="tabeditable" name="tabeditable"></a> tabEditable

• **tabEditable**: `boolean`

Whether to allow the user to edit the sheet tab strip.

___

### <a id="tabnavigationvisible" name="tabnavigationvisible"></a> tabNavigationVisible

• **tabNavigationVisible**: `boolean`

Whether to display the sheet tab navigation.

___

### <a id="tabstripposition" name="tabstripposition"></a> tabStripPosition

• **tabStripPosition**: [`TabStripPosition`](../enums/GC.Spread.Sheets.TabStripPosition)

The position of tab strip. The default is bottom.

___

### <a id="tabstripratio" name="tabstripratio"></a> tabStripRatio

• **tabStripRatio**: `number`

The width of the tab strip expressed as a percentage of the overall horizontal scroll bar width.

___

### <a id="tabstripvisible" name="tabstripvisible"></a> tabStripVisible

• **tabStripVisible**: `boolean`

Whether to display the sheet tab strip.

___

### <a id="tabstripwidth" name="tabstripwidth"></a> tabStripWidth

• **tabStripWidth**: `number`

The width of the tab strip when it is at the left or right position. The default and minimum is 80.

___

### <a id="usetouchlayout" name="usetouchlayout"></a> useTouchLayout

• **useTouchLayout**: `boolean`

Whether to use touch layout to present the Spread component.