| Name | Description | |
|---|---|---|
 | addDataSource | Add data source for template. |
| calculate | Calculates formulas of the workbook as needed. |
| convertBarcodeToPicture | Overloaded. Convert the calculated barcodes to pictures and place them in their respective positions. The original barcode formulas will be cleared. The com.grapecity.documents.excel.drawing.ImageType of converted image is com.grapecity.documents.excel.drawing.ImageType.SVG. |
| dirty | Designates all the formulas of the workbook to be recalculated when the next calculation occurs. |
| fromJson | Overloaded. Generates a workbook from a json string. |
| fromSjsJson | Overloaded. Generates a workbook from a JSON string containing the contents of .sjs file format. |
| generateReport | Overloaded. Process the template and return the instance of report workbook. |
| getActiveSheet | Returns an object that represents the active sheet (the sheet on top) in the active workbook or in the specified window or workbook. Returns null if no sheet is active. |
| getAfterSaveEvent | Occurs after the workbook is saved. |
| getAllowDynamicArray | Gets whether allow dynamic array formula. |
| getAuthor | Gets the author. |
| getAutoParse | Gets whether to automatically parse when setting a range value to a string value. |
| getAutoRoundValue | Gets whether to round the number to 15 significant figures when getting the value. |
| getBeforeSaveEvent | Occurs before the workbook is saved. |
| getBookView | Returns an object that represents the view settings of this workbook. |
| getBuiltInDocumentProperties | Gets a collection that represents all the built-in document properties of the workbook. |
| getCulture | Gets culture info for the workbook. Which influences the feature related culture. |
| getCustomDocumentProperties | Gets a collection that represents all the custom document properties of the workbook. |
| getCustomViews | Gets the custom views of the workbook. |
| getDefaultTableStyle | Gets the table style name from the ITableStyleCollection collectionthat is used as the default TableStyle. |
| getDeferUpdateDirtyState | Gets whether update the dirty state of the formula cells immediately when changing the value of a cell. |
| getEnableCalculation | Gets whether the calculation engine is valid. |
| getExcelLinkSources | Returns the names of the linked excel documents. |
| getFullName | Returns the name of the workbook, including its path on disk. |
| getGraphicsInfo | Provides graphics information. If this property doesn't have value, the workbook will use built-in graphic information. |
| getIconSets | Filters data in a workbook based on a cell icon from the IconSets collection. |
| getName | Gets a string value that represents the name of the workbook. |
| getNames | Returns the INames collection that represents the workbook-specified names. |
| getNewSheetEvent | Occurs when a new sheet is created in the workbook. |
| getOpenedEvent | Occurs when the workbook is opened. |
| getOptions | Returns the IExcelOptions object that represents some settings to control workbook behavior. |
| getPath | Gets a string that represents the path to the workbook file that this workbook object represents. |
| getPivotCaches | Returns the IPivotCaches collection that represents all the IPivotTable caches in the specified workbook. |
| getProtectStructure | True if the order of the sheets in the workbook is protected. Read-only Boolean. |
| getProtectWindows | True if the windows of the workbook are protected. Read-only Boolean. |
| getReferenceStyle | Gets the reference style. |
| getResetAdjacentRangeBorder | Determines whether to reset adjacent range's border when setting border for a range. The default value of this property is true. |
| getSelectedSheets | Returns a @code:IWorksheets collectionthat represents all the selected sheets in the specified workbook. |
| getSheetActivateEvent | Occurs when a sheet is activate. |
| getSheetBeforeDeleteEvent | Occurs before a sheet is deleted. |
| getSheetChangeEvent | Occurs when something changes in the cells of a sheet. |
| getSheetDeactivateEvent | Occurs when a sheet is deactivated. |
| getSheetSelectionChange | Occurs when the selection changes on a sheet. |
| getSignatures | Gets a collection of Signature objects that correspond to the digital signature attached to a document. |
| getSlicerCaches | Gets the ISlicerCaches object associated with the workbook. |
| getStyles | Returns the IStyleCollection collection that represents all thestyles in the specified workbook. |
| getTableStyles | Returns the ITableStyleCollection collection object for the currentworkbook that refers to the styles used in the current workbook. |
| getTheme | Returns the theme applied to the current workbook. |
| getUsedFonts | Gets all fonts information that used on workbook. |
| getWorksheets | Returns the IWorksheets collection that represents all the worksheetsin the specified workbook. This is a read-only Sheets object. |
| getWriteProtection | Returns a WriteProtection object that provides access to the workbook write protection options. |
| isEncryptedFile | Overloaded. Specifies whether the file is password protected. |
| open | Overloaded. Opens the specified excel file |
| processTemplate | Overloaded. Start to process the template. |
| protect | Overloaded. Protects a workbook so that it cannot be modified. |
| save | Overloaded. Saves the workbook to the disk. |
| setAllowDynamicArray | Sets whether allow dynamic array formula. |
| setAuthor | Sets the author. |
| setAutoParse | Sets whether to automatically parse when setting a range value to a string value. |
| setAutoRoundValue | Sets whether to round the number to 15 significant figures when getting the value. |
| setCulture | Sets culture info for the workbook. Which influences the feature related culture.
The culture must contain both country/region and language. For example:
|
| setDefaultTableStyle | Sets the table style name from the ITableStyleCollection collectionthat is used as the default TableStyle. |
| setDeferUpdateDirtyState | Sets whether update the dirty state of the formula cells immediately when changing the value of a cell. |
| setEnableCalculation | Sets whether the calculation engine is valid. |
| setGraphicsInfo | Provides graphics information. If this property doesn't have value, the workbook will use built-in graphic information. |
| setName | Sets a string value that represents the name of the workbook. |
| setPath | Sets a string that represents the path to the workbook file that this workbook object represents. |
| setReferenceStyle | Sets the reference style. |
| setResetAdjacentRangeBorder | Determines whether to reset adjacent range's border when setting border for a range. The default value of this property is true. |
| setTheme | Sets the theme applied to the current workbook. |
| toJson | Overloaded. Generates a json string from a workbook. |
| toSjsJson | Overloaded. Generates a JSON string from a workbook. It integrates all JSON files from the SpreadJS .sjs file into a single string. |
| unprotect | Overloaded. Removes protection from the workbook. |
| updateExcelLink | Overloaded. Updates a excel link. |
| updateExcelLinks | Updates all the excel links. |
| waitForCalculationToFinish | Waits for all calculation to complete, including asynchronous calculations. This method blocks the current thread until all calculations have finished. Users can call this method to ensure that all necessary computations have been performed before proceeding with any other operations that depend on the calculation results. |