Class CalcWorkbook
CalcWorkbook holds a collection of CalcSheet objects.
Inherited Members
Namespace: Syncfusion.XlsIO.Calculate
Assembly: Syncfusion.XlsIO.NET.dll
Syntax
public class CalcWorkbook
Constructors
CalcWorkbook(CalcSheet[], Dictionary<object, object>)
Initializes a new instance of the CalcWorkbook class.
Declaration
public CalcWorkbook(CalcSheet[] calcSheets, Dictionary<object, object> namedRanges)
Parameters
| Type | Name | Description |
|---|---|---|
| CalcSheet[] | calcSheets | The calc sheets. |
| Dictionary<object, object> | namedRanges | Hashtable of key, value pairs for Namedrange values. |
Fields
sheetNames
ArrayList of strings holding the CalcSheets names.
Declaration
[Obsolete("This field will be removed in a future version. Please use the CalcSheetList property instead.", false)]
public List<object> sheetNames
Field Value
| Type |
|---|
| List<object> |
Properties
CalcSheetList
Gets or sets an Arraylist of CalcSheet objects used in this workbook.
Declaration
public CalcSheetList CalcSheetList { get; set; }
Property Value
| Type |
|---|
| CalcSheetList |
Engine
Gets/Sets the CalcEngine object.
Declaration
public CalcEngine Engine { get; set; }
Property Value
| Type |
|---|
| CalcEngine |
Remarks
The setter only sets once, and only if InitCalcWorkbook has been called with a zero CalcSheet count.
this[int]
Gets / sets a CalcSheet object with the given index.
Declaration
public CalcSheet this[int sheetIndex] { get; set; }
Parameters
| Type | Name | Description |
|---|---|---|
| int | sheetIndex | The sheet index. |
Property Value
| Type |
|---|
| CalcSheet |
this[string]
Gets / sets a CalcSheet object with the given name.
Declaration
public CalcSheet this[string sheetName] { get; set; }
Parameters
| Type | Name | Description |
|---|---|---|
| string | sheetName | The sheet name. |
Property Value
| Type |
|---|
| CalcSheet |
SheetCount
Number of CalcSheets in this workbook.
Declaration
public int SheetCount { get; }
Property Value
| Type |
|---|
| int |
calcSheets
Array of CalcSheets objects used in this workbook.
Declaration
[Obsolete("This property will be removed in a future version. Please use the CalcSheetList property instead.", false)]
public CalcSheet[] calcSheets { get; }
Property Value
| Type |
|---|
| CalcSheet[] |
Methods
CalculateAll()
A Virtual method to calculate all formulas in this workbook.
Declaration
public virtual void CalculateAll()
ClearFormulas(CalcSheet)
Removes all formulas in the given CalcSheet.
Declaration
public void ClearFormulas(CalcSheet sheet)
Parameters
| Type | Name | Description |
|---|---|---|
| CalcSheet | sheet | The CalcSheet. |
GetSheetID(string)
A method that gets the integer ID of a CalcSheet.
Declaration
public int GetSheetID(string sheetName)
Parameters
| Type | Name | Description |
|---|---|---|
| string | sheetName | The CalcSheet name. |
Returns
| Type | Description |
|---|---|
| int | The integer ID. |