WorkbookDesigner
WorkbookDesigner class
Encapsulates the object that represents a designer spreadsheet.
new WorkbookDesigner()
Initializes a new instance of the WorkbookDesigner class.
Methods
| Name | Description |
|---|---|
| clearDataSource() | Clears all data sources. |
| constructor_overload$1(workbook) | Initializes a new instance of the WorkbookDesigner class. |
| containsVariables() | |
| getCalculateFormula() | Indicates whether formulas should be calculated. |
| getLineByLine() | Indicates whether processing the smart marker line by line. The default value is true. If False, the template file must |
| getRepeatFormulasWithSubtotal() | Indicates whether repeating formulas with subtotal row. |
| getSmartMarkers() | Returns a collection of smart markers in a spreadsheet. A string array is created on every call. The array is sorted and |
| getSortDataSource() | |
| getUpdateEmptyStringAsNull() | If TRUE, Null will be inserted if the value is “”; |
| getUpdateReference() | Indicates if references in other worksheets will be updated. |
| getVariablesWorksheetName() | |
| getWorkbook() | Gets and sets the Workbook object. |
| process() | |
| process() | Processes the smart markers and populates the data source values. |
| process(isPreserved) | Processes the smart markers and populates the data source values. |
| process(sheetIndex, isPreserved) | Processes the smart markers and populates the data source values. This method works on worksheet level. |
| setCalculateFormula() | Indicates whether formulas should be calculated. |
| setContainsVariables() | |
| setDataSource(variable, data) | Sets data binding to a variable. |
| setJsonDataSource(variable, data) | |
| setLineByLine() | Indicates whether processing the smart marker line by line. The default value is true. If False, the template file must |
| setRepeatFormulasWithSubtotal() | Indicates whether repeating formulas with subtotal row. |
| setSortDataSource() | |
| setUpdateEmptyStringAsNull() | If TRUE, Null will be inserted if the value is “”; |
| setUpdateReference() | Indicates if references in other worksheets will be updated. |
| setVariablesWorksheetName() | |
| setWorkbook() | Gets and sets the Workbook object. |
clearDataSource()
Clears all data sources.
constructor_overload$1(workbook)
Initializes a new instance of the WorkbookDesigner class.
| Parameter | Type | Description |
|---|---|---|
| workbook | Workbook | The template workbook file. |
containsVariables()
getCalculateFormula()
Indicates whether formulas should be calculated.
getLineByLine()
Indicates whether processing the smart marker line by line. The default value is true. If False, the template file must contain a range which is named as “_CellsSmartMarkers”.
getRepeatFormulasWithSubtotal()
Indicates whether repeating formulas with subtotal row.
getSmartMarkers()
Returns a collection of smart markers in a spreadsheet. A string array is created on every call. The array is sorted and duplicated values are removed.@return {String[]} A collection of smart markers
getSortDataSource()
getUpdateEmptyStringAsNull()
If TRUE, Null will be inserted if the value is “”;
getUpdateReference()
Indicates if references in other worksheets will be updated.
getVariablesWorksheetName()
getWorkbook()
Gets and sets the Workbook object.
process()
process()
Processes the smart markers and populates the data source values.
process(isPreserved)
Processes the smart markers and populates the data source values.
| Parameter | Type | Description |
|---|---|---|
| isPreserved | boolean | True if the unrecognized smart marker is preserved. |
process(sheetIndex, isPreserved)
Processes the smart markers and populates the data source values. This method works on worksheet level.
| Parameter | Type | Description |
|---|---|---|
| sheetIndex | Number | Worksheet index. |
| isPreserved | boolean | True if the unrecognized smart marker is preserved. |
setCalculateFormula()
Indicates whether formulas should be calculated.
setContainsVariables()
setDataSource(variable, data)
Sets data binding to a variable.
| Parameter | Type | Description |
|---|---|---|
| variable | String | Variable name created using smart marker. |
| data | Object | Source data. |
setJsonDataSource(variable, data)
| Parameter | Description |
|---|---|
| variable | |
| data |
setLineByLine()
Indicates whether processing the smart marker line by line. The default value is true. If False, the template file must contain a range which is named as “_CellsSmartMarkers”.
setRepeatFormulasWithSubtotal()
Indicates whether repeating formulas with subtotal row.
setSortDataSource()
setUpdateEmptyStringAsNull()
If TRUE, Null will be inserted if the value is “”;
setUpdateReference()
Indicates if references in other worksheets will be updated.
setVariablesWorksheetName()
setWorkbook()
Gets and sets the Workbook object.