GridJsWorkbook

GridJsWorkbook class

Represents the main entry class for GridJs

public class GridJsWorkbook

Constructors

Name Description
GridJsWorkbook() The default constructor.

Properties

Name Description
Settings { get; set; } Represents the workbook settings.
WarningCallback { get; set; } Gets or sets warning callback for import file.

Methods

Name Description
CopyImageOrShape(string, string) copy image or shape in the worksheet
ErrorJson(string) return error message
ExportToJson() Get json from workbook
ExportToJson(string) Get json from workbook
ExportToJsonStringBuilder(string) Get json from workbook
GetJsonByUid(string, string) get the json from cache by uid
ImportExcelFile(string) Imports from an excel file.
ImportExcelFile(Workbook) Imports from Workbook.
ImportExcelFile(Stream, GridLoadFormat) Imports from an excel file stream.must provide loadformat and can set GridJsWorkbook.CacheImp to implement stream cache
ImportExcelFile(string, string) Imports from an excel file.
ImportExcelFile(string, Workbook) Imports from an excel file.
ImportExcelFile(Stream, GridLoadFormat, string) Imports from an excel file stream.must provide loadformat and can set GridJsWorkbook.CacheImp to implement stream cache
ImportExcelFile(string, Stream, GridLoadFormat) Imports from an excel file stream.must provide loadformat and can set GridJsWorkbook.CacheImp to implement stream cache
ImportExcelFile(string, string, string) Imports from an excel file.
ImportExcelFile(string, Stream, GridLoadFormat, string) Imports from an excel file stream.must provide loadformat and can set GridJsWorkbook.CacheImp to implement stream cache
ImportExcelFileFromJson(string) Import file from json
InsertImage(string, string, Stream, string) insert image in the worksheet
MergeExcelFileFromJson(string, string) Apply style update to the cache file
SaveToCacheWithFileName(string, string, string) Saves the worksheets to the cache, save format is baseed on the file extension of filename .
SaveToExcelFile(Stream) Saves the worksheets to the sream,baseed on the origin file format .
SaveToExcelFile(string) Saves the worksheets to the file path,if the file has extension ,save format is baseed on the file extension .
SaveToHtml(Stream) Saves the worksheets to the sream,the save format is html
SaveToHtml(string) Saves the worksheets to the file path,the save format is html
SaveToPdf(Stream) Saves the worksheets to the sream,the save format is pdf
SaveToPdf(string) Saves the worksheets to the file path,the save format is pdf
SaveToXlsx(Stream) Saves the worksheets to the sream,the save format is xlsx
SaveToXlsx(string) Saves the worksheets to the file path,the save format is xlsx
SetInterruptMonitorForLoad(GridInterruptMonitor, int) set InterruptMonitor for load operation for workbook
SetInterruptMonitorForSave(GridInterruptMonitor) set InterruptMonitor for save operation for workbook
UpdateCell(string, string) Do update operation
static GetGridLoadFormat(string) Get GridLoadFormat by file extension
static GetImageStream(string, string) Get Stream of Image from workbook
static GetImageUrl(string, string, string) Get the image URL
static GetUidForFile(string) Generate the uid for the file

Fields

Name Description
static CacheImp Custom implemention for cache storage,If you want to store cache in stream way ,you need to set and implement it
static CalculateEngine Custom implemention for calculation engine ,If you want to do custom calculation, you need to set and implement it

See Also