Share via

ExcelService.OpenWorkbookForEditing Method

  • Article

Opens a workbook for editing.

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

Syntax

'Declaration
<WebMethodAttribute> _
Public Function OpenWorkbookForEditing ( _
    workbookPath As String, _
    uiCultureName As String, _
    dataCultureName As String, _
    <OutAttribute> ByRef status As Status() _
) As String
'Usage
Dim instance As ExcelService
Dim workbookPath As String
Dim uiCultureName As String
Dim dataCultureName As String
Dim status As Status()
Dim returnValue As String

returnValue = instance.OpenWorkbookForEditing(workbookPath, _
    uiCultureName, dataCultureName, _
    status)

[WebMethodAttribute]
public string OpenWorkbookForEditing(
    string workbookPath,
    string uiCultureName,
    string dataCultureName,
    out Status[] status
)

Parameters

  • workbookPath
    Type: System.String

    The location of the workbook file to open. Must be an absolute path. Maximum size is 4096 characters.

  • uiCultureName
    Type: System.String

    Follows the Microsoft .NET Framework standard of naming cultures as expressed in the System.Globalization.CultureInfo namespace. Examples of UI culture names: en-US, en-GB, fr-FR, de-DE, ka, ko-KR, ja-JP, hi, , zh-CHS. Use Empty string or Null when not applicable.

  • dataCultureName
    Type: System.String

    Follows the Microsoft .NET Framework standard of naming cultures as expressed in the System.Globalization.CultureInfo namespace. Examples of UI culture names: en-US, en-GB, fr-FR, de-DE, ka, ko-KR, ja-JP, hi, , zh-CHS. Use Empty string or Null when not applicable.

  • status
    Type: []

    Alert information.

Return Value

Type: System.String
The sessionId String value.

Remarks

This method opens a workbook in edit mode.

See Also

Reference

ExcelService Class

ExcelService Members

Microsoft.Office.Excel.Server.WebServices Namespace