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.

Constructor Summary
WorkbookDesigner()
Initializes a new instance of the WorkbookDesigner class.
WorkbookDesigner(Workbook workbook)
Initializes a new instance of the WorkbookDesigner class.
 
Property Getters/Setters Summary
booleangetCalculateFormula()
void
setCalculateFormula(booleanvalue)
           Indicates whether formulas should be calculated.
ISmartMarkerCallBackgetCallBack()
void
           Gets and sets callback interface of processing smartmarker.
booleangetRepeatFormulasWithSubtotal()
void
           Indicates whether repeating formulas with subtotal row.
booleangetUpdateEmptyStringAsNull()
void
           If TRUE, Null will be inserted if the value is "";
booleangetUpdateReference()
void
setUpdateReference(booleanvalue)
           Indicates if references in other worksheets will be updated.
WorkbookgetWorkbook()
void
           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 name, ICellsDataTable dataTable)
Sets data source of a ICellsDataTable object.
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.
 

    • 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.
    • Property Getters/Setters Detail

      • getWorkbook/setWorkbook

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

        public boolean getRepeatFormulasWithSubtotal() / public void setRepeatFormulasWithSubtotal(boolean value)
        
        Indicates whether repeating formulas with subtotal row.
      • getUpdateEmptyStringAsNull/setUpdateEmptyStringAsNull

        public boolean getUpdateEmptyStringAsNull() / public void setUpdateEmptyStringAsNull(boolean value)
        
        If TRUE, Null will be inserted if the value is "";
      • 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.

    setWorkbook

    public voidsetWorkbook(Workbook value)
    
    Gets and sets the Workbook object.

    setRepeatFormulasWithSubtotal

    public voidsetRepeatFormulasWithSubtotal(booleanvalue)
    
    Indicates whether repeating formulas with subtotal row.

    setUpdateEmptyStringAsNull

    public voidsetUpdateEmptyStringAsNull(booleanvalue)
    
    If TRUE, Null will be inserted if the value is "";

    setUpdateReference

    public voidsetUpdateReference(booleanvalue)
    
    Indicates if references in other worksheets will be updated.

    setCalculateFormula

    public voidsetCalculateFormula(booleanvalue)
    
    Indicates whether formulas should be calculated.

    setCallBack

    public voidsetCallBack(ISmartMarkerCallBack value)
    
    Gets and sets callback interface of processing smartmarker.
    • Method Detail

      • clearDataSource

        public void clearDataSource()
        Clears all data sources.
      • setDataSource

        public void setDataSource(java.lang.String name, ICellsDataTable dataTable)
        Sets data source of a ICellsDataTable object.
        Parameters:
        name - The name of the table.
        dataTable - DataTable object
      • 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