Tuesday, October 11, 2011

Creating Entity Framework Driven ASP.NET Application

Introduction

I have already written several posts on the Entity Framework where I described the power of this particular ORM tool. I also mentioned the book on the Entity Framework written by a Microsoft MVP - Joydip Kanjila. This time I will publish an extract from the book that shows how you can build ASP.NET application by using the Entity Framework and the EntityDataSource control. It can also give a glimpse of the Entity Framework is, if you have no experience in it.
The tutorial covers the following topics:
  • Creating the Entity Data Model by using a graphical utility built-in Visual Studio 2008 SP1
  • Creating the Entity Data Model by using a command line utility
  • Using the EntityDataSource ASP.NET control
  • Displaying the data in a GridView
This tutorial uses a particular database, but in fact you can use any database you already have.

Creating an Entity Data Model.

You can create the ADO.NET Entity Data Model in one of the two ways:
  • Use the ADO.NET Entity Data Model Designer
  • Use the command line Entity Data Model Designer called EdmGen.exe
We will first take a look at how we can design an Entity Data Model using the ADO.NET Entity Data Model Designer which is a Visual Studio wizard that is enabled after you install ADO.NET Entity Framework and its tools. It provides a graphical interface that you can use to generate an Entity Data Model.

Creating the Payroll Entity Data Model using the ADO.NET Entity Data Model Designer

Here are the tables of the 'Payroll' database that we will use to generate the data model:
  • Employee
  • Designation
  • Department
  • Salary
  • ProvidentFund
