Ahmed Moosa

Nothing but ASP.Net

Embedded Code and Inline Server Tags

Introductions

Hi, this my first article here and I hope it will be  more useful , so we will talk about  something we need to use every day in coding ,we will talk about  "Embedded Code " using "In line Server Tags " . Briefly it used to write server side code somewhere where it not allowed directly . more developers use it in data binding controls .but you can use it in many Places Like (Java Script , CSS , ASPX ) , and you can use it with Routing ,ConnectionStrings , XMLQuery , AppSettings , Recourses Files or just writing server side code mixed with html.  my be you had seen it in the top of .aspx  page .OK ! Let us  begin .

Download sample Code from Here

What In line Server Code is ?

inline server code enables you to embedded server side code mixed with client script like javascript or mixed with aspx or with css as we mentioned before.

What Is In line Server Tags ?

Look at this :

<%      %>

these tags what we talk about. It comes from ASP classic style and it used in PHP and JSP too for the same reason "Writing Server Side Code ".

Note: you must know that we can't use it in code behind (Page.aspx.cs ) .

inline Code and  Page Life cycle :

When the page call its Render Method after the PreRenderComplete Event completed the compiler will Execute this Code and embedded it into Render method which accept HtmlTextWriter  as a single parameter  like the following :

protected override void Render(HtmlTextWriter writer)
 {
     base.Render(writer);
}

Let us see the forms you may have seen:

 Page Directive

<%@ Page Language="C#"  %>

Rendering Code

<% Response.Write("Hello World!");  %>

<%= SayHello("Ahmed") %>

<%: DateTime.Now.ToString()  %>

Expression Syntax

<%$ ConnectionStrings:ConnStrFromWebConfig  %>

<%$ AppSettings:ValueFromWebConfig  %>

<%$ Resources:Resource, Arabic  %>

<%$ RouteValue:year  %>

<%$ YourExpressionPrefix : Any   %>

Data Binding  Syntax

<%# Eval("Name")  %>

<%# Bind("Name")  %>

<%# XPath ("Name")  %>

Comment Server

<%-- <asp:Label runat="server" Text="Label"></asp:Label>-- %>

Let us do it in details :

Directive

We use directive to specify settings used by page and user control Compiler . we use it to say hi complier this file is ...... .each directive can have number of attributes as you need.

each directive start with @ . ASP.Net introduced number of Directive as following :

@Page
: used on .aspx files only and you can use only one  directive inside a file . 

<%
@ Page Language="C#" %>

<%@ Page Language="C#" CodeFile="Default2.aspx.cs" Inherits="Default2"  %>

Note that we are  using Codefile to pass the file name of code behind and inherits to pass class Name.

 

@Control : used only in .ascx files (user control)

<%@ Control Language="C#" ClassName="WebUserControl"  %>

 

@Import :  used for name space declaration and only when we write code inside script tags,I mean that if we use code behind we don't need it because we will use "Using Directive" (C#) or " Imports " (VB.net)

<%@ Import Namespace="System.Data"  %>

 

@Assembly :  used to Links an Assembly(.DLL or .CS and .VB ) to that page and user control .

DLL files like this

<%@ Assembly Name="CustomFile"  %>

(without .dll extension )

Class files like this :

<%@ Assembly src="Csharp.cs"   %>

<%@ Assembly src="Csharp.vb"   %>

Note: we are using Name attribute with dll files and src with class files.

 

@Register : used to register Controls (User Controls and Custom Server Controls) to page and user control.

<%@ Register assembly="AjaxControlToolkit" namespace="AjaxControlToolkit" tagprefix="asp"  %>

<%@ Register src="WebUserControl.ascx"   tagname="WebUserControl" tagprefix="uc1"  %>

 

Note :we are using Name attribute when using assembly and using src when user control.

@Implements : used when we want to implement an Interface . and this Directive  takes only one attribute "Interface" .

<%@ Implements Interface="IWebParts"  %>

 

@Reference : used to indicate that the source file of the page or user control  should dynamically compiled and linked to the current page .

<%@ Reference Control ="~/WebUserControl.ascx"  %>

<%@ Reference Page="~/Default2.aspx"  %>

<%@ Reference VirtualPath ="anyfile.any"  %>

 

@OutPutCache : used when we need to put a page or user control in the cache.

<%@ OutputCache Duration ="900" VaryByParam ="none"  %>

Note: both attributes ( Duration and VarybyParam ) are required .

 

@Master : used to decalre page as Master page.

<%@ Master Language="C#"  %>

 

@MasterType : used to reference Master Page when we need to access master page through  Master Property .

<%@ MasterType VirtualPath ="~/MasterPage.master"   %>

 

@PreviousPage : used when need to access previous page through PreviousPage Property .

<%@ PreviousPageType VirtualPath ="~/Default4.aspx"   %>

 

@Application : used to declare the global application file .(global.asax)

<%@ Application Language="C#"   %>

 

@WebService : used to declare the web service file .(.asmx)

<%@ WebService Language="C#" CodeBehind="~/App_Code/WebService.cs" Class="WebService"   %>

 

@WebHandler: used to declare the generic handler file (.ashx)

<%@ WebHandler Language="C#" Class="Handler"  %>

 

@ServiceHost : used by WCF (Windows Communication Foundation) .

<%@ ServiceHost Language="C#" Debug="true" Service="Service" CodeBehind="~/App_Code/Service.cs" %>

 

Rendering Code

Render code tags like Response.write Method. Here an example : using for Looping

    <div>

         <% for(int i = 0 ; i <5; i++){  %>

             Hello World ! <br />

           <%  } %>

    </div>

output the following :

Hello World !

Hello World !

Hello World !

Hello World !

Hello World !

 you can use it to execute a method but this time we use " = " to get out of Response.write to an Expression and =  is used to resolve an expression and return its value to the block

<%@ Page Language="C#"   %>

<script runat="server">

    string message = "I Can Do it ";


    string SayHello(string name)
    {
        return "Hello  " + name;
    }   

</script>

<html xmlns="http://www.w3.org/1999/xhtml">

<head runat="server">

    <title>Test Page </title>

</head>

<body>

    <form id="form1" runat="server">

    <div>
         <%= SayHello("Ahmed") %>
         <br />
         <br />
         <%="Message variable = " + message %>
    </div>
   </form>
</body>
</html>

it will output string say "Hello Ahmed " and also gets the value of message variable .

Note : this code blocks render nothing (no html controls ) . try it yourself . browse this code in the browser and Right click to View source .

Html Encoding output in ASP.Net 4

It provides a concise way to automatically HTML encode content and then render it as output

  <%:DateTime.Now.ToString () %>

You can learn more here :

we can also use it to embedded Server Side code in Client Side Code (Java Script)

what about calling Server side Method from Client Side Method . Let us do it :

take a look at this code

<%@ Page Language="C#"   %>

<script runat="server">
    string SayHello(string name)
    {
        return "Hello  " + name;
    }   
</script>

<html xmlns="http://www.w3.org/1999/xhtml">

<head runat="server">
    <title>Test Page </title>
    <script type="text/javascript" >
        function SayAny() {
            alert(' <%= SayHello("ahmed") %>');
        }
    </script>
</head>
<body>
    <form id="form1" runat="server">
    <div>
         <br />
        <input type="submit" onclick="SayAny()" value="Say Hello" />
        <br />
    </div>
    </form>
</body>
</html>

 it do what you expect : showing alert message .

Sometimes we have a problem when passig control id to client side code like this

var txt = document.getElementById("TextBox1");

and this happened when we work with container like master page or when we want to find control inside Data contorls Like GridView ,DataList ,Repeater ,and so on. this happens because the control has been changed to something like "container_ControlId". and to solve this issue we can use server side blocks like the following :

var txt = document.getElementById("<%=TextBox1.ClientID %>");

you can use alert message to display the value of this TextBox like this :

alert(txt.value);

Expression Syntax :

Get Connection String Section :

<%$ ConnectionStrings:ConnStrFromWebConfig %>

after we set connection strings in web.config file then we need to use data source controls ,Like the following :

Example

<asp:SqlDataSource ID="SqlDataSource2"   runat="server"  ConnectionString="<%$ ConnectionStrings:ConnectionString %>"
        SelectCommand="SELECT * FROM [Categories]">
</asp:SqlDataSource>

