com.aspose.cells
Class WorkbookDesigner

java.lang.Object
    extended by com.aspose.cells.WorkbookDesigner

public class WorkbookDesigner 
extends java.lang.Object

Encapsulates the object that represents a designer spreadsheet.

Constructor Summary
WorkbookDesigner()
           Initializes a new instance of the WorkbookDesigner class.
 
Property Getters/Setters Summary
booleangetCalculateFormula()
voidsetCalculateFormula(boolean value)
           Indicates whether formulas should be calculated.
booleangetUpdateReference()
voidsetUpdateReference(boolean value)
           Indicates if references in other worksheets will be updated.
WorkbookgetWorkbook()
voidsetWorkbook(Workbook value)
           Gets and sets the Workbook object.
 
Method Summary
voidclearDataSource()
           Clears all data sources.
java.lang.String[]getSmartMarkers()
           Returns a collection of smart markers in a spreadsheet.
voidprocess()
           Processes the smart markers and populates the data source values.
voidprocess(boolean isPreserved)
           Processes the smart markers and populates the data source values.
voidprocess(int sheetIndex, boolean isPreserved)
           Processes the smart markers and populates the data source values.
voidsetDataSource(java.lang.String dataSource, ICellsDataTable cellsDataTable)
           Set the data source.
voidsetDataSource(java.lang.String variable, java.lang.Object data)
           Sets data binding to a variable.
voidsetDataSource(java.lang.String variable, java.lang.Object[] dataArray)
           Sets data array binding to a variable.
voidsetDataSource(java.lang.String dataSource, java.sql.ResultSet rs)
          
voidsetDataSource(java.lang.String dataSource, java.sql.ResultSet rs, int rowCount)
           Set the data source.
voidsetDataSource(java.sql.ResultSet rs)
          
 

Constructor Detail

WorkbookDesigner

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

Property Getters/Setters Detail

getWorkbook/setWorkbook

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

getUpdateReference/setUpdateReference

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

getCalculateFormula/setCalculateFormula

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

Method Detail

clearDataSource

public void clearDataSource()
Clears all data sources.

setDataSource

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

setDataSource

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

process

public void process()
            throws java.lang.Exception
Processes the smart markers and populates the data source values.

process

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

process

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

getSmartMarkers

public java.lang.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

setDataSource

public void setDataSource(java.lang.String dataSource, ICellsDataTable cellsDataTable)
Set the data source.
Parameters:
dataSource - The name of the data source.
cellsDataTable - The interface of cells data table.

setDataSource

public void setDataSource(java.lang.String dataSource, java.sql.ResultSet rs, int rowCount)
Set the data source.
Parameters:
dataSource - The name of the data source.
rs - The result set.
rowCount - The data count of given resultset. It should be the exact row count or -1; If the resultset is forward only, user should give the exact row count here, otherwise the smart may not be processed correctly when the smart marker's "noadd" is not set.

setDataSource

public void setDataSource(java.lang.String dataSource, java.sql.ResultSet rs)

setDataSource

public void setDataSource(java.sql.ResultSet rs)

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