addSpreadsheet method

This method creates a new spreadsheet. The values of Name, FullName, Path property of a new spreadsheet are empty string.

Defined in

Spreadsheets

Syntax

public Spreadsheet addSpreadsheet(String template, boolean newTemplate, boolean visible) throws SymphonyException

Parameters

String template

Specifies the name of template for the new spreadsheet. For example, on Microsoft® Windows®, the format is D:\\template.ots . On Linux®, the format is /home/me/template.ots. If the template file does not exists, this method throws an exception. If no template is used, the value of this property is empty string, for example, spreadsheets.addSpreadsheet("",false,true).

boolean newTemplate

If a template is used, specifies true to creates a new untitled spreadsheet based on the template, false to load the template for editing. If no template is used, both true and false create a new untitled spreadsheet.

boolean visible

Specifies true to open the new spreadsheet in a visible window or tab, or false to open the new spreadsheet in invisible mode.

Return Value

spreadsheet

A Spreadsheet object that represents a spreadsheet.

See examples

Example: addSpreadsheet method