asposecells.api
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
methodgetCalculateFormula()
methodsetCalculateFormula(value)
           Indicates whether formulas should be calculated.
methodgetUpdateEmptyStringAsNull()
methodsetUpdateEmptyStringAsNull(value)
           If TRUE, Null will be inserted if the value is "";
methodgetUpdateReference()
methodsetUpdateReference(value)
           Indicates if references in other worksheets will be updated.
methodgetWorkbook()
methodsetWorkbook(value)
           Gets and sets the Workbook object.
 
Method Summary
methodclearDataSource()
           Clears all data sources.
methodgetSmartMarkers()
           Returns a collection of smart markers in a spreadsheet.
methodprocess()
           Processes the smart markers and populates the data source values.
methodprocess(isPreserved)
           Processes the smart markers and populates the data source values.
methodprocess(sheetIndex, isPreserved)
           Processes the smart markers and populates the data source values.
methodsetDataSource(variable, data)
           Sets data binding to a variable.
methodsetDataSource(variable, dataArray)
           Sets data array binding to a variable.
 

Constructor Detail

WorkbookDesigner

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

WorkbookDesigner

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

Property Getters/Setters Detail

getWorkbook/setWorkbook : Workbook 

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

getUpdateEmptyStringAsNull/setUpdateEmptyStringAsNull : boolean 

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

getUpdateReference/setUpdateReference : boolean 

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

getCalculateFormula/setCalculateFormula : boolean 

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

Method Detail

clearDataSource

 clearDataSource()
Clears all data sources.

setDataSource

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

setDataSource

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

process

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

process

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

process

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

getSmartMarkers

String[] 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.