com.aspose.cells

Class WorkbookDesigner

java.lang.Object

com.aspose.cells.WorkbookDesigner

public class WorkbookDesigner
extends java.lang.Object

Encapsulates the object that represents a designer spreadsheet.

Example

 
         //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");
 

Constructor Summary

Constructors

Constructor and Description
WorkbookDesigner() Initializes a new instance of the WorkbookDesigner class.
WorkbookDesigner(Workbook workbook) Initializes a new instance of the WorkbookDesigner class.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearDataSource() Clears all data sources.
boolean	containsVariables() Deprecated. Use WorkbookDesigner.VariablesWorksheetName property, instead.
boolean	getCalculateFormula() Indicates whether formulas should be calculated.
ISmartMarkerCallBack	getCallBack() Gets callback interface of processing smartmarker.
boolean	getLineByLine() Deprecated. Use range smart markers instead.
boolean	getRepeatFormulasWithSubtotal() Indicates whether repeating formulas with subtotal row.
java.lang.String[]	getSmartMarkers() Returns a collection of smart markers in a spreadsheet.
boolean	getSortDataSource() Indicates whether sorting data source.
boolean	getUpdateEmptyStringAsNull() If TRUE, Null will be inserted if the value is "";
boolean	getUpdateReference() Indicates if references in other worksheets will be updated.
java.lang.String	getVariablesWorksheetName() Gets the name of the worksheet which contains variables smart marker.
Workbook	getWorkbook() Gets the Workbook object.
void	process() Processes the smart markers and populates the data source values.
void	process(boolean isPreserved) Processes the smart markers and populates the data source values.
void	process(int sheetIndex, boolean isPreserved) Processes the smart markers and populates the data source values.
void	process(Range range, boolean isPreserved) Deprecated. Use Range smart markers instead.
void	setCalculateFormula(boolean value) Indicates whether formulas should be calculated.
void	setCallBack(ISmartMarkerCallBack value) Sets callback interface of processing smartmarker.
void	setContainsVariables(boolean value) Deprecated. Use WorkbookDesigner.VariablesWorksheetName property, instead.
void	setDataSource(java.sql.ResultSet rs) Set the data source.
void	setDataSource(java.lang.String dataSource, ICellsDataTable cellsDataTable) Sets data source of a ICellsDataTable object.
void	setDataSource(java.lang.String variable, java.lang.Object data) Sets data binding to a variable.
void	setDataSource(java.lang.String dataSource, java.sql.ResultSet rs) Set the data source.
void	setDataSource(java.lang.String dataSource, java.sql.ResultSet rs, int rowCount) Set the data source.
void	setJsonDataSource(java.lang.String name, java.lang.String json) Set json string value as data source of smart markers.
void	setLineByLine(boolean value) Deprecated. Use range smart markers instead.
void	setRepeatFormulasWithSubtotal(boolean value) Indicates whether repeating formulas with subtotal row.
void	setSortDataSource(boolean value) Indicates whether sorting data source.
void	setUpdateEmptyStringAsNull(boolean value) If TRUE, Null will be inserted if the value is "";
void	setUpdateReference(boolean value) Indicates if references in other worksheets will be updated.
void	setVariablesWorksheetName(java.lang.String value) Sets the name of the worksheet which contains variables smart marker.
void	setWorkbook(Workbook value) Sets the Workbook object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

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.

Method Detail

getWorkbook

public Workbook getWorkbook()

Gets the Workbook object.

setWorkbook

public void setWorkbook(Workbook value)

Sets the Workbook object.

getRepeatFormulasWithSubtotal

public boolean getRepeatFormulasWithSubtotal()

Indicates whether repeating formulas with subtotal row.

setRepeatFormulasWithSubtotal

public void setRepeatFormulasWithSubtotal(boolean value)

Indicates whether repeating formulas with subtotal row.

clearDataSource

public void clearDataSource()

Clears all data sources.

setDataSource

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.

