Class CalcWorkbook
CalcWorkbook holds a collection of CalcSheet objects.
Inheritance
Namespace: Syncfusion.Calculate
Assembly: Syncfusion.Calculate.Portable.dll
Syntax
public class CalcWorkbook : ObjectConstructors
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. |
| System.Collections.Generic.Dictionary<System.Object, System.Object> | namedRanges | Hashtable of key, value pairs for Namedrange values. |
Fields
sheetNames
ArrayList of strings holding the CalcSheets names.
Declaration
public List<object> sheetNamesField Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<System.Object> |
Properties
CalcSheetList
Gets or sets an Arraylist of CalcSheet objects used in this workbook.
Declaration
public CalcSheetList CalcSheetList { get; set; }Property Value
| Type | Description |
|---|---|
| CalcSheetList |
calcSheets
Array of CalcSheets objects used in this workbook.
Declaration
public CalcSheet[] calcSheets { get; }Property Value
| Type | Description |
|---|---|
| CalcSheet[] |
Engine
Gets/Sets the CalcEngine object.
Declaration
public CalcEngine Engine { get; set; }Property Value
| Type | Description |
|---|---|
| CalcEngine |
Remarks
The setter only sets once, and only if InitCalcWorkbook has been called with a zero CalcSheet count.
Item[Int32]
Gets / sets a CalcSheet object with the given index.
Declaration
public CalcSheet this[int sheetIndex] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | sheetIndex | The sheet index. |
Property Value
| Type | Description |
|---|---|
| CalcSheet |
Item[String]
Gets / sets a CalcSheet object with the given name.
Declaration
public CalcSheet this[string sheetName] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| System.String | sheetName | The sheet name. |
Property Value
| Type | Description |
|---|---|
| CalcSheet |
SheetCount
Number of CalcSheets in this workbook.
Declaration
public int SheetCount { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
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 |
|---|---|---|
| System.String | sheetName | The CalcSheet name. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The integer ID. |