Spread.Sheets Documentation
Workbook Method
GC.Spread Namespace > Sheets type : Workbook Method
- The host DOM element.
Represents a spreadsheet with the specified hosted DOM element and options setting.
Syntax
var value; // Type: any
value = GC.Spread.Sheets.Workbook(host);
function Workbook( 
   host : Object
) : any;

Parameters

host
- The host DOM element.
Example
The following examples show how to use the options in the Workbook method. 
spread.options.allowUndo = true;
spread.options.showDragDropTip = true;
spread.options.showDragFillTip = true;
spread.options.showScrollTip = GC.Spread.Sheets.ShowScrollTip.both;
spread.options.showResizeTip = GC.Spread.Sheets.ShowResizeTip.both;
This example sets the background color and the gray area background color.
spread.options.backColor = "green";
spread.options.grayAreaBackColor = "Accent 2";
This example sets the gray area background color.
spread.options.grayAreaBackColor = "red";
spread.options.highlightInvalidData = true;
var dv = GC.Spread.Sheets.DataValidation.createDateValidator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.between, new Date(2012, 11, 31), new Date(2013, 11, 31));
dv.showInputMessage(true);
dv.inputMessage("Enter a date between 12/31/2012 and 12/31/2013.");
dv.inputTitle("Tip");
var style = new GC.Spread.Sheets.Style();
style.validator = dv;
activeSheet.setStyle(1,1,style,GC.Spread.Sheets.SheetArea.viewport);
spread.options.allowUserResize = true;
spread.options.allowUserDragDrop = true;
spread.options.allowUserDragFill = true;
var index = spread.options.tabStripRatio;
alert(index);
spread.options.referenceStyle = GC.Spread.Sheets.ReferenceStyle.r1c1;
This example prevents the user from zooming the sheet, but changes the zoom setting in code.
spread.options.allowUserZoom = false;
activeSheet.zoom(3);
spread.options.showHorizontalScrollbar = false;
spread.options.showVerticalScrollbar = false;
spread.options.allowUserEditFormula = true;
This example executes a command that performs a specified action.
spread.options.allowUndo = true;
spread.commandManager().execute({cmd: "outlineRow", sheetName: "Sheet1", index: 3, count: 5});
This example sets up the spreadsheet's tabs and tab strip.
spread.options.tabStripVisible = true;
spread.options.tabEditable = true;
spread.options.newTabVisible = true;
spread.options.tabStripRatio = 1;
spread.options.allowSheetReorder = true;
spread.options.cutCopyIndicatorVisible = true;
spread.options.cutCopyIndicatorBorderColor = "red";
spread.options.useTouchLayout = true;
//select a block of values using the drag fill icon
activeSheet.options.defaultDragFillType = GC.Spread.Sheets.Fill.AutoFillType.clearValues;
activeSheet.options.showDragFillSmartTag = true;
activeSheet.options.scrollbarMaxAlign =true;
activeSheet.options.scrollbarShowMax = true;
spread.options.hideSelection = true;
spread.options.enableFormulaTextbox = true;
spread.options.resizeZeroIndicator = GC.Spread.Sheets.ResizeZeroIndicator.enhanced;
activeSheet.getRange(-1, 2, -1, 1).width(0);
activeSheet.getRange(1, -1, 1, -1).height(0);
spread.options.tabNavigationVisible = false;
spread.options.scrollIgnoreHidden = true;
activeSheet.getRange(-1, 1, -1, 1).width(0);
activeSheet.getRange(1, -1, 1, -1).height(0);
activeSheet.getRange(-1, 3, -1, 1).visible(false);
Remarks

Use the showVerticalScrollbar option to specify whether the spreadsheet displays a vertical scroll bar.

Use the showHorizontalScrollbar option to specify whether the spreadsheet displays a horizontal scroll bar.

The useTouchLayout option increases the size of the navigation buttons in the tab strip and the scrollbar and also increases the size of various buttons involved in grouping, filtering, and validation. This option does not require touch support.

This table displays the properties for 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.
See Also

Reference

Sheets type
Using Drag Fill
Using Drag and Move
Using the Tab Strip
Using Formulas
Using Clipboard Operations
Using Touch Support with the Tab Strip

 

 

© 2018 All Rights Reserved.

Send comments on this topic.