setJsonDataSource

public void setJsonDataSource(java.lang.String name,
                     java.lang.String json)

Set json string value as data source of smart markers.

Parameters:

name - The name of the table. If the value of JSON represents an object,it coult be null.

json - The value of Json string.

setDataSource

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.

getUpdateEmptyStringAsNull

public boolean getUpdateEmptyStringAsNull()

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

setUpdateEmptyStringAsNull

public void setUpdateEmptyStringAsNull(boolean value)

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

getUpdateReference

public boolean getUpdateReference()

Indicates if references in other worksheets will be updated.

setUpdateReference

public void setUpdateReference(boolean value)

Indicates if references in other worksheets will be updated.

getCalculateFormula

public boolean getCalculateFormula()

Indicates whether formulas should be calculated.

setCalculateFormula

public void setCalculateFormula(boolean value)

Indicates whether formulas should be calculated.

getCallBack

public ISmartMarkerCallBack getCallBack()

Gets callback interface of processing smartmarker.

setCallBack

public void setCallBack(ISmartMarkerCallBack value)

Sets callback interface of processing smartmarker.

getLineByLine

public boolean getLineByLine()

Deprecated. Use range smart markers instead.

Indicates whether processing the smart marker line by line.

Remarks

NOTE: This class is now obsolete. Instead, please use range smart markers. This property will be removed 12 months later since July 2025. Aspose apologizes for any inconvenience you may have experienced.

setLineByLine

public void setLineByLine(boolean value)

Deprecated. Use range smart markers instead.

Indicates whether processing the smart marker line by line.

Remarks

NOTE: This class is now obsolete. Instead, please use range smart markers. This property will be removed 12 months later since July 2025. Aspose apologizes for any inconvenience you may have experienced.

process

public void process(Range range,
           boolean isPreserved)

Deprecated. Use Range smart markers instead.

Processes the smart markers and populates the data source values.

Remarks

NOTE: This class is now obsolete. Instead, please use Range smart markers. This property will be removed 12 months later since July 2025. Aspose apologizes for any inconvenience you may have experienced.

Parameters:

range - The range to be processed

isPreserved - True if the unrecognized smart marker is preserved.

process

public void process()

Processes the smart markers and populates the data source values.

process

public void process(boolean isPreserved)

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)

Processes the smart markers and populates the data source values.

Remarks

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.

Remarks

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,
                 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)

Set the data source.

Parameters:

dataSource - The name of the data source.

rs - The result set.

setDataSource

public void setDataSource(java.sql.ResultSet rs)

Set the data source.

Parameters:

rs - The result set.

containsVariables

public boolean containsVariables()

Deprecated. Use WorkbookDesigner.VariablesWorksheetName property, instead.

Indicates whether the first worksheet contains custom variables.

Remarks

NOTE: This member is now obsolete. Instead, please use WorkbookDesigner.VariablesWorksheetName property, instead. This property will be removed 3 months later since September 2025. Aspose apologizes for any inconvenience you may have experienced.

setContainsVariables

public void setContainsVariables(boolean value)

Deprecated. Use WorkbookDesigner.VariablesWorksheetName property, instead.

Indicates whether the first worksheet contains custom variables.

Remarks

NOTE: This member is now obsolete. Instead, please use WorkbookDesigner.VariablesWorksheetName property, instead. This property will be removed 3 months later since September 2025. Aspose apologizes for any inconvenience you may have experienced.

getVariablesWorksheetName

public java.lang.String getVariablesWorksheetName()

Gets the name of the worksheet which contains variables smart marker.

setVariablesWorksheetName

public void setVariablesWorksheetName(java.lang.String value)

Sets the name of the worksheet which contains variables smart marker.

getSortDataSource

public boolean getSortDataSource()

Indicates whether sorting data source.

Remarks

Only for JSON data source.

setSortDataSource

public void setSortDataSource(boolean value)

Indicates whether sorting data source.

Remarks

Only for JSON data source.