Notice: connectionstring is the name of connection string section inside Web.Config Like following :

Web.config :
<connectionStrings>
    <add name="ConnectionString"
            connectionString = "Data Source=.\SQLEXPRESS;AttachDbFilename=|DataDirectory|\NORTHWND.MDF;
                                        Integrated Security=True;User Instance=True"
            providerName = "System.Data.SqlClient" />
 </connectionStrings>

Get AppSettings Section

<%$ AppSettings:ValueFromWebConfig %>

after we set AppSettings section in web.config file you can call it using key name to return its value .

Web.config

<appSettings>
        <add key ="KeyName" value ="This Value Is Ahmed"/>
</appSettings>

Default.aspx

<asp:Label Text="<%$ AppSettings :Keyname  %>" runat="server" />

Get a value from Global Resource File (.resx )

<%$ Resources:Resource, Arabic  %>

Let us take an example switching between two Language (Arabic and English ).

  • Create two files (Resource.resx , Resource.ar-eg.resx ) and put them in App_GlobalResources folder.
  • Define a key with name "Greeting" in both resource files.

              Note : the "greeting" key will have two different value for Arabic and English .

  • Create test page.aspx and drag a label control and drop down list control. so ,your aspx code will be like this :

<div>
    <asp:DropDownList ID="DropDownList1" runat="server" AutoPostBack="True">
       <asp:ListItem Value="ar-eg">Arabic</asp:ListItem>
       <asp:ListItem Value="en-us">English</asp:ListItem>
    </asp:DropDownList>
    <br />
    <br />
    <asp:Label ID="Label1" runat="server" Text="<%$ Resources:Resource, Greeting %>"> </asp:Label>   
</div>

Note :

- Resources >> Say " I am working with resource files ".

- Resource >> say "I am the resource file name without extension".

- Greeting >> say " I am the Key which my value will be displayed"

now we have two values for "Arabic" and "English" we can switch between them. what will happen if we select English or Arabic ? ok, we need some code to change Language and Current Culture .let us go to next step:

  • We need to override IntializeCulture Method as following :

protected override void InitializeCulture()
    {
        if (Request["DropDownlist1"] != null)
       {
            string lang = Request["DropDownlist1"];
            Thread.CurrentThread.CurrentCulture = new System.Globalization.CultureInfo(lang );
            Thread.CurrentThread.CurrentUICulture = System.Globalization.CultureInfo.CreateSpecificCulture(lang );
        }
    }

Now you can select your Language from drop down list control and see that the related content will be displayed.

Routing

ASP.Net Routing is something about mapping URLs, Routing is available in ASP.Net web forms and ASP.Net MVC.Since .net framework 3.5. to use routing you need to create static method that take a parameter of RouteCollection data type inside global.asax file, then call these method in Application_Start event .

May you need more in Routing  so here you can take a look

http://msdn.microsoft.com/en-us/library/dd329551.aspx

Ok , what we want to say is we can use Expression Syntax to set URLs Like this :

<%$ RouteUrl:action=Edit , CategoryName=Cars%>

<%$ RouteValue:year %>

You need to understand what action and categoryName means? To do this refer to The above Link .

Exrpression Builder

<%$ YourExpressionPrefix : Any   %>

yes ,  you can create your Expression like mine :
<div>
   <asp:Label Text="<%$ myCode:DateTime.Now %>" runat="server" />
</div>

to learn more about Expression Builder Click Here

Data Binding Syntax

<%# Eval("Name") %>

<%# Bind("Name")%>

<%# XPath ("Name") %>

We use embedded code in Data binding to set or get or in Other words to read and write to a data source .we have Two methods for  working with Data base (Eval and Bind ) and one for working with XML (XPath that stand of xml path ) .so , what is the different between Eval and bind ? Eval method is One way that means it is for reading and Bind method is Two way that means it is for Reading and writing  .

Example :  using eval method in grid view to display Images .

<asp:GridView ID="GridView2" runat="server" AutoGenerateColumns="False" DataSourceID="SqlDataSource1">

        <Columns>

            <asp:BoundField DataField="Name" HeaderText="Name" SortExpression="Name" />

            <asp:TemplateField>

                <ItemTemplate>

                    <asp:Image ID="Image2" runat="server" ImageUrl='<%# Eval("Path")  %>' Width="70" />

                </ItemTemplate>

            </asp:TemplateField>

        </Columns>

    </asp:GridView>

