Represents a spreadsheet with the specified hosted DOM element and options setting.
Syntax
var instance = new GcSpread.Sheets.Spread(host, options);
function Spread;
Inheritance Hierarchy
Object
GcSpread.Sheets.Spread
Constructors
| Name | Description | |
|---|---|---|
 | Spread Constructor | Represents a spreadsheet with the specified hosted DOM element and options setting. |
Fields
| Name | Description | |
|---|---|---|
 | name | Represents the name of the Spread control. |
| sheets | Represents the sheet collection. |
| touchToolStrip | Represents the touch toolstrip. |
Methods
| Name | Description | |
|---|---|---|
 | addCustomFunction | Adds a custom function. |
| addCustomFunctionDescription | Adds a custom function description. |
| addCustomName | Adds a custom name. |
| addNamedStyle | Adds a style to the Spread named styles collection. |
| addSheet | Inserts a sheet at the specific index. |
| addSparklineEx | Adds a SparklineEx to the SparklineEx collection. |
| allowSheetReorder | Gets or sets whether the user can change the order of the sheets by dragging their sheet tabs. |
| allowUndo | Gets or sets whether to allow the user to undo edit operations. |
| allowUserResize | Gets or sets whether to allow the user to resize columns and rows. |
| allowUserZoom | Gets or sets whether the user can scale the display of the component using the Ctrl key and the mouse wheel. |
| autoFitType | Gets or sets whether the content will be automatically formatted to fit within a cell. |
| backColor | Gets or sets 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. |
| backgroundImage | Gets or sets the background image of the Spread component. |
| backgroundImageLayout | Gets or sets the background image layout for the Spread component. |
| bind | Binds an event to the Spread. |
| canUserDragDrop | Gets or sets whether to allow the user to drag and drop cell range data to another range. |
| canUserDragFill | Gets or sets whether to allow the user to drag fill a range of cells. |
| canUserEditFormula | Gets or sets whether to allow the user to edit formulas in a cell in the spreadsheet. |
| clearCustomFunctionDescriptions | Clears all custom function descriptions. |
| clearCustomFunctions | Clears all custom functions. |
| clearCustomNames | Clears custom names. |
| clearSheets | Clears all sheets in the control. |
| cutCopyIndicatorBorderColor | Gets or sets the border color for the indicator displayed when the user cuts or copies the selection. |
| cutCopyIndicatorVisible | Gets or sets whether to display an indicator when copying or cutting the selected item. |
| defaultDragFillType | Gets or sets the default fill type. |
| destroy | Repaints the Spread control. |
| doCommand | Performs a command. |
| enableFormulaTextbox | Gets or sets whether to enable the formula text box in the spreadsheet. |
| focus | Gets or sets whether the Spread component has the 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. |
| getCalcService | Gets the calculation service of the Spread. |
| getCustomFunction | Gets a custom function. |
| getCustomFunctionDescription | Gets a custom function description. |
| getCustomName | Gets the specified custom name information. |
| getCustomNames | Gets all custom name information. |
| getHost | Gets the host element of the current Spread instance. |
| getNamedStyle | Gets a style from the Spread named styles collection that has the same name as the specified name. |
| getNamedStyles | Gets named styles from Spread. |
| 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. |
| getTabStripRatio | Gets the width of the tab strip for this component expressed as a percentage of the overall horizontal scroll bar width. |
| grayAreaBackColor | Gets or sets 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. |
| hideSelection | Gets or sets whether to display the selection highlighting when the Spread component does not have the focus. |
| highlightInvalidData | Gets or sets whether to highlight invalid data. |
| invalidateLayout | Updates the control layout information. |
| isPaintSuspended | Gets or sets a property that indicates whether to refresh automatically or manually after changing Spread user interface settings. |
| newTabVisible | Gets or sets whether the spreadsheet displays a special tab that allows users to insert new sheets. |
| nextControl | Gets or sets the next control used by GcSpread.Sheets.SpreadActions.selectNextControl and GcSpread.Sheets.SpreadActions.moveToNextCellThenControl. |
| previousControl | Gets or sets the previous control used by GcSpread.Sheets.SpreadActions.selectPreviousControl and GcSpread.Sheets.SpreadActions.moveToPreviousCellThenControl. |
| Prints the specified sheet. | |
| referenceStyle | Gets or sets the style for cell and range references in cell formulas. |
| refresh | Manually refreshes the layout and rendering of the Spread object. |
| removeCustomFunction | Removes a custom function. |
| removeCustomFunctionDescription | Removes a custom function description. |
| removeCustomName | Removes the specified custom name. |
| removeNamedStyle | Removes a style from the Spread named styles collection that has the same name as the specified name. |
| removeSheet | Removes the specified sheet. |
| removeSparklineEx | Removes a SparklineEx from the SparklineEx collection. |
| repaint | Repaints the Spread control. |
| resizeZeroIndicator | Gets or sets the drawing policy when the row or column is resized to zero. |
| resumeCalcService | Resumes the calculation service. |
| resumeEvent | Resumes the event |
| scrollbarMaxAlign | Gets or sets whether the scroll bar aligns with the last row and column of the active sheet. |
| scrollbarShowMax | Gets or sets whether the displayed scroll bars are based on the entire number of columns and rows in the sheet. |
| scrollIgnoreHidden | Gets or sets whether the scroll bar ignores hidden rows or columns. |
| 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. |
| setTabStripRatio | Sets the width of the tab strip expressed as a percentage of the overall horizontal scroll bar width. |
| showActiveCell | Moves the active cell to the specified position. |
| showCell | Moves a cell to the specified position. |
| showColumn | Moves a column to the specified position. |
| showDragDropTip | Gets or sets a value indicating whether to display the drag-drop tip. |
| showDragFillSmartTag | Gets or sets whether to display the drag fill dialog after ending a drag fill. |
| showDragFillTip | Gets or sets a value indicating whether to display the drag-fill tip. |
| showHorizontalScrollbar | Gets or sets whether to display the horizontal scroll bar. |
| showResizeTip | Gets or sets how to display the resize tip. |
| showRow | Moves a row to the specified position. |
| showScrollTip | Gets or sets how to display the scroll tip. |
| showVerticalScrollbar | Gets or sets whether to display the vertical scroll bar. |
| startSheetIndex | Gets or sets the index of the first sheet to display in the spreadsheet. |
| suspendCalcService | Suspends the calculation service. |
| suspendEvent | Suspends the event. |
| tabEditable | Gets or sets whether the user can edit the sheet tab strip. |
| tabNavigationVisible | Gets or sets the display policy for the sheet tab navigation. |
| tabStripVisible | Gets or sets the display policy for the sheet tab strip. |
| toJSON | Saves the object state to a JSON string. |
| unbind | Removes the binding of an event to Spread. |
| unbindAll | Removes the binding of all events to Spread. |
| useTouchLayout | Gets or sets whether to use touch layout to present the Spread component. |
See Also