var instance = new GC.Spread.Sheets.Workbook(host);
function Workbook;
var instance = new GC.Spread.Sheets.Workbook(host);
function Workbook;
This table lists the Workbook options.
Name | Type | Description |
sheetCount | number | The number of sheets, optional. |
font | string | The tab strip font, 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. |
allowCopyPasteExcelStyle | boolean | Specifies whether the user can copy styles from Spread.Sheets and then paste to Excel, or copy styles from Excel and then paste to Spread.Sheets, 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. |
Object
GC.Spread.Sheets.Workbook
Name | Description | |
---|---|---|
![]() | Workbook Constructor | Represents a spreadsheet with the specified hosted DOM element and options setting. |
Name | Description | |
---|---|---|
![]() | name | Represents the name of the Spread control. |
![]() | options | Represents the options of the Spread control. |
![]() | sheets | Represents the sheet collection. |
![]() | touchToolStrip | Represents the touch toolstrip. |
Name | Description | |
---|---|---|
![]() | addCustomFunction | Adds a custom function. |
![]() | addCustomName | Adds a custom name. |
![]() | addNamedStyle | Adds a style to the Workbook named styles collection. |
![]() | addSheet | Inserts a sheet at the specific index. |
![]() | addSparklineEx | Adds a SparklineEx to the SparklineEx collection. |
![]() | bind | Binds an event to the Workbook. |
![]() | clearCustomFunctions | Clears all custom functions. |
![]() | clearCustomNames | Clears custom names. |
![]() | clearSheets | Clears all sheets in the control. |
![]() | commandManager | Gets the command manager. |
![]() | destroy | Destroys the workbook and all sheets it contains. |
![]() | focus | Makes the Workbook component get focus or lose focus. |
![]() | fromJSON | Loads the object state from the specified JSON string. |
![]() | getActiveSheet | Gets the active sheet. |
![]() | getActiveSheetIndex | Gets the active sheet index of the control. |
![]() | getCustomFunction | Gets a custom function. |
![]() | getCustomName | Gets the specified custom name information. |
![]() | getCustomNames | Gets all custom name information. |
![]() | getHost | Gets the host element of the current Workbook instance. |
![]() | getNamedStyle | Gets a style from the Workbook named styles collection which has the specified name. |
![]() | getNamedStyles | Gets named styles from the Workbook. |
![]() | getSheet | Gets the specified sheet. |
![]() | getSheetCount | Gets the number of sheets. |
![]() | getSheetFromName | Gets the sheet with the specified name. |
![]() | getSheetIndex | Gets the sheet index with the specified name. |
![]() | hitTest | Performs a hit test. |
![]() | invalidateLayout | Updates the control layout information. |
![]() | isPaintSuspended | Get if spread paint is suspended. |
![]() | nextControl | Gets or sets the next control used by GC.Spread.Sheets.Actions.selectNextControl and GC.Spread.Sheets.Actions.moveToNextCellThenControl. |
![]() | previousControl | Gets or sets the previous control used by GC.Spread.Sheets.Actions.selectPreviousControl and GC.Spread.Sheets.Actions.moveToPreviousCellThenControl. |
![]() | Prints the specified sheet. | |
![]() | refresh | Manually refreshes the layout and rendering of the Workbook object. |
![]() | removeCustomFunction | Removes a custom function. |
![]() | removeCustomName | Removes the specified custom name. |
![]() | removeNamedStyle | Removes a style from the Workbook named styles collection which has the specified name. |
![]() | removeSheet | Removes the specified sheet. |
![]() | removeSparklineEx | Removes a SparklineEx from the SparklineEx collection. |
![]() | repaint | Repaints the Workbook control. |
![]() | resumeCalcService | Resumes the calculation service. |
![]() | resumeEvent | Resumes the event. |
![]() | resumePaint | Resumes the paint of active sheet and tab strip. |
![]() | savePDF | Exports the specified sheet to PDF. |
![]() | search | Searches the text in the cells in the specified sheet for the specified string with the specified criteria. |
![]() | setActiveSheet | Sets the active sheet by name. |
![]() | setActiveSheetIndex | Sets the active sheet index for the control. |
![]() | setSheetCount | Sets the number of sheets. |
![]() | startSheetIndex | Gets or sets the index of the first sheet to display in the spreadsheet. |
![]() | suspendCalcService | Suspends the calculation service. |
![]() | suspendEvent | Suspends the event. |
![]() | suspendPaint | Suspends the paint of active sheet and tab strip. |
![]() | toJSON | Saves the object state to a JSON string. |
![]() | unbind | Removes the binding of an event to Workbook. |
![]() | unbindAll | |
![]() | undoManager | Gets the undo manager. |