SpreadJS 13
GC.Spread.Sheets Namespace / Workbook type / options Field
In This Topic
    options Field
    In This Topic
    Represents the options of the Spread control.
    Syntax
    var instance = new GC.Spread.Sheets.Workbook(host,
                                                options,
                                                options.sheetCount,
                                                options.font,
                                                options.allowUserDragMerge,
                                                options.allowUserDragDrop,
                                                options.allowUserDragFill,
                                                options.allowUserZoom,
                                                options.allowUserResize,
                                                options.allowUndo,
                                                options.allowSheetReorder,
                                                options.allowContextMenu,
                                                options.allowUserDeselect,
                                                options.defaultDragFillType,
                                                options.showDragFillSmartTag,
                                                options.showHorizontalScrollbar,
                                                options.showVerticalScrollbar,
                                                options.scrollbarShowMax,
                                                options.scrollbarMaxAlign,
                                                options.tabStripVisible,
                                                options.tabStripRatio,
                                                options.tabEditable,
                                                options.newTabVisible,
                                                options.tabNavigationVisible,
                                                options.cutCopyIndicatorVisible,
                                                options.cutCopyIndicatorBorderColor,
                                                options.backColor,
                                                options.backgroundImage,
                                                options.backgroundImageLayout,
                                                options.grayAreaBackColor,
                                                options.showResizeTip,
                                                options.showDragDropTip,
                                                options.showDragFillTip,
                                                options.showScrollTip,
                                                options.scrollIgnoreHidden,
                                                options.highlightInvalidData,
                                                options.useTouchLayout,
                                                options.hideSelection,
                                                options.resizeZeroIndicator,
                                                options.allowUserEditFormula,
                                                options.enableFormulaTextbox,
                                                options.autoFitType,
                                                options.referenceStyle,
                                                options.calcOnDemand,
                                                options.allowCopyPasteExcelStyle,
                                                options.allowExtendPasteRange,
                                                options.copyPasteHeaderOptions,
                                                options.scrollByPixel,
                                                options.scrollPixel,
                                                options.allowAutoCreateHyperlink,
                                                options.columnResizeMode,
                                                options.rowResizeMode,
                                                options.customList,
                                                options.scrollbarAppearance);
    var value; // Type: Object
    value = instance.options;
    var options : Object;
    Example
    The following examples set Workbook options.
    spread.options.allowCopyPasteExcelStyle = true;
    activeSheet.getCell(1, 0, GC.Spread.Sheets.SheetArea.viewport).backColor("Yellow");
    spread.options.allowExtendPasteRange = true;
    Remarks

    This table lists the Workbook options.

    Name Type Description
    allowUserDragMerge boolean Whether to allow the user to drag merge cells, optional.
    allowUserDragDrop boolean Specifies whether to allow the user to drag and drop range data, optional.
    allowUserDragFill boolean Specifies whether to allow the user to drag fill a range, optional.
    allowUserZoom boolean Specifies whether to zoom the display by scrolling the mouse wheel while pressing the Ctrl key, optional.
    allowUserResize boolean Specifies whether to allow the user to resize columns and rows, optional.
    allowUndo boolean Specifies whether to allow the user to undo edits, optional.
    allowSheetReorder boolean Specifies whether the user can reorder the sheets in the Spread component, optional.
    allowContextMenu boolean Whether to allow the user to open the built-in context menu, optional.
    allowCopyPasteExcelStyle boolean Specifies whether the user can copy styles from SpreadJS and then paste to Excel, or copy styles from Excel and then paste to SpreadJS, optional.
    allowExtendPasteRange boolean Specifies whether to extend the paste range if the paste range is not enough for pasting, optional.
    copyPasteHeaderOptions GC.Spread.Sheets.CopyPasteHeaderOptions Specifies which headers are included when data is copied to or pasted, optional.
    defaultDragFillType GC.Spread.Sheets.Fill.AutoFillType The default fill type, optional.
    showDragFillSmartTag boolean Specifies whether to display the drag fill dialog, optional.
    showHorizontalScrollbar boolean Specifies whether to display the horizontal scroll bar, optional.
    showVerticalScrollbar boolean Specifies whether to display the vertical scroll bar, optional.
    scrollbarShowMax boolean Specifies whether the displayed scroll bars are based on the entire number of columns and rows in the sheet, optional.
    scrollbarMaxAlign boolean Specifies whether the scroll bar aligns with the last row and column of the active sheet, optional.
    tabStripVisible boolean Specifies whether to display the sheet tab strip, optional.
    tabStripRatio number The width of the tab strip expressed as a percentage of the overall horizontal scroll bar width, optional.
    tabEditable boolean Specifies whether to allow the user to edit the sheet tab strip, optional.
    newTabVisible boolean Specifies whether the spreadsheet displays the special tab to let users insert new sheets, optional.
    tabNavigationVisible boolean Specifies whether to display the sheet tab navigation, optional.
    cutCopyIndicatorVisible boolean Specifies whether to display an indicator when copying or cutting the selected item, optional.
    cutCopyIndicatorBorderColor string The border color for the indicator displayed when the user cuts or copies the selection, optional.
    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, optional.
    backgroundImage string The background image of the Spread component, optional.
    backgroundImageLayout GC.Spread.Sheets.ImageLayout The background image layout for the Spread component, optional.
    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, optional.
    showResizeTip GC.Spread.Sheets.ShowResizeTip Specifies how to display the resize tip, optional.
    showDragDropTip boolean Specifies whether to display the drag-drop tip, optional.
    showDragFillTip boolean Specifies whether to display the drag-fill tip, optional.
    showScrollTip GC.Spread.Sheets.ShowScrollTip Specifies how to display the scroll tip, optional.
    scrollIgnoreHidden boolean Specifies whether the scroll bar ignores hidden rows or columns, optional.
    highlightInvalidData boolean Specifies whether to highlight invalid data, optional.
    useTouchLayout boolean Specifies whether to use touch layout to present the Spread component, optional.
    hideSelection boolean Specifies whether to display the selection highlighting when the Spread component does not have focus, optional.
    resizeZeroIndicator GC.Spread.Sheets.ResizeZeroIndicator The drawing policy when the row or column is resized to zero, optional.
    allowUserEditFormula boolean Specifies whether the user can edit formulas in a cell in the spreadsheet, optional.
    enableFormulaTextbox boolean Specifies whether to enable the formula text box in the spreadsheet, optional.
    autoFitType GC.Spread.Sheets.AutoFitType Specifies whether content will be formatted to fit in cells or in cells and headers, optional.
    referenceStyle GC.Spread.Sheets.ReferenceStyle The style for cell and range references in cell formulas on this sheet, optional.
    rowResizeMode GC.Spread.Sheets.ResizeMode Specifies the way to resize row, optional.
    columnResizeMode GC.Spread.Sheets.ResizeMode Specifies the way to resize column, optional.
    scrollByPixel boolean Specifies whether to enable the precision scrolling by pixel, optional.
    scrollPixel number Decides scrolling by that number of pixels at a time when scrollByPixel is true, optional. 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.

    customList

    array The list for user to customize drag fill, prioritize matching this list in each fill. Each array item is type of string array.
    calcOnDemand boolean Specifies whether to calculate formulas only when they are demanded, optional.
    font string The tab strip font.
    allowUserDeselect boolean Specifies whether to allow the user to can use deselect in selection, optional.
    sheetCount number The number of sheets.
    allowDynamicArray boolean Specifies whether to enable dynamic array, optional.
    See Also

    Reference

    Workbook type