SpreadsheetExtension Class

Represents an extension object implementing the Spreadsheet functionality.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc.v18.1.dll

Declaration

C#

public class SpreadsheetExtension :
    ExtensionBase

VB.NET

Public Class SpreadsheetExtension
    Inherits ExtensionBase

Related API Members

The following members accept/return SpreadsheetExtension objects:

Show 16 links

• ExtensionsFactory.Spreadsheet(Action<SpreadsheetSettings>)
• ExtensionsFactory.Spreadsheet(SpreadsheetSettings)
• SpreadsheetExtension.Open(SpreadsheetDocumentInfo)
• SpreadsheetExtension.Open(String)
• SpreadsheetExtension.Open(String, DocumentFormat)
• SpreadsheetExtension.Open(String, DocumentFormat, Func<Byte[]>)
• SpreadsheetExtension.Open(String, DocumentFormat, Func<Stream>)
• SpreadsheetExtension.Open(String, Func<Byte[]>)
• SpreadsheetExtension.Open(String, Func<Stream>)
• SpreadsheetExtension.PerformMailMerge(Func<Byte[]>, DocumentFormat, Object)
• SpreadsheetExtension.PerformMailMerge(Func<Byte[]>, DocumentFormat, Object, String)
• SpreadsheetExtension.PerformMailMerge(Func<Stream>, DocumentFormat, Object)
• SpreadsheetExtension.PerformMailMerge(Func<Stream>, DocumentFormat, Object, String)
• SpreadsheetExtension.PerformMailMerge(String, Object)
• SpreadsheetExtension.PerformMailMerge(String, Object, String)
• SpreadsheetExtension.PerformMailMerge(String, Object, String, Int32, DocumentFormat)

Remarks

To declare the Spreadsheet in a View, invoke the ExtensionsFactory.Spreadsheet helper method. This method returns the Spreadsheet extension that is implemented by the SpreadsheetExtension class.

To configure the Spreadsheet extension, pass the SpreadsheetSettings object to the ExtensionsFactory.Spreadsheet helper method as a parameter. The SpreadsheetSettings object contains all the Spreadsheet extension settings.

Refer to the Spreadsheet Overview topic to learn how to add the Spreadsheet extension to your project.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SpreadsheetExtension class.

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#

spreadsheet-how-to-re-open-a-document-without-unsaved-changes-t449201/CS/T449201/Controllers/HomeController.cs#L20

public ActionResult SpreadsheetCustomPartial() {
    string documentID = SpreadsheetExtension.GetDocumentId("Spreadsheet");
    SpreadsheetExtension.CloseDocument("Spreadsheet");

how-to-export-mvc-spreadsheet-extension-to-pdf-using-workbook-component-t157548/CS/DXWebApplication24/Controllers/HomeController.cs#L20

public FileStreamResult SpreadsheetPartialDownload() {
    return SpreadsheetExtension.DownloadFile("Spreadsheet");
}

spreadsheet-how-to-save-and-load-documents-from-a-database-t190813/CS/DXWebApplication23/Controllers/HomeController.cs#L20

public ActionResult SpreadsheetPartial() {
    return SpreadsheetExtension.GetCallbackResult("SpreadsheetName", p => {
        p.Saving(e => {

spreadsheet-how-to-perform-a-request-to-the-server-using-jqueryajax-to-get-cell-values-t318446/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);

spreadsheet-how-to-add-a-chart-to-a-document-t467065/CS/T449201/Controllers/HomeController.cs#L21

public ActionResult SpreadsheetCustomPartial(string diagramName) {
    IWorkbook wbook =  SpreadsheetExtension.GetCurrentDocument("Spreadsheet");

VB.NET

spreadsheet-how-to-re-open-a-document-without-unsaved-changes-t449201/VB/T449201/Controllers/HomeController.vb#L22

Public Function SpreadsheetCustomPartial() As ActionResult
    Dim documentID As String = SpreadsheetExtension.GetDocumentId("Spreadsheet")
    SpreadsheetExtension.CloseDocument("Spreadsheet")

how-to-export-mvc-spreadsheet-extension-to-pdf-using-workbook-component-t157548/VB/DXWebApplication24/Controllers/HomeController.vb#L22

Public Function SpreadsheetPartialDownload() As FileStreamResult
    Return SpreadsheetExtension.DownloadFile("Spreadsheet")
End Function

spreadsheet-how-to-save-and-load-documents-from-a-database-t190813/VB/DXWebApplication23/Controllers/HomeController.vb#L18

Public Function SpreadsheetPartial() As ActionResult
    Return SpreadsheetExtension.GetCallbackResult("SpreadsheetName", _
                                                  Sub(p)

spreadsheet-how-to-perform-a-request-to-the-server-using-jqueryajax-to-get-cell-values-t318446/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)

spreadsheet-how-to-add-a-chart-to-a-document-t467065/VB/T449201/Controllers/HomeController.vb#L23

Public Function SpreadsheetCustomPartial(ByVal diagramName As String) As ActionResult
    Dim wbook As IWorkbook = SpreadsheetExtension.GetCurrentDocument("Spreadsheet")

Inheritance

Object

ExtensionBase

SpreadsheetExtension