Ewa.Workbook Methods

Applies to: apps for SharePoint | Excel Services | SharePoint Server 2013

Table 1 lists the methods of the Ewa.Workbook Object class.

Methods

Table 1. Methods of the Ewa.Workbook class

Name	Description
add_sheetDataEntered(function)	Subscribes an event handler to the sheetDataEntered event.
remove_sheetDataEntered(function)	Unsubscribes the specified event handler from the sheetDataEntered event.
Ewa.Workbook.getRangeA1Async(addressA1, callback, userContext)	Gets the specified Ewa.Range in the open workbook asynchronously using the Excel "A1" range notation as an input parameter.
Ewa.Workbook.getRange(parentName, firstRow, firstColumn, rowCount, columnCount)	Gets the specified Ewa.Range using a sheet name and the numeric range coordinates using R1C1 notation.
Ewa.Workbook.recalcAsync(callback, userContext)	Calculates the entire workbook.
Ewa.Workbook.refreshAllAsync(callback, userContext)	Refreshes all data connections in the workbook.
reloadWorkbookAsync(callback, userContext)	Reloads the workbook.
Ewa.Workbook.setParametersAsync(parameters, callback, userContext)	Sets parameters in the workbook asynchronously, including PivotTable filters.
Ewa.Workbook.getMode()	Gets the session mode, that is, whether the session is in view mode or edit mode.
Ewa.Workbook.getSessionId()	Gets the session identifier.
Ewa.Workbook.getDataCultureName()	Gets the actual name of the data culture for that particular session.
Ewa.Workbook.getUiCultureName()	Gets the actual name of the user interface culture for that particular session.
Ewa.Workbook.getActiveSheet()	Gets the active Ewa.Sheet.
Ewa.Workbook.getSheets()	Gets the Ewa.SheetCollection.
Ewa.Workbook.getActiveNamedItem()	Gets the active NamedItem object (only in named item view).
Ewa.Workbook.getNamedItems()	Gets the NamedItemCollection.
Ewa.Workbook.getIsNamedItemView()	Gets a value that specifies if the Ewa.EwaControl is displayed in named item view.
Ewa.Workbook.getActiveCell()	Gets the active cell as an Ewa.Range object.
Ewa.Workbook.getActiveSelection()	Gets the current selection as a range object.
Ewa.Workbook.getWorkbookPath()	Gets the location of the workbook file to open.