SpreadsheetExtension.GetCurrentDocument(String) Method

Gets access to a workbook loaded into the specified Spreadsheet.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v24.1.dll

NuGet Package: DevExpress.Web.Mvc5

Declaration

C#

public static IWorkbook GetCurrentDocument(
    string extensionName
)

VB.NET

Public Shared Function GetCurrentDocument(
    extensionName As String
) As IWorkbook

Parameters

Name	Type	Description
extensionName	String	A string value specifying the Spreadsheet name.

Returns

Type	Description
IWorkbook	A IWorkbook interface specifying a document loaded in the Spreadsheet.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetCurrentDocument(String) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

asp-net-mvc-spreadsheet-send-ajax-requests-to-server-to-get-cell-values/CS/T318446/Controllers/HomeController.cs#L19

public ActionResult ValidateSpreadsheet(object Spreadsheet) {
    IWorkbook myWorkBook = SpreadsheetExtension.GetCurrentDocument("Spreadsheet");
    int test = Convert.ToInt32(myWorkBook.Worksheets[0].Cells["B3"].Value.NumericValue);

asp-net-mvc-spreadsheet-modify-document/CS/DXWebApplication1/Controllers/HomeController.cs#L24

public ActionResult CustomAction(string customCommand) {
    IWorkbook workbook = SpreadsheetExtension.GetCurrentDocument("Spreadsheet");
    Worksheet worksheet = workbook.Worksheets[0];

VB.NET

asp-net-mvc-spreadsheet-send-ajax-requests-to-server-to-get-cell-values/VB/T318446/Controllers/HomeController.vb#L19

Public Function ValidateSpreadsheet(ByVal Spreadsheet As Object) As ActionResult
    Dim myWorkBook As IWorkbook = SpreadsheetExtension.GetCurrentDocument("Spreadsheet")
    Dim test As Integer = Convert.ToInt32(myWorkBook.Worksheets(0).Cells("B3").Value.NumericValue)

asp-net-mvc-spreadsheet-modify-document/VB/DXWebApplication1/Controllers/HomeController.vb#L17

Public Function CustomAction(ByVal customCommand As String) As ActionResult
    Dim workbook As IWorkbook = SpreadsheetExtension.GetCurrentDocument("Spreadsheet")
    Dim worksheet As Worksheet = workbook.Worksheets(0)