QScript ExcelWorkbook
Jump to navigation
Jump to search
ExcelWorkbook
Represents an Excel workbook imported into the document as a summary table data source. Contains one or more worksheets, each of which contains one or more tables.
equals(obj)
Whether two objects are the same.
| obj | The object to compare against. |
| Returns: | true or false |
| Example: | data_file.getQuestionByName('Q2').equals(data_file.questions()[0])
|
error
Errors associated with this item as a string. Returns null if there are no errors. Warnings are excluded. Errors only surface on individual tables (Excel tables, SQL tables, summary tables); workbooks, worksheets, queries and SQL connections return null.
getWorksheetByName(name)
Finds a worksheet by name.
| name | The name of the worksheet. |
| Returns: | An ExcelWorksheet object, or null if no matching worksheet exists. |
guid
Get the internal identifier for this workbook, which is unique for all items in the document.
name
Get/set the name of this item. Setting is silently ignored for items that do not support a name change.
referenceName
Get/set the reference name for this item, used to refer to it in the source code of other items. Setting is only supported on individual tables (Excel tables, SQL tables, summary tables); on workbooks, worksheets, SQL queries and SQL connections the setter is a silent no-op.
subItems
Returns an array containing all worksheets in this workbook.
type
Returns ExcelWorkbook.
worksheets
Gets an array containing all worksheets in this workbook. The first worksheet is [0].