aspose.cells
Class WorkbookDesigner

Encapsulates the object that represents a designer spreadsheet.

Constructor Summary
WorkbookDesigner()
           Initializes a new instance of the WorkbookDesigner class.
WorkbookDesigner(workbook)
           Initializes a new instance of the WorkbookDesigner class.
 
Property Getters/Setters Summary
functiongetCalculateFormula()
functionsetCalculateFormula(value)
           Indicates whether formulas should be calculated.
functiongetRepeatFormulasWithSubtotal()
functionsetRepeatFormulasWithSubtotal(value)
           Indicates whether repeating formulas with subtotal row.
functiongetUpdateEmptyStringAsNull()
functionsetUpdateEmptyStringAsNull(value)
           If TRUE, Null will be inserted if the value is "";
functiongetUpdateReference()
functionsetUpdateReference(value)
           Indicates if references in other worksheets will be updated.
functiongetWorkbook()
functionsetWorkbook(value)
           Gets and sets the Workbook object.
 
Method Summary
functionclearDataSource()
           Clears all data sources.
functiongetSmartMarkers()
           Returns a collection of smart markers in a spreadsheet.
functionprocess()
           Processes the smart markers and populates the data source values.
functionprocess(isPreserved)
           Processes the smart markers and populates the data source values.
functionprocess(sheetIndex, isPreserved)
           Processes the smart markers and populates the data source values.
functionsetDataSource(variable, data)
           Sets data binding to a variable.
functionsetDataSource(variable, dataArray)
           Sets data array binding to a variable.
 

Constructor Detail

WorkbookDesigner

function WorkbookDesigner()
Initializes a new instance of the WorkbookDesigner class.

WorkbookDesigner

function WorkbookDesigner(workbook)
Initializes a new instance of the WorkbookDesigner class.
Parameters:
workbook: Workbook - The template workbook file.

Property Getters/Setters Detail

getWorkbook/setWorkbook : Workbook 

function getWorkbook() / function setWorkbook(value)
Gets and sets the Workbook object.

getRepeatFormulasWithSubtotal/setRepeatFormulasWithSubtotal : boolean 

function getRepeatFormulasWithSubtotal() / function setRepeatFormulasWithSubtotal(value)
Indicates whether repeating formulas with subtotal row.

getUpdateEmptyStringAsNull/setUpdateEmptyStringAsNull : boolean 

function getUpdateEmptyStringAsNull() / function setUpdateEmptyStringAsNull(value)
If TRUE, Null will be inserted if the value is "";

getUpdateReference/setUpdateReference : boolean 

function getUpdateReference() / function setUpdateReference(value)
Indicates if references in other worksheets will be updated.

getCalculateFormula/setCalculateFormula : boolean 

function getCalculateFormula() / function setCalculateFormula(value)
Indicates whether formulas should be calculated.

Method Detail

clearDataSource

function clearDataSource()
Clears all data sources.

setDataSource

function setDataSource(variable, data)
Sets data binding to a variable.
Parameters:
variable: String - Variable name created using smart marker.
data: Object - Source data.

setDataSource

function setDataSource(variable, dataArray)
Sets data array binding to a variable.
Parameters:
variable: String - Variable name created using smart marker.
dataArray: Object[] - Source data array.

process

function process()
Processes the smart markers and populates the data source values.

process

function process(isPreserved)
Processes the smart markers and populates the data source values.
Parameters:
isPreserved: boolean - True if the unrecognized smart marker is preserved.

process

function process(sheetIndex, isPreserved)
Processes the smart markers and populates the data source values. This method works on worksheet level.
Parameters:
sheetIndex: Number - Worksheet index.
isPreserved: boolean - True if the unrecognized smart marker is preserved.

getSmartMarkers

function 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.
Returns:
A collection of smart markers

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.