[]
DEMOS DOC DESIGNER API
DOWNLOAD
(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. The default value is GC.Spread.Sheets.AllSheetsListVisibility.auto.

• allowAutoCreateHyperlink: boolean

Whether to enable auto creating hyperlink in the spreadsheet. The default value is true.

allowAutoExtendFilterRange

• allowAutoExtendFilterRange: boolean

Whether allow auto extend filter range like excel. The default value is false.

allowContextMenu

• allowContextMenu: boolean

Whether to allow the user to open the built-in context menu. The default value is true.

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. The default value is true.

allowDragHeaderToMove

• allowDragHeaderToMove: AllowDragHeaderToMove

Specifies how to allow drag header to move. The default value is GC.Spread.Sheets.AllowDragHeaderToMove.none.

allowDynamicArray

• allowDynamicArray: boolean

Whether to enable dynamic array. The default value is false.

allowExtendPasteRange

• allowExtendPasteRange: boolean

Whether extend paste range if the paste range is not enough for pasting. The default value is false.

allowInvalidFormula

• allowInvalidFormula: boolean

Whether allow input invalid formula string. The default value is false.

allowSheetReorder

• allowSheetReorder: boolean

Whether the user can reorder the sheets in the Spread component. The default value is true.

allowUndo

• allowUndo: boolean

Whether to allow the user to undo edits. The default value is true.

allowUserDeselect

• allowUserDeselect: boolean

Whether to allow the user to can use deselect in selection. The default value is true.

allowUserDragDrop

• allowUserDragDrop: boolean

Whether to allow the user to drag and drop range data. The default value is true.

allowUserDragFill

• allowUserDragFill: boolean

Whether to allow the user to drag fill a range. The default value is true.

allowUserDragMerge

• allowUserDragMerge: boolean

Whether to allow the user to drag merge cells. The default value is false.

allowUserEditFormula

• allowUserEditFormula: boolean

Whether the user can edit formulas in a cell in the spreadsheet. The default value is true.

allowUserResize

• allowUserResize: boolean

Whether to allow the user to resize columns and rows. The default value is true.

allowUserZoom

• allowUserZoom: boolean

Whether to zoom the display by scrolling the mouse wheel while pressing the Ctrl key. The default value is true.

autoFitType

• autoFitType: AutoFitType

Whether content will be formatted to fit in cells or in cells and headers. The default value is GC.Spread.Sheets.AutoFitType.cell.

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. The default value is "white".

backgroundImage

• backgroundImage: string

The background image of the Spread component. The default value is null.

backgroundImageLayout

• backgroundImageLayout: ImageLayout

The background image layout for the Spread component. The default value is GC.Spread.Sheets.ImageLayout.stretch.

builtInFileIcons

• builtInFileIcons: IBuiltInFileIcons

All built-in file icons.

calcOnDemand

• calcOnDemand: boolean

Whether to calculate formulas only when they are demanded. The default value is false.

calculationMode

• calculationMode: CalculationMode

The recalculation behavior of the workbook. The default value is GC.Spread.Sheets.CalculationMode.auto.

columnResizeMode

• columnResizeMode: ResizeMode

Specifies the way to resize column. The default value is GC.Spread.Sheets.ResizeMode.normal.

copyPasteHeaderOptions

• copyPasteHeaderOptions: CopyPasteHeaderOptions

Which headers are included when data is copied to or pasted. The default value is GC.Spread.Sheets.CopyPasteHeaderOptions.allHeaders.

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. The default value is "#217346".

cutCopyIndicatorVisible

• cutCopyIndicatorVisible: boolean

Whether to display an indicator when copying or cutting the selected item. The default value is true.

defaultDragFillType

• defaultDragFillType: AutoFillType

The default fill type. The default value is GC.Spread.Sheets.Fill.AutoFillType.auto.

defaultSheetTabStyles

• defaultSheetTabStyles: SheetTabStyles

All default state styles for sheet tabs.

dynamicReferences

• dynamicReferences: boolean

Whether to calculate functions with dynamic reference. The default value is true.

enableAccessibility

• enableAccessibility: boolean

Whether to enable the accessibility support in the spreadsheet. The default value is false.

enableFormulaTextbox

• enableFormulaTextbox: boolean

Whether to enable the formula text box in the spreadsheet. The default value is true.

formulaFormatHint

• formulaFormatHint: boolean

Whether automatically generate the format when formula inputs. The default value is true.

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. The default value is null.

hideSelection

• hideSelection: boolean

Whether to display the selection highlighting when the Spread component does not have focus. The default value is false.

highlightInvalidData

• highlightInvalidData: boolean

Whether to highlight invalid data. The default value is false.

incrementalCalculation

• incrementalCalculation: boolean

Whether to incremental calculate formulas without blocking UI. The default value is false.

iterativeCalculation

• iterativeCalculation: boolean

Whether to enable the iterative calculation. The default value is true.

iterativeCalculationMaximumChange

• iterativeCalculationMaximumChange: number

The Maximum Change when iterative calculation. The default value is 0.01.

iterativeCalculationMaximumIterations

• iterativeCalculationMaximumIterations: number

The Maximum Iterations when iterative calculation. The default value is 1000.

newTabVisible

• newTabVisible: boolean

Whether the spreadsheet displays the special tab to let users insert new sheets. The default value is true.

pasteSkipInvisibleRange

• pasteSkipInvisibleRange: boolean

Whether paste skip invisible range. The default value is false.

pivotAreaReference

• pivotAreaReference: PivotAreaReference

Whether automatically generate the getPivotData formula or cell reference when choose pivot table data area. The default value is GC.Spread.Pivot.PivotAreaReference.getPivotData.

referenceStyle

• referenceStyle: ReferenceStyle

The style for cell and range references in cell formulas on the workbook. The default value is GC.Spread.Sheets.ReferenceStyle.a1.

resizeZeroIndicator

• resizeZeroIndicator: ResizeZeroIndicator

The drawing policy when the row or column is resized to zero. The default value is GC.Spread.Sheets.ResizeZeroIndicator.enhanced.

rowResizeMode

• rowResizeMode: ResizeMode

Specifies the way to resize row. The default value is GC.Spread.Sheets.ResizeMode.normal.

scrollByPixel

• scrollByPixel: boolean

Whether to enable the precision scrolling by pixel. The default value is false.

scrollIgnoreHidden

• scrollIgnoreHidden: boolean

Whether the scroll bar ignores hidden rows or columns. The default value is false.

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. The default value is 5.

scrollbarAppearance

• Optional scrollbarAppearance: ScrollbarAppearance

The scrollbar appearance, contains skin and mobile two enums. The default value is GC.Spread.Sheets.ScrollbarAppearance.skin.

scrollbarMaxAlign

• scrollbarMaxAlign: boolean

Whether the scroll bar aligns with the last row and column of the active sheet. The default value is false.

scrollbarShowMax

• scrollbarShowMax: boolean

Whether the displayed scroll bars are based on the entire number of columns and rows in the sheet. The default value is true.

showDragDropTip

• showDragDropTip: boolean

Whether to display the drag-drop tip. The default value is true.

showDragFillSmartTag

• showDragFillSmartTag: boolean

Whether to display the drag fill dialog. The default value is true.

showDragFillTip

• showDragFillTip: boolean

Whether to display the drag-fill tip. The default value is true.

showHorizontalScrollbar

• showHorizontalScrollbar: boolean

Whether to display the horizontal scroll bar. The default value is true.

showResizeTip

• showResizeTip: ShowResizeTip

How to display the resize tip. The default value is GC.Spread.Sheets.ShowResizeTip.none.

showScrollTip

• showScrollTip: ShowScrollTip

How to display the scroll tip. The default value is GC.Spread.Sheets.ShowScrollTip.none.

showVerticalScrollbar

• showVerticalScrollbar: boolean

Whether to display the vertical scroll bar. The default value is true.

tabEditable

• tabEditable: boolean

Whether to allow the user to edit the sheet tab strip. The default value is true.

tabNavigationVisible

• tabNavigationVisible: boolean

Whether to display the sheet tab navigation. The default value is true.

tabStripPosition

• tabStripPosition: TabStripPosition

The position of tab strip. The default value is GC.Spread.Sheets.TabStripPosition.bottom.

tabStripRatio

• tabStripRatio: number

The width of the tab strip expressed as a percentage of the overall horizontal scroll bar width. The default value is 0.5.

tabStripVisible

• tabStripVisible: boolean

Whether to display the sheet tab strip. The default value is true.

tabStripWidth

• tabStripWidth: number

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

useTouchLayout

• useTouchLayout: boolean

Whether to use touch layout to present the Spread component. The default value is false.