In the above example we use eval method to get path field from data base and pass It to ImageUrl Property.

try to use bind method in editing data.

XPath method:

Use it when working with Xml, we can use it to select element or attribute and get its value and it comes in many forms Like this :

Look at this file.xml. we use it to simplifies the following :

<?xml version="1.0" encoding="utf-8" ?>
<Links>
    <Link>
       <name>Microsoft</name>
       <Site>http://www.microsoft.com</Site>
   </Link>
   <Link>
       <name id="10" >Asp.net</name>
       <Site>http://www.asp.net</Site>
   </Link>
    <Link>
        <name id="20" >MSDN</name>
        <Site>http://www.msdn.com</Site>
    </Link>
</Links>   

<%# XPath ("Name") %>

get the value of the Name element .

output here will be as following : Microsot  ASP.Net  MSDN

<%# XPath("name[@id]") %>

Get the value of the name element which take an attribute  with name "Id"

output here will be as following : ASP.Net  MSDN

<%# XPath ("name[@id=\"10\"]") %>

Get the value of name element which take an attribute with name id that its value equal 10 .

 

output here will be as following : ASP.Net 

<%# XPath("name/@id") %>

Get the value of  Every  attribute which its name is 'id' that  was defined in "name" element .

output here will be as following : 10  20

Yes, it is give xml more funs .

Note :

When using your custom method as Binding Expression Remember to call Databind Method . this question I meet it in Asp.Net forums and that is my answer "call Databind method to that control "

Example : Get Text  from the result of custom method .

<div>

      <asp:Button ID="SomethingBtn" Text="<%# ServerSideMethod()  %>" runat="server" />

</div>

So when we try to view it in browser the button wouldn't display any text . because we need to call Data bind method for that button Like this :

protected void Page_Load(object sender, EventArgs e)

    {

        Somethingbtn.DataBind();

    }

And finally I want to say that you can use all or one of them Like this :

<%# Eval("Id","~/default.aspx?id={0}")  %>

<%# "Your Name Is :" + Eval("Name") %>

<%# SayHello( Eval("Name").ToString () ) %>

And More ...........

Last thing is Comment Server 

We can use it to put  a comment where the comment is not allowed  .

Example :

<div>

<%-- <asp:Button ID="Button2" runat="server" Text="Button"  />--%>

</div>

That complete this topic , hope you enjoy and Happy Programming

Ahmed Moosa

Comments

wisecarver said:

Excellent examples!

Shalom

# October 7, 2010 8:18 AM

Abdalmohaymen said:

great article Ahmad

very thanks

# October 7, 2010 10:31 AM

manuelgdp said:

Keep writing Ahmed, Good Stuff!!!!!!!

# October 7, 2010 1:55 PM

Mostafa Hessin said:

Gamed Gedan

Keep it up.

# October 12, 2010 4:23 PM

gauravvmahhajan said:

can you tell how to process asp.net server tag in asp.net label

Label1.Text="<asp:Label ID='lll' runat='server' Text='Hello' />"

My data is comming from database where I wrote asp.net tags for dynamic output

# October 29, 2010 4:08 AM

ahmed moosa said:

@gauravvmahhajan  

hi

idon't understand what you mean? but i guess that you want to show this markup in your page as it is. if i am right you can use literal control

Hope this helps

Ahmed

# October 30, 2010 12:18 PM

sbower11 said:

Nice Blog…. Keep adding to it and thanks for the help!

# November 20, 2010 4:03 AM

Rupesh said:

Amazing article, awesome man, you did excellent work, i thanks you by heart..

# July 18, 2011 9:25 AM

bhaskar.mule said:

thanks for sharing .I have seen some of u r posts are really too good and needful in development area

csharpektroncmssql.blogspot.com

# December 19, 2011 8:45 AM

Jim said:

Great article - could NEVER find anything this good on a microsoft site.

# February 1, 2012 7:15 AM

Mickey Puri said:

Nice and clear article, thanks!

# February 23, 2012 5:40 AM