Share via


ExcelService.GetCellA1 Method

Gets a calculated value from a cell in the open workbook, using the Excel "A1" range specification.

Namespace:  Microsoft.Office.Excel.Server.WebServices
Assembly:  Microsoft.Office.Excel.Server.WebServices (in Microsoft.Office.Excel.Server.WebServices.dll)

Syntax

'Declaration
<WebMethodAttribute> _
Public Function GetCellA1 ( _
    sessionId As String, _
    sheetName As String, _
    rangeName As String, _
    formatted As Boolean, _
    <OutAttribute> ByRef status As Status() _
) As Object
'Usage
Dim instance As ExcelService
Dim sessionId As String
Dim sheetName As String
Dim rangeName As String
Dim formatted As Boolean
Dim status As Status()
Dim returnValue As Object

returnValue = instance.GetCellA1(sessionId, _
    sheetName, rangeName, formatted, _
    status)
[WebMethodAttribute]
public Object GetCellA1(
    string sessionId,
    string sheetName,
    string rangeName,
    bool formatted,
    out Status[] status
)

Parameters

  • sessionId
    Type: System.String
    The Excel Web Services session ID.
  • sheetName
    Type: System.String
    The name of the sheet you want to reference. Sheet name length is limited to 31 characters.
  • rangeName
    Type: System.String
    A range name can be a range reference, a named range, or a named data object. A rangeName string can contain a sheet name; for example, "Sheet1!A1:G17".
  • formatted
    Type: System.Boolean
    true returns formatted strings.
    false returns raw values.
  • status
    Type: []
    Alert information.

Return Value

Type: System.Object
The value from a single cell, using a range name string to select the cell.

Remarks

A cell can be a range reference, a named range, or a named data object.

The API checks only the result dimensions, not the dimensions of the requested range. For example, the caller might ask for a 2x3 range, and Excel Calculation Services might return a 1x1 range (for example, because of hidden cells).

See Also

Reference

ExcelService Class

ExcelService Members

Microsoft.Office.Excel.Server.WebServices Namespace