ASP.NET Core MVC Controls | ComponentOne
Working with Controls / FlexSheet / Quick Start
In This Topic
    Quick Start
    In This Topic

    The FlexSheet control in your application can be unbound, bound to a data source, and can even display data loaded from an excel file. It offers you a flexible spreadsheet experience, allowing you to load existing excel file or workbook in FlexSheet, modify its data and even save it as an excel or a workbook file remotely or on the client side.

    The quick start guides you through the steps of using the FlexSheet control in your application, and load an excel file or workbook instance in it on the server side. This can be accomplished in the following steps:

    Note: The ComponentOne template for ASP.NET MVC Edition automatically registers the required resources, and adds the relevant references and packages to your application. Therefore, you need not follow the Steps 1 to 5 above if your application is created using ComponentOne template.

    The following image shows workbook data loaded from the server in the FlexSheet control.


    Create an MVC Application

    Create an ASP.NET Core MVC Application (.NET Framework) using Visual Studio templates. For more information, see Configuring MVC application using Visual Studio template.

    Back to Top

    Add the required references

    1. Add the ASP.NET MVC Edition references to the project. In the Solution Explorer, right click References and select Manage NuGet Packages. In NuGet Package Manager, select https://api.nuget.org/v3/index.json as the Package source. Search for C1.AspNetCore.Mvc package, and click Install.

      Note: "C1.AspNetCore.Mvc" gets added under the "dependencies" within project.json file of your project once you restore the packages.

    2. To work with FlexSheet control in your application, add C1.AspNetCore.Mvc.FlexSheet package. Once you restore the packages, "C1.AspNetCore.Mvc.FlexSheet" gets added under the "dependencies" in project.json file.

    Back to Top

    Configure the application to use FlexSheet control

    Complete the following steps to configure your application to use Financial Charts.

    1. From the Solution Explorer, expand the folder Views and double click the _ViewImports.cshtml file to open it.
    2. Add the following references to use FlexSheet controls in your ASP.NET Core application.
      _ViewImports
      Copy Code 
      @addTagHelper *, C1.AspNetCore.Mvc
@addTagHelper *, C1.AspNetCore.Mvc.FlexSheet

    Back to Top

    Register Resources

    Complete the following steps to register the required resources for using FlexSheet control.

    1. From the Solution Explorer, open the folders Views | Shared.
    2. Double click _Layout.cshtml to open it.
    3. Add the following code between the <head></head> tags.
      _Layout.cshtml
      Copy Code 
      <c1-styles />    
<c1-scripts>        
<c1-flex-sheet-scripts />
</c1-scripts>

    For more information on how to register resources, refer to Registering Resources.

    Back to Top

    Add jszip.js library to the application or use its CDN link

    Loading Excel files in FlexSheet and saving FlexSheet data to Excel files have dependency on jszip.min.js file. Therefore, you need to add it in your application, and provide reference to it in the respective view or in <head> section of _Layout.cshtml file. Complete the following steps to add the jszip.min.js file to your application.

    1. Download the jszip.min.js file from the CDN link: http://cdnjs.cloudflare.com/ajax/libs/jszip/2.2.1/jszip.min.js
    2. Place the jszip.min.js file in the Scripts folder of your application.
    3. Right-click the Scripts folder in Solution Explorer, and select Add | Existing Item... from the options.
    4. In the Add Existing Item dialog, browse to the location of jszip.min.js in your project.
    5. Select the jszip.min.js file and click Add to include it in your project.

    Back to Top

    Add an excel file or a workbook to server

    1. Make sure that the desired excel or workbook file to be loaded is placed on server. In this case, we have placed the file in the Content folder of our application.
      Note that, this example considers Visual Studio IIS (Internet Information Services) of your machine as the Server and browser as the client.
    2. Right-click your project name in the Solution Explorer, and select Add | Add Existing Files from the options, to add the excel file in your project.

    Back to Top

    Add a FlexSheet Control to your Application

    Complete the following steps to initialize a FlexSheet control.

    Add a new Controller

    1. In the Solution Explorer, right click the folder Controllers.
    2. From the context menu, select Add | Controller. The Add Scaffold dialog appears.
    3. Complete the following steps in the Add Scaffold dialog:
      1. Select Empty MVC Controller template.
      2. Set name of the controller (for example: Default1Controller).
      3. Click Add.
    4. Include the MVC references as shown below.
      C#
      Copy Code 
      using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;

    5. Replace the method Index() by the following code.

      ServerLoadController.cs
      C#
      Copy Code 
      // GET: ServerLoad
public ActionResult Index()
{
    return View();
}

    Add a View for the controller:

    1. Within the Controller, which was added in the above step, place the cursor inside the method Index().
    2. Right click and select Add View. The Add View dialog appears.
    3. In the Add View dialog, verify that the View name is Index and View engine is Razor (CSHTML).
    4. Click Add. A view has been added for the controller.
    5. In the Solution Explorer, double click Index.cshtml to open it.
    6. Replace the default code of the Views\Index.cshtml file with the one given below to initialize the FlexSheet control.
      HTML
      Copy Code 
      <script src=
"http://cdnjs.cloudflare.com/ajax/libs/jszip/2.5.0/jszip.min.js">
</script>

<div>
    <c1-flex-sheet class="flexSheet" file-path="~/FilestoLoad
/Workbook.xlsx" height="800px" width="1500px"></c1-flex-sheet>
</div>

    Back to Top

    Build and Run the Project

    1. Click Build | Build Solution to build the project.
    2. Press F5 to run the project.

    Back to Top