[]
        
(Showing Draft Content)

GC.Spread.Sheets.IWorkbookOptions

Interface: IWorkbookOptions

Spread.Sheets.IWorkbookOptions

Table of contents

Properties

Properties

allSheetsListVisible

allSheetsListVisible: AllSheetsListVisibility

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


allowAutoCreateHyperlink: boolean

Whether to enable auto creating hyperlink in the spreadsheet.


allowAutoExtendFilterRange

allowAutoExtendFilterRange: boolean

indicates whether filter can auto extend range like Excel.


allowContextMenu

allowContextMenu: boolean

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


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.


allowDragHeaderToMove

allowDragHeaderToMove: AllowDragHeaderToMove

Specifies how to allow drag header to move.


allowDynamicArray

allowDynamicArray: boolean

Whether to enable the dynamic array.


allowExtendPasteRange

allowExtendPasteRange: boolean

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


allowInvalidFormula

allowInvalidFormula: boolean

indicates whether allow input invalid formula string.


allowSheetReorder

allowSheetReorder: boolean

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


allowUndo

allowUndo: boolean

Whether to allow the user to undo edits.


allowUserDeselect

allowUserDeselect: boolean

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


allowUserDragDrop

allowUserDragDrop: boolean

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


allowUserDragFill

allowUserDragFill: boolean

Whether to allow the user to drag fill a range.


allowUserDragMerge

allowUserDragMerge: boolean

Whether to allow the user to drag merge cells.


allowUserEditFormula

allowUserEditFormula: boolean

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


allowUserResize

allowUserResize: boolean

Whether to allow the user to resize columns and rows.


allowUserZoom

allowUserZoom: boolean

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


autoFitType

autoFitType: AutoFitType

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


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.


backgroundImage

backgroundImage: string

The background image of the Spread component.


backgroundImageLayout

backgroundImageLayout: ImageLayout

The background image layout for the Spread component.


builtInFileIcons

builtInFileIcons: IBuiltInFileIcons

All built-in file icons.


calcOnDemand

calcOnDemand: boolean

Whether to calculate formulas only when they are demanded.


calculationMode

calculationMode: CalculationMode

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


columnResizeMode

columnResizeMode: ResizeMode

Specifies the way to resize column.


copyPasteHeaderOptions

copyPasteHeaderOptions: CopyPasteHeaderOptions

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


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.


cutCopyIndicatorBorderColor

cutCopyIndicatorBorderColor: string

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


cutCopyIndicatorVisible

cutCopyIndicatorVisible: boolean

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


defaultDragFillType

defaultDragFillType: AutoFillType

The default fill type.


defaultSheetTabStyles

defaultSheetTabStyles: SheetTabStyles

The default sheet tab styles.


dynamicReferences

dynamicReferences: boolean

Whether to calculate functions with dynamic reference.


enableAccessibility

enableAccessibility: boolean

Whether to enable the accessibility support in the spreadsheet.


enableFormulaTextbox

enableFormulaTextbox: boolean

Whether to enable the formula text box in the spreadsheet.


formulaFormatHint

formulaFormatHint: boolean

indicates whether automatically generate the format when formula inputs.


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.


hideSelection

hideSelection: boolean

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


highlightInvalidData

highlightInvalidData: boolean

Whether to highlight invalid data.


incrementalCalculation

incrementalCalculation: boolean

Whether to incremental calculate formulas without blocking UI.


iterativeCalculation

iterativeCalculation: boolean

Whether to enable the iterative calculation.


iterativeCalculationMaximumChange

iterativeCalculationMaximumChange: number

The Maximum Change when iterative calculation.


iterativeCalculationMaximumIterations

iterativeCalculationMaximumIterations: number

The Maximum Iterations when iterative calculation.


newTabVisible

newTabVisible: boolean

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


pasteSkipInvisibleRange

pasteSkipInvisibleRange: boolean

Whether paste skip invisible range. Default is false.


pivotAreaReference

pivotAreaReference: PivotAreaReference

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


referenceStyle

referenceStyle: ReferenceStyle

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


resizeZeroIndicator

resizeZeroIndicator: ResizeZeroIndicator

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


rowResizeMode

rowResizeMode: ResizeMode

Specifies the way to resize row.


scrollByPixel

scrollByPixel: boolean

Whether to enable the precision scrolling by pixel.


scrollIgnoreHidden

scrollIgnoreHidden: boolean

Whether the scroll bar ignores hidden rows or columns.


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.


scrollbarAppearance

Optional scrollbarAppearance: ScrollbarAppearance

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


scrollbarMaxAlign

scrollbarMaxAlign: boolean

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


scrollbarShowMax

scrollbarShowMax: boolean

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


showDragDropTip

showDragDropTip: boolean

Whether to display the drag-drop tip.


showDragFillSmartTag

showDragFillSmartTag: boolean

Whether to display the drag fill dialog.


showDragFillTip

showDragFillTip: boolean

Whether to display the drag-fill tip.


showHorizontalScrollbar

showHorizontalScrollbar: boolean

Whether to display the horizontal scroll bar.


showResizeTip

showResizeTip: ShowResizeTip

How to display the resize tip.


showScrollTip

showScrollTip: ShowScrollTip

How to display the scroll tip.


showVerticalScrollbar

showVerticalScrollbar: boolean

Whether to display the vertical scroll bar.


tabEditable

tabEditable: boolean

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


tabNavigationVisible

tabNavigationVisible: boolean

Whether to display the sheet tab navigation.


tabStripPosition

tabStripPosition: TabStripPosition

The position of tab strip. The default is bottom.


tabStripRatio

tabStripRatio: number

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


tabStripVisible

tabStripVisible: boolean

Whether to display the sheet tab strip.


tabStripWidth

tabStripWidth: number

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


useTouchLayout

useTouchLayout: boolean

Whether to use touch layout to present the Spread component.