SpreadJS 13
GC.Spread.Sheets Namespace / Workbook type
In This Topic
    Workbook type
    In This Topic
    Represents a spreadsheet with the specified hosted DOM element and options setting.
    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);
    function Workbook;
    Example
    var workbook = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), {sheetCount:3, font:"12pt Arial"});
    var workbook = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), {sheetcount:3, newTabVisible:false});
    var workbook = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), { sheetCount: 3, tabEditable: false });
    var workbook = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), {sheetCount:3, tabStripVisible:false});
    var workbook = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), {sheetCount:3, allowUserResize:false});
    var workbook = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), { sheetCount: 3, allowUserZoom: false});
    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.
    Inheritance Hierarchy

    Object
       GC.Spread.Sheets.Workbook

    Constructors
     NameDescription
    public ConstructorRepresents a spreadsheet with the specified hosted DOM element and options setting.  
    Top
    Fields
     NameDescription
    public FieldContextMenu for the spread.  
    public FieldRepresents the name of the Spread control.  
    public FieldRepresents the options of the Spread control.  
    public FieldRepresents the sheet collection.  
    public FieldRepresents the touch toolstrip.  
    Top
    Methods
     NameDescription
    public MethodAdds a custom function.  
    public MethodAdds a custom name.  
    public MethodAdds a style to the Workbook named styles collection.  
    public MethodInserts a sheet at the specific index.  
    public MethodAdds a SparklineEx to the SparklineEx collection.  
    public MethodBinds an event to the Workbook.  
    public MethodClears all custom functions.  
    public MethodClears custom names.  
    public MethodClears all sheets in the control.  
    public MethodGets the command manager.  
    public MethodDestroys the workbook and all sheets it contains.  
    public MethodMakes the Workbook component get focus or lose focus.  
    public MethodLoads the object state from the specified JSON string.  
    public MethodGets the active sheet.  
    public MethodGets the active sheet index of the control.  
    public MethodGets a custom function.  
    public MethodGets the specified custom name information.  
    public MethodGets all custom name information.  
    public MethodGets the host element of the current Workbook instance.  
    public MethodGets a style from the Workbook named styles collection which has the specified name.  
    public MethodGets named styles from the Workbook.  
    public MethodGets the specified sheet.  
    public MethodGets the number of sheets.  
    public MethodGets the sheet with the specified name.  
    public MethodGets the sheet index with the specified name.  
    public MethodPerforms a hit test.  
    public MethodUpdates the control layout information.  
    public MethodGet if spread paint is suspended.  
    public MethodGets or sets the next control used by GC.Spread.Sheets.Actions.selectNextControl and GC.Spread.Sheets.Actions.moveToNextCellThenControl.  
    public Method  
    public MethodGets or sets the previous control used by GC.Spread.Sheets.Actions.selectPreviousControl and GC.Spread.Sheets.Actions.moveToPreviousCellThenControl.  
    public MethodPrints the specified sheet.  
    public MethodManually refreshes the layout and rendering of the Workbook object.  
    public MethodRemoves a custom function.  
    public MethodRemoves the specified custom name.  
    public MethodRemoves a style from the Workbook named styles collection which has the specified name.  
    public MethodRemoves the specified sheet.  
    public MethodRemoves a SparklineEx from the SparklineEx collection.  
    public MethodRepaints the Workbook control.  
    public MethodResumes the calculation service.  
    public MethodResumes the event.  
    public MethodResumes the paint of active sheet and tab strip.  
    public MethodExports the specified sheet to PDF.  
    public MethodSearches the text in the cells in the specified sheet for the specified string with the specified criteria.  
    public MethodSets the active sheet by name.  
    public MethodSets the active sheet index for the control.  
    public MethodSets the number of sheets.  
    public MethodGets or sets the index of the first sheet to display in the spreadsheet.  
    public MethodSuspends the calculation service.  
    public MethodSuspends the event.  
    public MethodSuspends the paint of active sheet and tab strip.  
    public MethodSaves the object state to a JSON string.  
    public MethodRemoves the binding of an event to Workbook.  
    public Method
     
    public MethodGets the undo manager.  
    Top
    See Also