Syncfusion Blazor Scaffolding

18 Jun 202110 minutes to read

Syncfusion provides Visual Studio Scaffolding for Syncfusion Blazor platform to quickly add code that interacts with data models and reduce the amount of time to develop with data operation in your project. Scaffolding provides an easier way to create Razor and Controller action methods for Syncfusion Blazor DataGrid, Charts, Scheduler, Diagram, Tree Grid, Rich Text Editor, Document Editor, and PDF Viewer controls.

NOTE

Check that at least one Entity Framework model exists, and the application has been compiled once. If no Entity Framework model exist in your application, refer to this documentation to generate the Entity Framework model. After the model file has been added, check that the required DBContext and properties are added. Now, build the application, and try scaffolding. If any changes made in the model properties, rebuild the application once before perform scaffolding.

IMPORTANT

The Syncfusion Blazor Scaffolder is available from v17.4.0.39 for Blazor server-side application and provided the Scaffolding support to Blazor client-side application from v18.4.0.39.

Add a scaffolded item

The following steps explains how to add a scaffolded item to your Blazor application.

Before use the Syncfusion Blazor Scaffolding, check whether the Syncfusion Blazor Template Studio Extension installed or not in Visual Studio Extension Manager by clicking on the Extensions -> Manage Extensions -> Installed.

  1. If the project type is Blazor ServerSide, right-click the Pages folder in the Solution Explorer, click Add, and then select New Scaffolded Item..

    Scaffolded add-in from server project

    If the project type is Blazor Hosted, right-click the Controllers folder from {Project Name}.Server project in the Solution Explorer, click Add, and then select New Scaffolded Item.

    Scaffolded add-in from hosted project

  2. In the Add Scaffold dialog, select Syncfusion Blazor Scaffolder and then click ‘Add’.

    Choose Syncfusion Scaffolding from Visual Studio Add scaffold dialog

  3. In the Syncfusion UI Scaffolder dialog, select the desired control to perform scaffolding, and then click Next.

    Choose required control

NOTE

Scheduler control is not applicable for Blazor Hosted application.

  1. Syncfusion UI Scaffolder dialog will be opened for the selected control. Enter the Controller/Service Name and Razor Name as application requirements, and then select the required Model Class of the active project and its relevant Data Context Class, and then click Next.

    Choose required Model

  2. Syncfusion UI Scaffolder for the selected control feature dialog will open. Select the required features, update the required data field, and then click Add.

    For ServerSide Application, both Local data and Remote data types will be available.

    Choose required selected control features for serverside project

    For Hosted Application, Remote data type only available.

    Choose required selected control features for hosted project

  3. The Controller/Service file and the corresponding Razor files are generated with the selected features of Syncfusion control code snippet.

    If you select Local Data, service file and razor file will be added to the project.

    Required Controller and Razor files added in the project for the selected control

    If you select Remote Data, controller file and razor file will be added to the project.
    Required Controller and Razor files added in the project for the selected control

  4. Then, add navigation to the created razor file based on your requirement to open in the webpage.

  5. If you installed the trial setup or NuGet packages from nuget.org you have to register the Syncfusion license key to your project since Syncfusion introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio release. Navigate to the help topic to generate and register the Syncfusion license key to your project. Refer to this blog post for understanding the licensing changes introduced in Essential Studio.

Syncfusion Blazor Command-line Scaffolding

Syncfusion provides Scaffolding command-line for Syncfusion ASP.NET Core to quickly add code that interacts with data models and reduce the amount of time to develop with data operation in your project. Scaffolding provides an easier way to create view file and Controller action methods for Syncfusion Blazor DataGrid, Charts, Scheduler, Diagram, Tree Grid, Rich Text Editor, Document Editor, and PDF Viewer controls.

NOTE

Check that at least one Entity Framework model exists. If no Entity Framework model exist in your application, refer to this documentation to generate the Entity Framework model. After the model file has been added, check that the required DBContext and properties are added. Now, build the application, and try scaffolding. If any changes made in the model properties, rebuild the application once before perform scaffolding.

Install Command-line Scaffolding

Install syncfusion.scaffolding tool globally by using below command.

dotnet tool install -g syncfusion.scaffolding

Update Command-line scaffolding

Update syncfusion.scaffolding tool globally by using below command.

dotnet tool update -g syncfusion.scaffolding

Add a scaffolded item from command-line

The following steps explains how to add a scaffolded item from command-line to your Blazor application.

Before adding the scaffolded item from command-line, check whether the dotnet-aspnet-codegenerator tool is installed or not by dotnet tool list -g command in command prompt. if it is not installed, then install dotnet-aspnet-codegenerator tool globally by using this command dotnet tool install -g dotnet-aspnet-codegenerator.

  1. After installed syncfusion.scaffolding tool, we can invoke syncfusion_scaffold command it shows the available controls

    syncfusion_scaffold

    CommandLine Scaffold Available Controls

  2. To add a scaffolded item from command-line you have to invoke syncfusion_scaffold application like below syntax

    syncfusion_scaffold [control][arguments]

    Parameter Description Control
    -p|–project Path to .csproj file in the project. All Controls
    -cname|–controller-filename Name of controller file to be added in project. All controls
    -vname|–view-filename Name of view file to be added in project. All Controls
    -m|–model Database model name with namespace (example: WebApplication1.Models.Tasks). All Controls
    -dc|–db-context DbContext name with namespace (example: WebApplication1.Models.TasksContext). All Controls
    -pkey|–primary-key Set Feature name/column name as primarykey. DataGrid/TreeGrid
    -tid|–treegrid-id Id of Tasks. TreeGrid
    -pid|–parent-id ParentId value TreeGrid/Diagram
    -x|–x-axis Xaxis of Chart Charts
    -Y|–Y-axis Y-axis of Chart Charts
    -sid|–scheduler-id Id of Scheduler Event. Scheduler
    -stime|–start-time StartTime of Scheduler Event. Scheduler
    -etime|–end-time EndTime of Scheduler Event. Scheduler
    –is-all-day Set IsALLDay for Scheduler Event. Scheduler
    -did|–diagram-id Id of Diagram layout. Diagram
  3. If you run the syncfusion_scaffold [control] command, the parameters of control shown like below image.

    control parameter details

  4. Run the following command to generate controller and view files through command-line by passing required arguments of the given control.

    syncfusion_scaffold {controlName} –project “{projectFileNamewithPath}” –model {model} -dc {dbContext} -cname {controllerName} -vname {viewName} [controlMantoryParameter] [controlMantatoryParameterValue]

    CommandLine Scaffold

  5. As we can see controller and view files generated successfully and also added the Syncfusion NuGet packages and styles which is required to render Syncfusion control.

    Blazor added Files
    Blazor Service Changes

How to render Syncfusion control?

Refer to the following UG links to render Syncfusion control after performing scaffolding:

WebAssembly App: Configure Blazor controls using Syncfusion.EJ2.Blazor NuGet Package

Blazor Server App: Configure Blazor controls using Syncfusion.EJ2.Blazor NuGet Package