Name | Description | |
---|---|---|
Workbook Constructor | Overloaded. |
The following tables list the members exposed by Workbook.
Name | Description | |
---|---|---|
Workbook Constructor | Overloaded. |
Name | Description | |
---|---|---|
FontProvider | Gets or sets the font provider that will be used when using Auto fit, PDF export, and Image export. | |
FontsFolderPath | Gets or sets the location of font files that will be used when exporting pdf. |
Name | Description | |
---|---|---|
AddCustomFunction | Overloaded. Add custom function into the function set. | |
addDataSource | Add data source for template. | |
calculate | Calculates formulas in 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 the 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 | Gets the active sheet. | |
getAfterSaveEvent | Occurs after the workbook is saved. | |
getAllowDynamicArray | Gets whether allow dynamic array formula. | |
getAuthor | Gets the author. | |
getAutoParse | Determines whether to parse automatically when setting range value to string value. | |
getAutoRoundValue | Determines 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 the culture info of workbook, default is Locale.getDefault(). | |
getCustomDocumentProperties | Gets a collection that represents all the custom document properties of the workbook. | |
getCustomViews | Gets a collection that represents all the custom document properties of the workbook. | |
getDefaultTableStyle | Specifies the table style that 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 | Specifies whether the calculation engine is working. | |
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 | Overloaded. 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 | Gets a PivotCaches collection that represents all the PivotTable 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 IWorksheets collection that represents all the selected sheets in the specified workbook. | |
getSheetActivateEvent | Occurs when a sheet is active. | |
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 | Provides access to the collection of cell styles in the current workbook. | |
getTableStyles | Gets the table styles used in the current workbook. | |
getTagJsonSerializer | Gets JSON serializer for custom type | |
getTheme | Returns an instance of ITheme which provides access to the theme associated with a workbook. | |
getUsedFonts | Gets all fonts information that are used on workbook. | |
getValueJsonSerializer | Gets JSON serializer for custom type | |
getWebRequestHandler | Gets the singleton instance of the IWebRequestHandler implementation that will be used to handle web requests. This property provides a centralized way to access the web request handler for the application. | |
getWorksheets | Gets a collection of worksheets contained in the workbook. | |
getWriteProtection | Provides access to the workbook write protection options. | |
importData | Overloaded. Import all the data of the specified source of the file. | |
isEncryptedFile | Overloaded. Specifies whether the file is password protected. | |
open | Overloaded. Opens the file with default options. The file type is inferred from file extension. | |
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. | |
SetLicenseFile | For licenses of the Chinese market, apply deployment license or unlimited dev license from file.
This method shouldn't be called if your license was purchased from other markets. | |
SetLicenseKey | Sets license for all workbook instances.
Important: For licenses of the Chinese market, use @code:SetLicenseFile orset license in the @code:GCEXCEL_JAVA_DEPLOY_LICENSE_V7 environment variable instead. | |
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. | |
setTagJsonSerializer | Sets JSON serializer for custom type in from/to JSON. | |
setTheme | Sets the theme applied to the current workbook. | |
setValueJsonSerializer | Sets JSON serializer for custom type in from/to JSON. | |
setWebRequestHandler | Sets the singleton instance of the IWebRequestHandler implementation that will be used to handle web requests. This property provides a centralized way to set the web request handler for the application. | |
toJson | Overloaded. Generates a JSON string from the workbook. | |
toSjsJson | Overloaded. Integrates all JSON files from the SpreadJS .sjs file into a single string, then put the string into the stream. | |
unprotect | Overloaded. Removes protection from the workbook. | |
updateExcelLink | Overloaded. Updates a excel link. | |
updateExcelLinks | Updates all the excel links. | |
waitForCalculationToFinish |