To create an entity data model using the ADO.NET Entity Data Model Designer, follow these simple steps:
l>

  • Open Visual Studio.NET and create a solution for a new web application project as seen below and save with a name.

  • Switch to the Solution Explorer, right click and click on Add New Item as seen in the following screenshot:

  • Next, select ADO.NET Entity Data Model from the list of the templates displayed as shown in the following screenshot:
            

  • Name the Entity Data Model PayrollModel and click on Add.

  • Select Generate from database from the Entity Data Model Wizard as shown in the following screenshot:
    Note that you can also use the Empty model template to create the Entity Data Model yourself.
    If you select the Empty Data Model template and click on next, the following screen appears:
    As you can see from the above figure, you can use this template to create the Entity Data Model yourself. You can create the Entity Types and their relationships manually by dragging items from the toolbox. We will not use this template in our discussion here. So, let's get to the next step.

  • Click on Next in the Entity Data Model Wizard window shown earlier.

  • The modal dialog box will now appear and prompts you to choose your connection as shown in the following figure:

  • Click on New Connection Now you will need to specify the connection properties and parameters as shown in the following figure:
    We will use a dot to specify the database server name. This implies that we will be using the database server of the localhost, which is the current system in use.

  • After you specify the necessary user name, password, and the server name, you can test your connection using the Test Connection button. When you do so, the message Test connection succeeded gets displayed in the message box as shown in the previous figure.

  • When you click on OK on the Test connection dialog box, the following screen appears:
    Note the Entity Connection String generated automatically. This connection string will be saved in the ConnectionStrings section of your application's web.config file. This is how it will look like:
      <connectionStrings> 
      <add name="PayrollEntities" connectionString="metadata=res:// *;
      provider=System.Data.SqlClient;provider connection string=&quot;
      Data Source=.;Initial Catalog=Payroll;User ID=sa;Password=joydip1@3;
      MultipleActiveResultSets=True&quot;" providerName="System.Data.EntityClient" /> 
      </connectionStrings>

  • When you click on Next in the previous figure, the following screen appears:

  • Expand the Tables node and specify the database objects that you require in the Entity Data Model to be generated as shown in the following figure:

  • Click on Finish to generate the Entity Data Model.

    • Here is the output displayed in the Output Window while the Entity Data Model is being generated:
    Your Entity Data Model has been generated and saved in a file named PayrollModel.edmx. We are done creating our first Entity Data Model using the ADO.NET Entity Data Model Designer tool.
    When you open the Payroll Entity Data Model that we just created in the designer view, it will appear as shown in the following figure:
    Note how the Entity Types in the above model are related to one another. These relationships have been generated automatically by the Entity Data Model Designer based on the relationships between the tables of the Payroll database.
    In the next section, we will learn how we can create an Entity Data Model using the EdmGen.exe command line tool.

    Creating the Payroll Data Model Using the EdmGen Tool

    We will now take a look at how to create a data model using the Entity Data Model generation tool called EdmGen.
    The EdmGen.exe command line tool can be used to do one or more of the following:
    • Generate the .cdsl, .msl, and .ssdl files as part of the Entity Data Model
    • Generate object classes from a .csdl file
    • Validate an Entity Data Model
    The EdmGen.exe command line tool generates the Entity Data Model as a set of three files: .csdl, .msl, and .ssdl. If you have used the ADO.NET Entity Data Model Designer to generate your Entity Data Model, the .edmx file generated will contain the CSDL, MSL, and the SSDL sections. You will have a single .edmx file that bundles all of these sections into it. On the other hand, if you use the EdmGen.exe tool to generate the Entity Data Model, you would find three distinctly separate files with .csdl, .msl or .ssdl extensions.
    Here is a list of the major options of the EdmGen.exe command line tool:

    ttom: medium none; border-left: medium none; border-collapse: collapse; border-top: medium none; border-right: medium none" class="MsoNormalTable" border="1" cellspacing="0" cellpadding="0">
    Option
    Description
    /help
    Use this option to display help on all the possible options of this tool. The short form is /?
    /language:CSharp
    Use this option to generate code using C# language
    /language:VB
    Use this option to generate code using VB language
    /provider:<string>
    Use this option to specify the name of the ADO.NET data provider that you would like to use.
    /connectionstring:
    <connection string>
    Use this option to specify the connection string to be used to connect to the database
    /namespace:<string>
    Use this option to specify the name of the namespace
    /mode:FullGeneration
    Use this option to generate your CSDL, MSL, and SSDL objects from the database schema
    /mode:EntityClassGeneration
    Use this option to generate your entity classes from a given CSDL file
    /mode:FromSsdlGeneration
    Use this option to generate MSL, CSDL, and Entity Classes from a given SSDL file
    /mode:ValidateArtifacts
    Use this option to validate the CSDL, SSDL, and MSL files
    /mode:ViewGeneration
    Use this option to generate mapping views from the CSDL, SSDL, and MSL files 
    Note that you basically need to pass the connection string, specify the mode, and also the project name of the artifact files (.csdl, .msl, and the .ssdl files) to be created. To create the Entity Data Model for our database, open a command window and type in the following:
    edmgen /mode:fullgeneration /c:"Data Source=.;Initial Catalog=Payroll;User ID=sa;
    Password=joydip1@3;" /p:Payroll
    This will create a full ADO.NET Entity Data Model for our database. The output is shown in the following figure:
    You can now see the list of the files that have been generated:
    You can validate the Payroll Entity Data Model that was just created, using the ValidateArtifacts option of the EdmGen command line tool as shown below:
    EdmGen /mode:ValidateArtifacts /inssdl:Payroll.ssdl /inmsl:Payroll.msl /incsdl:Payroll.csdl
    When you execute the above command, the output will be similar to what is shown in the following figure:
    As you can see in the previous figure, there are no warnings or errors displayed. So, our Entity Data Model is perfect.
    The section that follows discusses the new Entity Data Source control which was introduced as part of the Visual Studio.NET 2008 SP1 release.

    The ADO.NET Entity Data Source Control

    Data controls are those that can be bound to data from external data sources. These data sources may include databases, XML files, or even flat files. ASP.NET 2.0 introduced some data source controls with a powerful data binding technique so the need for writing lengthy code for binding data to data controls has been eliminated.
    In ASP.NET, the term Data Binding implies binding the controls to data retrieved from a data source and providing a read or write connectivity between these controls and the data that they are bound to.
    The Entity Data Source control is an example of a data control that is included as part of the Visual Studio 2008 SP1 release and can be used to bind data retrieved from an Entity Data Model to the data bound controls of ASP.NET. If you have installed Visual Studio 2008 SP1, you can see the EntityDataSource control listed in the Data section of your toolbox.
    If you cannot locate the EntityDataSource control in the toolbox, follow these steps:
    1. Right-click on the Toolbox and select the Choose Items option as shown in the following figure:
              
    2. From the list of the components displayed, scroll down to locate the EntityDataSource in the .NET Framework Components tab. Refer to the following figure:
    3. Now, check the checkbox next to the EntityDataSource component and click on OK.
    The ADO.NET Entity Data Source control is now added to your toolbox as shown in the following figure:
    If the EntityDataSource component is not listed in the list of the componentsdisplayed in the Choose Toolbox Items window, you will have to add it manually. To do this, click on the Browse button in the Choose Toolbox Items window, locate theSystem.Web.Entity.dll in the folder in your system where Microsoft .NET Framework 3.5 has been installed and click on OK.

    Implementing Our First Application Using the Entity Framework

    In this section, we will learn how to use the Entity Data Model and the Entity Data Source Control to implement our first program using the Entity Framework. We will use a GridView control to display bound data.
    Refer to the solution we created earlier using the Entity Data Model Designer. Now, follow these steps:
    1. Drag and drop an Entity Data Source control from the toolbox onto your  Default.aspx web form.
    2. Now, click on the Configure Data Source option to specify the data source. Refer to the following figure:
    3. Specify the Connection String and DefaultContainerName and then click on  Next.
    4. Specify the fields you would want to retrieve from the database table and click on Finish when done.
    5. Now, drag and drop a GridView control from the toolbox onto the  Default.aspx web form as seen in the following figure:
    6. Next, use the Choose Data Source option of the GridView control to associate its data source with the Entity Data Source control we created earlier. Refer to the following figure:
    Here is how the markup code of the GridView control looks with its templates defined. Note how the DataSourceID of the GridView control has been associated with the Entity Data Source control we created earlier.
    <asp:GridView ID="GridView1" runat="server" AutoGenerateColumns="False" DataKeyNames="EmployeeID" 
    DataSourceID="SqlDataSource1" BorderColor="Black" BorderStyle="Solid" Width="400px"> 
    <Columns> 
    <asp:BoundField DataField="EmployeeID" HeaderText="Employee ID" ReadOnly="True" 
    SortExpression="EmployeeID" /> 
    <asp:BoundField DataField="FirstName" HeaderText="First Name" SortExpression="FirstName" /> 
    <asp:BoundField DataField="LastName" HeaderText="Last Name" SortExpression="LastName" /> 
    <asp:BoundField DataField="Address" HeaderText="Address" SortExpression="Address" /> 
    </Columns>
    </asp:GridView>
    We are done! When you execute the application, your output should be similar to what is shown in the following figure: