asposecells.api

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.

• getRepeatFormulasWithSubtotal/setRepeatFormulasWithSubtotal : boolean 

  boolean getRepeatFormulasWithSubtotal() / setRepeatFormulasWithSubtotal(value)
  

  Indicates whether repeating formulas with subtotal row.

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

• getLineByLine/setLineByLine : boolean 

  boolean getLineByLine() / setLineByLine(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".

Method Detail

• clearDataSource

   clearDataSource()

  Clears all data sources.

• setJsonDataSource

   setJsonDataSource(variable, data)

  Parameters:

  variable: String -

  data: String -

• setDataSource

   setDataSource(variable, data)

  Sets data binding to a variable.

  Parameters:

  variable: String - Variable name created using smart marker.

  data: Object - Source data.

• 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