Object
   |
   +--Klip
         |
         +--Engines
               |
               +--Engines.Excel

This object is an advanced feature that is only available in the licensed, commercial version of Klipfolio Dashboard. Contact Klipfolio for further details.

The Engines.Excel object provides support for parsing a Microsoft Excel spreadsheet.

An Excel spreadsheet can be opened by specifying its file name, as well as the optional worksheet name and range values, using this API or by setting these values in the Klip's top XML section.

As with Klips using other types of data sources, an Excel Klip's <style> section must match the returned XML data.

Important Notes:

• From Klipfolio Dashboard version 5.3, Excel 2007 workbooks with the XLSX extension are supported in addition to the XLS extension of the earlier versions of Excel. To upgrade to version 5.3, contact Klipfolio.
• Klipfolio Dashboard version 5.2 supports Excel workbooks with the XLS file extension only. When using Excel 2007, be sure to save your file in Excel 97-2003 format by clicking the Office button > Save As > Excel 97-2003 Workbook. See the Microsoft Support page for details.
• Klipfolio Dashboard gets the displayed values from the worksheet, whether they were directly input or are results of formulas.
• An Excel workbook file is locked when it is opened in Excel, which prevents others from accessing it fully.
  In order to allow access to it by multiple Excel Klips,
  a. make sure no one has it opened;
  OR
  b. share your workbook. For details on how and its implications, refer to Microsoft's documentation: Excel 2007; Excel 2003
• The workbook file must be located on a local or network drive, not on a web server.
• Empty rows and columns are ignored and are not displayed in the Klip.
• In a given column, the majority data type of the first 8 rows is used as the default type, so any cell in the column that is not of the the majority data type is ignored.
  For example, if the majority data type of the first 8 rows of column heading A was Number, any cell under column A that is not a Number is ignored. Refer to the Microsoft Support page for a workaround.
• Embedded objects in the worksheet, such as charts, images, and diagrams, are ignored.
• Klipfolio Dashboard treats links in the worksheet as string data.

Since:
5.2

See also:
The How-to article on developing an Excel Klip.

---

Properties Summary
String	lasterror            Information about the most recent error.
String	xml            Returns the XML version of the returned Excel data to be parsed by Klipfolio Dashboard using the Klip's <style> settings.

   

Function Summary
function	open( <String> file[, <String> sheet[, <String> range]] )            Opens the specified Excel file.

Properties Detail

lasterror

String lasterror

Information about the most recent error.

---

xml

String xml

Returns the XML version of the returned Excel data to be parsed by Klipfolio Dashboard using the Klip's <style> settings.

---

Function Detail

open

function open( <String> file[, <String> sheet[, <String> range]] )

Opens the specified Excel file.

The name of the worksheet and its range to be accessed may be specified.

Note:
When specifying range, sheet must also be specified as the second parameter.

Parameters:
file - the name of the Excel file (e.g. "\\\\NetworkPlace\\accounting\\budget09.xls")
sheet - the name of the spreadsheet. Default is "Sheet1". [optional]
range - the range (e.g. "A1:E12") in the specified spreadsheet. Default is the smallest range that includes all the available headers and values. [optional]

Returns:
true on success; otherwise false

---

Overview   Object  Tree  Index  Help			Klipfolio Dashboard 5 API
PREV OBJECT  NEXT OBJECT	FRAMES    NO FRAMES
SUMMARY: PROPERTY | FUNCTION	DETAIL: PROPERTY | FUNCTION

---

© 2010 Klipfolio Inc. All Rights Reserved.