Share via

Ewa.Workbook Methods

  • Article

Applies to: apps for SharePoint | SharePoint Server 2010

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

Methods

Table 1. Methods of the Ewa.Workbook class

Name

Description

Ewa.Workbook.getRangeA1Async(addressA1, callback, userContext)

Gets the specified 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 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.

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 sheet.

Ewa.Workbook.getSheets()

Gets the sheet collection.

Ewa.Workbook.getActiveNamedItem()

Gets the active named item object (only in named item view).

Ewa.Workbook.getNamedItems()

Gets the named item collection.

Ewa.Workbook.getIsNamedItemView()

Gets a value that specifies if the Excel Services Web Part is in named item view.

Ewa.Workbook.getActiveCell()

Gets the active cell as a 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.