com.aspose.cells
Class WorkbookDesigner

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

public class WorkbookDesigner 
extends java.lang.Object

//Create WorkbookDesigner object.
WorkbookDesigner wd = new WorkbookDesigner();
//Open the template file (which contains smart markers).
wd.setWorkbook(new Workbook("SmartMarker_Designer.xls"));

//Initialize your data from data source
//DataSet ds = new DataSet();
//...

//Set the datatable as the data source.
//wd.SetDataSource(dt);
//Process the smart markers to fill the data into the worksheets.
wd.process(true);
//Save the excel file.
wd.getWorkbook().save("outSmartMarker_Designer.xls");

WorkbookDesigner

public WorkbookDesigner()

Initializes a new instance of the WorkbookDesigner class.

WorkbookDesigner

public WorkbookDesigner(Workbook workbook)

Initializes a new instance of the WorkbookDesigner class.

Parameters:

workbook - The template workbook file.

public Workbook getWorkbook() / public void setWorkbook(Workbook value)

Gets and sets the Workbook object.

public void setWorkbook(Workbook value)

public boolean getRepeatFormulasWithSubtotal() / public void setRepeatFormulasWithSubtotal(boolean value)

Indicates whether repeating formulas with subtotal row.

public void setRepeatFormulasWithSubtotal(boolean value)

public boolean getUpdateEmptyStringAsNull() / public void setUpdateEmptyStringAsNull(boolean value)

If TRUE, Null will be inserted if the value is "";

public void setUpdateEmptyStringAsNull(boolean value)

public boolean getUpdateReference() / public void setUpdateReference(boolean value)

Indicates if references in other worksheets will be updated.

public void setUpdateReference(boolean value)

public boolean getCalculateFormula() / public void setCalculateFormula(boolean value)

Indicates whether formulas should be calculated.

public void setCalculateFormula(boolean value)

public ISmartMarkerCallBack getCallBack() / public void setCallBack(ISmartMarkerCallBack value)

Gets and sets callback interface of processing smartmarker.

public void setCallBack(ISmartMarkerCallBack value)

public boolean getLineByLine() / public void setLineByLine(boolean value)

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".

public void setLineByLine(boolean value)

public void clearDataSource()

Clears all data sources.

public void setDataSource(java.lang.String dataSource, ICellsDataTable cellsDataTable)

Sets data source of a ICellsDataTable object.

Parameters:

dataSource - The name of the data source.

cellsDataTable - data table.

public void setDataSource(java.lang.String variable, java.lang.Object data)

Sets data binding to a variable.

Parameters:

variable - Variable name created using smart marker.

data - Source data.

public void process()
            throws java.lang.Exception

Processes the smart markers and populates the data source values.

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.

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.

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