ASP.NET Core : Adding The Default View With _ViewStart.cshtml

In ASP.NET MVC there is a default layout file that the application use when one exists.  If you look at the markup at the top of the "Index.cshtml" file you will see that there is a markup to specify the layout of the page in the code below.

@{
    Layout = null;
}

The code above tells ASP.NET MVC to not assign any layout to the page because it is being set to null. In this blog we will build on our existing NorthwindCafe.Web  project and add a default layout view to the project so that each page in the project will have a common layout.  This is similar what you would a master page for in web forms.




Step-By-Step Instructions:

1. Open the "NorthwindCafe.Web project in Visual Studio
2.  Right-click on the Views folder then select Add → New Item → .NET Core →  MVC View Start Page then click the "Add" button










4.  Now you will see the _ViewStart.cshtml file in the "Views" folder






5.  Delete all the markup in the _ViewStart.cshtml file, then type in the following lines of code, then save the file
@{
    Layout = "~/Views/Shared/_Layout.cshtml";
}

6.  Right-click on the "Views" folder again, then this time create a folder call "Shared"







7.  Right-click on the "Shared" folder then select Add → New Item → .NET Core → MVC View Layout Page , name the file "_Layout.cshtml", click on the "Add" button


8.  When you are finish you should have the following folder structure in your "Views" folder








9.  In the _Layout.cshtml file you will see the following markup


<!DOCTYPE html>
<html>
    <head>
        <title>@Page.Title</title>
        @RenderSection("head", required: false)
    </head>
    <body>
        <h1>This is from the _ViewStart.cshtml</h1>
        @RenderBody()
    </body>
</html>

In the code above the line @RenderSection("head", required: false) tells MVC to render the head section if it's there in the web page, however it is not required. Then in the line @RenderBody() tells MVC to render the body. We added the line <h1>This is from the _ViewStart.cshtml</h1> as an indicator that _ViewStart.cshtml file is being applied.

10.  Now we are going to use the default _ViewStart.cshtml layout with our "Index.cshtml" file
11.  Open the "Index.cshtml" file and delete all the markup for it if you have any
12. Now type in the following markup for the page

<h3>This is from Index.cshtml</h3>

In the code above all we have to do is type in the markup for our page, the common tags like the head and body tag has been taken care of by the layout. If you run the application by pressing Ctrl+F5 you will the following
















As you can see even though we didn't define any layout in our "Index.cshtml" file all we have was the <h3>This is from Index.cshtml<h3> markup, the layout specified in the _ViewStart.html file was automatically applied to our page.  If you look the generated html page you will see that it's a complete HTML5 page, with the head and body tag. This is possible because of the _ViewStart.cshtml page.

<!DOCTYPE html>
<html>
    <head>
        <title></title>
        
    </head>
    <body>
        <h1>This is from the _ViewStart.cshtml</h1>
        

<h3>This is from Index.cshtml</h3>
    
<!-- Visual Studio Browser Link -->
<script type="application/json" id="__browserLink_initializationData">
    {"appName":"Firefox","requestId":"e06cac45479d4bfe8fcf5ab10b04ce35"}
</script>
<script type="text/javascript" src="http://localhost:51916/ec2fbdd4a59342ca8fe98bb63b3b5e82/browserLink" async="async"></script>
<!-- End Browser Link -->

</body>
</html>

Comments

Popular posts from this blog

SQL: GROUP BY And HAVING

Installing AdventureWorks Sample Databases from Microsoft

Docker : Pull The Latest CentOS Image Into A Ubuntu Server