View source for Excel spreadsheets read and write

[[Category: Analytica User Guide]]
[[Category:Excel to Analytica mappings]]

<breadcrumbs> Analytica User Guide > Integration with data and applications > {{PAGENAME}}</breadcrumbs><br />

__TOC__

These functions let you open an Excel spreadsheet to read or write data to or from Analytica and from or to spreadsheet cells and named ranges. You can find them in the '''Application Integration''' submenu of the [[Definition menu|Definitions menu]].  You need to have Microsoft Excel installed on your computer to use these functions.

==SpreadsheetOpen(filename, ''showDialog'')==
Opens the indicated Excel workbook file. If the file isn't already open in Excel, it opens the file without Excel's user interface -- i.e. you won't see the spreadsheet in a Window. Set the optional «showDialog» parameter to <code>true</code>  to force the display of the file selector dialog, or or <code>false</code> to  suppress it. By default, it opens the file dialog only if it can't find  '''«filename» '''in the current directory. It returns a special '''«workbook»''' object which you can use as a parameter to the other Excel functions. For more, see [[SpreadsheetOpen]]().

==SpreadsheetSave(workbook, ''filename'')==
Saves an Excel workbook to a file. The «workbook» parameter must be a workbook object returned from a previous call to [[SpreadsheetOpen]](). The workbook is saved to the same file it was originally loaded from when the «filename» parameter is omitted. This function is used after changes have been made to the workbook using [[SpreadsheetSetCell]]() or [[SpreadsheetSetRange]](). For more, see [[SpreadsheetSave]]().

==SpreadsheetCell(workbook, sheet, column, row, ''what'')==
Reads the value of one cell in an Excel worksheet given its coordinates. The function fully array abstracts so that you can use it to read an range of cells by specifying the «column» or «row» parameters as arrays. «Workbook» is the result of a call to [[SpreadsheetOpen]]. The «sheet» and «column» parameters may be either the text names or an ordinal number that identifies the sheet in the workbook or column in the sheet. For more, see [[SpreadsheetCell]]().

The following demonstrates equivalent methods for obtaining the value from cell ''C7'' of the first worksheet, <code>Sheet1</code>:
:<code>SpreadsheetCell(workbook, 'Sheet1', 'C', 7)</code>
:<code>SpreadsheetCell(workbook, 1, 3, 7)</code>

The following reads the 2-D array of cells ''C3: J10'' in <code>Sheet1</code>:
:<code>Index Year := 2008 .. 2015;</code>
:<code>Index Asset := 1 .. 16;</code>
:<code>SpreadsheetCell(workbook, 'Sheet1', @Year + 2, @Asset + 3)</code>

You can obtain the contents of a particular cell coordinate from all sheets by specifying «sheet» at '*'. The result is indexed by a local index named .Sheet containing the sheet names. This is particularly useful for obtaining a list of worksheets.
:<code>Index Sheet := CopyIndex(SpreadsheetCell(workbook, '*', 1, 1).Sheet)</code>

When the optional «what» parameter is not specified, the value of the cell is retrieved. Use «what» to read other types of cell information: <ocde>'Value', 'Formula', 'RelativeFormula', 'NumberFormat', 'TextColor', 'BackColor', 'FontName', 'FontSize', 'FontStyle'</code>, or <code>'Border[Left|Right|Up|Down][Color|Style|Weight]'</code> (e.g., <code>'BorderRightColor'</code>).

==SpreadsheetSetCell(workbook, sheet, col, row, value)==
Writes «value» (either a number or text) to the cell identified by «sheet», «col», and «row». Can be used to write multiple values via array abstraction when «col», «row» and «value» are arrays that share one or more indexes. The first parameter, «workbook», must be an object obtained from a previous call to [[SpreadsheetOpen]](). See also [[SpreadsheetSetCell]]().

To write the value <code>3.5</code> to cell ''Sheet1!C5'':
:<code>SpreadsheetSetCell(workbook, 'Sheet1', 'C', 5, 3.5)</code>

==SpreadsheetRange(workbook, ''range, colIndex, rowIndex, howToIndex, sheet, what'')==
Reads a range of cells from an Excel workbook. The «range» can be the name of a named range in the Excel «workbook», range coordinates such as <code>'Sheet1!C7'</code> or <code>'Sheet3!C7:F12'</code>, or all populated cells in a sheet as <code>'Sheet1!'</code>. Alternatively, you can specify a «range» coordinate as <code>'C7: F12'</code> and specify the sheet either by name or number in the optional «sheet» parameter. If you omit «range» but specify «sheet», then the smallest rectangular range of cells containing all populated cells is returned. When specifying a named range, it is not necessary to specify the worksheet name, but when using range coordinates the sheet must be identified.

Depending on the dimensions of the cells requested, the result may be a scalar (single cell), a column vector, a row vector, or a 2-D array. When the range contains multiple cells, the result is an array. When the optional «colIndex» or «rowIndex» parameters are not provided, local indexes are created for those dimensions when the range for the result contains more than one column or more than one row. If you already have indexes for those dimensions, you should provide them explicitly in the «colIndex» and «rolIndex» parameters.

The optional «howToIndex» parameter provides additional control over how the result is indexed and the range interpreted. It can be any additive combination of the following values:
:<code>1</code> = Force column index when range has only one column.
:<code>2</code> = Force row index when range has only one row.
:<code>4</code> = First row of range contains column labels
:<code>8</code> = First column of range contains row labels
:<code>16</code> = Do not issue error if supplied «colIndex» or «rowIndex» is not the correct length.

Suppose the range of cells, ''C7: F12'' in sheet <code>'Projection'</code>, the third sheet in the Excel workbook, has been labelled in Excel with the name <code>Costs</code>. Then the following are each equivalent and return a 2-D array, indexed by local indexes <code>.Row = [7, 8, 9, 10, 11, 12]</code> and <code>.Column = ['C', 'D', 'E', 'F']</code>:
:<code>SpreadsheetRange(workbook, 'Costs')</code>
:<code>SpreadsheetRange(workbook, 'Projection!C7: F12')</code>
:<code>SpreadsheetRange(workbook, 'C7: F12', sheet: 'Projection')</code>
:<code>SpreadsheetRange(workbook, 'C7: F12', sheet: 3)</code>

When the optional «what» parameter is not specified, the value of the cell is retrieved. Use «what» to read other types of cell information: <code>'Value', 'Formula', 'RelativeFormula', 'Number-Format', 'TextColor', 'BackColor', 'FontName', 'FontSize', 'FontStyle', 'Border[
Left|Right|Up|Down][Color|Style|Weight]'</code> (e.g., <code>'BorderRightColor'</code>),  <code>'Sheet', 'Address', 'AddressR1C1'</code>, or <code>'RangeName'</code>. For more, see [[SpreadsheetRange]]().

==SpreadsheetSetRange(workbook, range, value, ''colIndex, rowIndex, sheet'')==
Writes «value» (often an array of text or numbers) to a cell range or named range. «Workbook» mustbe an object obtained from a previous call to [[SpreadsheetOpen]](). «Sheet» is the name or number of the worksheet containing the range. «Range may be a coordinate range (e.g., <code>'Sheet1!C7: F15'</code>, or when the optional «sheet» parameter is also specified «range» may be just <code>'C7: F15'</code>) or the name of a named range. «Value» is the value written, and «colIndex» and «rowIndex» are the indexes of «value» (when «value» is an array). See also [[SpreadsheetSetRange]]().

==SpreadsheetInfo(workbook, item)==
Reads a property of a workbook. «Workbook» must be an object obtained from [[SpreadsheetOpen]]. «Item» is one of the following
:<code>'AcceptLabelsInFormulas'</code>: Flag. <code>1</code> if cell formulas can use labels (named ranges) in their formulas. <code>0</code> if these are not allowed.
:<code>'ActiveSheet'</code>: Textual name of the active worksheet.
:<code>'Author'</code>: Author of «workbook».
:<code>'CalculationMode'</code>: This is either <code>'Automatic', 'Manual'</code> or <code>'Semiautomatic'</code>,indicating whether cells are automatically recomputed when something changes. <code>'Semiautomatic'</code> means that cells are calculated automatically except those that are part of a data table.
:<code>'CodeName'</code>: The textual code name field of the «workbook», if one has been specified.
:<code>'Date1904'</code>: Flag. <code>1</code> if the excel date origin is 1 Jan 1904. <code>0</code> if it is 1 Jan 1900.
:<code>'Filename'</code>: Full path and filename of the «workbook» file.
:<code>'Name'</code>: The filename part of the workbook.
:<code>'Names'</code>: A list of all the named ranges in the spreadsheet.
:<code>'ReadOnly'</code>: Flag. <code>1</code> if the workbook is read-only, <code>0</code> if it can be changed.
:<code>'Saved'</code>: Flag. <code>1</code> if there are no unsaved changes. <code>0</code> if it has been “dirtied”.
:<code>'SelectedRange'</code>: The range of cells that is currently selected. When you have the spreadsheet open interactively in Excel at the same time your model is using it, this can be used to detect which range of cells you have highlighted, and can be used as a way to make a selection. An example return value is <code>'Sheet1!B2: C4'</code>.
:<code>SelectedRangeR1C1'</code>: The range of cells currently selected in R1C1 notation, such as <code>'Sheet1!R[1]C[1]:R[3]C[2]'</code>.
:<code>'Sheets'</code>: A list of the worksheet names in the workbook.
:<code>'Title':</code>: Textual title (if it has been filled in) for the workbook.

For more, see[[SpreadsheetInfo]]().

==SpreadsheetSetInfo(workbook, item, value)==
Sets a property of a workbook. «Workbook» must be an object obtained from a previous call to [[SpreadsheetOpen]]. «Item» is one of the following
:<code>'ActiveSheet'</code>: specify the name of a worksheet for the «value» parameter. The worksheet with that name becomes selected.
:<code>'Author'</code>: sets the author property of the workbook to the indicated textual «value».
:<code>'CalculationMode'</code>: value should be one of <code>'Automatic', 'Manual'</code> or <code>'Semiautomatic'</code>. Sets the calculation mode.
:<code>'CodeName'</code>: Sets the textual code name property of the workbook.
:<code>'Date1904'</code>: Value should be <code>0</code> or <code>1</code>. When <code>1</code> sets the date origin used by Excel to 1-Jan-1904, the same used by default by Analytica. When <code>0</code>, uses 1-Jan-1900.
:<code>'SelectedRange'</code>: Selects an indicated range of cells. Can be used to indicate a range of cells to a user when Excel is open interactively. The value parameter should be something like <code>'Sheet1!B2: B4'</code>.
:<code>'Title'</code>: Sets the textual title of the workbook.

For more, see [[SpreadsheetSetInfo]]().

== See Also==
<div style="column-count:2;-moz-column-count:2;-webkit-column-count:2">
* [[Media:Functions for Reading Excel Worksheets.ana|Reading Excel Worksheets.ana]]
* [[SpreadsheetOpen]]()
* [[SpreadsheetSave]]()
* [[SpreadsheetCell]]()
* [[SpreadsheetSetCell]]()
* [[SpreadsheetRange]]()
* [[SpreadsheetSetRange]]()
* [[SpreadsheetInfo]]()
* [[SpreadsheetSetInfo]]()
* [[Functions To Read Excel Worksheets]]
* [[Functions to Write Data to Excel Worksheets]]
* [[Read and Write Spreadsheets]]
* [[Analytica User FAQs/Application Integration]]
* [[Excel Functions from ADE]]
* [[Excel to Analytica Translation]]
* [[Excel to Analytica Mappings]]
* [[Excel to Analytica Mappings/Lookup Functions]]
* [[Excel to Analytica Mappings/Statistical_Functions]]
* [[Working with Excel Worksheets using the Excel 2013 Object Model.]]
* [[Read and write text files]]
* [[Read data from URL on internet]]
* [[ReadBinaryFile]]
* [[COM Integration]]
* [[COM and Excel examples]]
</div>


<footer> Parsing and formatting data  / {{PAGENAME}} / Read data from URL on internet</footer>