IWorkbook Interface

Represents an IWorkbook object.

Namespace: GrapeCity.Documents.Excel

Assembly: DS.Documents.Excel.dll

Syntax

public interface IWorkbook

Public Interface IWorkbook

Properties

Name	Description
ActiveSheet	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 (read-only).
AllowDynamicArray	Gets or sets whether allow dynamic array formula.
AutoParse	Determines whether to automatically parse string values when setting a range value.
AutoRoundValue	Determines whether to round the number to 15 significant figures when getting the value.
BookView	Returns an object that represents the view settings of this workbook(read-only).
BuiltInDocumentProperties	Gets a collection that represents all the built-in document properties of the workbook.
Culture	[Init-only] Gets or sets culture for the workbook. The culture must contain both country/region and language.
CustomDocumentProperties	Gets a collection that represents all the custom document properties of the workbook.
CustomViews	Gets the custom views of the workbook.
DefaultTableStyle	Specifies the table style name from the ITableStyleCollection collection that is used as the default TableStyle (read/write).
DeferUpdateDirtyState	Gets or sets whether update the dirty state of the formula cells immediately when changing the value of a cell.
EnableCalculation	Gets or sets whether the calculation engine is valid.
FullName	Returns the name of the workbook, including its path on disk.
GraphicsInfo	Provides graphics information. If this property doesn't have value, the workbook will use built-in graphic information.
Name	Gets or sets a string value that represents the name of the workbook.
Names	Returns the INames collection that represents the workbook-specified names. This is a read-only INames object.
Options	Returns the IExcelOptions object that represents some settings to control workbook behavior.
Path	Gets or sets a string that represents the path to the workbook file that this workbook object represents.
PivotCaches	Returns the IPivotCaches collection that represents all the IPivotTable caches in the specified workbook (read-only).
ProtectStructure	True if the order of the sheets in the workbook is protected. Read-only Boolean.
ProtectWindows	True if the windows of the workbook are protected. Read-only Boolean.
ReferenceStyle	Gets or sets the reference style.
ResetAdjacentRangeBorder	Determines whether to reset adjacent range's border when setting border for a range. The default value of this property is true.
SelectedSheets	Returns a IWorksheets collection that represents all the selected sheets in the specified workbook.
SheetTabs	Returns the ISheetTabs collection that represents all the sheet tabs in the specified workbook.
ShowPivotTableFieldList	Gets or sets a value indicating whether the PivotTable field list can be shown. Default is true.
Signatures	Gets a collection of Signature objects that correspond to the digital signature attached to a document.
SlicerCaches	Gets the ISlicerCaches object associated with the workbook.
Styles	Returns the IStyleCollection collection that represents all the styles in the specified workbook (read-only).
TableStyles	Returns the ITableStyleCollection collection object for the current workbook that refers to the styles used in the current workbook (read-only).
Theme	Returns or sets the theme applied to the current workbook.
Worksheets	Returns the IWorksheets collection that represents all the worksheets in the specified workbook. This is a read-only Sheets object.
WriteProtection	Provides access to the workbook write protection options.

Methods

Name	Description
AddDataSource(string, object)	Add data source for template.
Calculate()	Calculates formulas of the workbook as needed.
ConvertBarcodeToPicture(ImageType)	Convert the calculated barcodes to pictures and place them in their respective positions. The original barcode formulas will be cleared. Not support EMF and WMF image types.
Dirty()	Designates all the formulas of the workbook to be recalculated when the next calculation occurs.
FromJson(Stream, DeserializationOptions)	Generates a workbook from a JSON stream.
FromJson(string, DeserializationOptions)	Generates a workbook from a JSON string.
FromSjsJson(Stream)	Generates a workbook from a JSON stream containing the contents of .sjs file format.
FromSjsJson(Stream, SjsOpenOptions)	Generates a workbook from a JSON stream containing the contents of .sjs file format.
FromSjsJson(string)	Generates a workbook from a JSON string containing the contents of .sjs file format.
FromSjsJson(string, SjsOpenOptions)	Generates a workbook from a JSON string containing the contents of .sjs file format.
GenerateReport()	Process the template and return the instance of report workbook.
GenerateReport(params IWorksheet[])	Process the template and return the instance of report workbook.
GetExcelLinkSources()	Returns the names of the linked excel documents.
GetUsedFonts()	Gets all fonts information that used on workbook.
IsEncryptedFile(Stream)	Specifies whether the file is password protected.
IsEncryptedFile(string)	Specifies whether the file is password protected.
Open(Stream)	Opens the file stream.
Open(Stream, OpenFileFormat)	Opens the specified format file stream.
Open(Stream, OpenOptionsBase)	Opens the stream with specified options.
Open(Stream, string, OpenOptions)	Opens the specified excel file stream.
Open(string)	Opens the file.
Open(string, DeserializationOptions)	Opens the JSON file.
Open(string, OpenFileFormat)	Opens the specified format file.
Open(string, OpenOptionsBase)	Opens the file with specified options.
Open(string, string, OpenOptions)	Opens the specified excel file.
PrintOut(PrintOutOptions)	Prints the workbook.
ProcessTemplate()	Start to process the template
ProcessTemplate(CancellationToken)	Start to process the template with global options and cancellation support.
Protect(bool, bool)	Protects a workbook so that it cannot be modified.
Protect(string, bool, bool)	Protects a workbook so that it cannot be modified.
Save(Stream)	Saves the workbook to the stream.
Save(Stream, SaveFileFormat)	Saves the specified format file stream.
Save(Stream, SaveOptionsBase)	Saves workbook to stream with specified options.
Save(Stream, string, SaveOptions)	Saves data to the specified excel file stream.
Save(string)	Saves the workbook to the disk.
Save(string, SaveFileFormat)	Saves the specified format file.
Save(string, SaveOptionsBase)	Saves workbook to file with specified options.
Save(string, string, SaveOptions)	Saves data to the specified excel file.
ToJson(SerializationOptions)	Generates a JSON string from a workbook.
ToJson(Stream, SerializationOptions)	Generates a JSON stream from a workbook.
ToSjsJson()	Generates a JSON string from a workbook. It integrates all JSON files from the SJS file into a single string.
ToSjsJson(SjsSaveOptions)	Generates a JSON string from a workbook. It integrates all JSON files from the SJS file into a single string.
ToSjsJson(Stream)	Integrates all JSON files from the SJS file into a single string, then put the string into the stream.
ToSjsJson(Stream, SjsSaveOptions)	Integrates all JSON files from the SJS file into a single string, then put the string into the stream.
Unprotect(string)	Removes protection from the workbook.
UpdateExcelLink(string)	Updates a excel link.
UpdateExcelLink(string, IWorkbook)	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.

Events

Name	Description
AfterSave	Occurs after the workbook is saved.
BeforeSave	Occurs before the workbook is saved.
NewSheet	Occurs when a new sheet is created in the workbook.
Opened	Occurs when the workbook is opened.
SheetActivate	Occurs when a sheet is activate.
SheetBeforeDelete	Occurs before a sheet is deleted.
SheetChange	Occurs when something changes in the cells of a sheet.
SheetDeactivate	Occurs when a sheet is deactivated.
SheetSelectionChange	Occurs when the selection changes on a sheet.