Click here to Skip to main content
6,295,667 members and growing! (14,582 online)
Email Password   helpLost your password?
Web Development » Ajax and Atlas » Controls     Intermediate License: The Code Project Open License (CPOL)

AJAX ASP.NET Rating Control

By Miroslav Sommer

An article on how to use the Rating control from the AJAX Control Toolkit and create CSS and images to display it as a gauge or thermometer.
C#, VB, Javascript, XML, HTML, VC8.0.NET 2.0, WinXP, Vista, Ajax, VS2005, Dev
Posted:29 Jan 2007
Updated:4 Jun 2007
Views:72,112
Bookmarked:72 times
Announcements
Loading...
 
Search    
Advanced Search
printPrint   Broken Article?Report       add Share
  Discuss Discuss   Recommend Article Email
35 votes for this article.
Popularity: 6.47 Rating: 4.19 out of 5
2 votes, 5.7%
1
2 votes, 5.7%
2
6 votes, 17.1%
3
5 votes, 14.3%
4
20 votes, 57.1%
5

Sample Image - AjaxRating.png

Introduction

This is an article on how to use the Rating control from the AJAX Control Toolkit, and create CSS and images to display it as a gauge or thermometer. It is useful for those who need to show ratings in ASP.NET more graphically.

Background

Once there was a demand on creating a thermometer on some AJAX ASP.NET site. Simple configuration of parameter ranges and different graphics were required.

Setting up

Pre-requisities to use the Rating control and to create the gauge/thermometer:

  • Windows (XP or newer)
  • Visual Studio (2005 or newer)
  • ASP.NET AJAX-Enabled Web Site (Microsoft ASP.NET AJAX v1.0)
  • AJAX Control Toolkit (v1.0.10123.0)
  • Intermediate knowledge of CSS
  • Knowledge of how to draw simple graphics

Using the code

The first thing you need to do is to add the Rating control to your aspx page. The page should look like this:

<%@ Page Language="VB" AutoEventWireup="true" 
                       CodeFile="Default.aspx.vb" Inherits="_Default" %>

<%@ Register Assembly="AjaxControlToolkit" Namespace="AjaxControlToolkit" TagPrefix="cc1" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" 
                         "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head runat="server">
        <title>Untitled Page</title>
    </head>
    <body>
        <form id="form1" runat="server">
            <asp:ScriptManager ID="ScriptManager1" runat="server" />
            <div>
                <cc1:Rating ID="Rating1" runat="server">
                </cc1:Rating>
            </div>
        </form>
    </body>
</html>

You need to set up the basic attributes of the Rating control. You can start with the attributes described at the control's web site.

    <ajaxToolkit:Rating runat="server" ID="Rating1"
        MaxRating="5"
        CurrentRating="2"
        CssClass="ratingStar"
        StarCssClass="ratingItem"
        WaitingStarCssClass="Saved"
        FilledStarCssClass="Filled"
        EmptyStarCssClass="Empty"
        >
    </ajaxToolkit:Rating>

The control provides a selection of five stars; therefore, it is possible to select a rating from 1 to 5. There are three basic images to display the control's state, recognized by CSS class names:

  • Empty - when the value is not selected.
  • Filled - when the value is selected.
  • Saved - when the value is being saved via an async. postback.

Also, there are two more styles:

  • ratingStar - specifies the control, this Rating is of type "star".
  • ratingItem - specifies each "star" of the rating.

The control renders like this: AjaxRating_stars.gif, 1 kB

But what if we want to use another graphics? What if we want to have a ratio from 1 to 10? What if we want to be able to select even a zero or "not-selected" value?

Simply, the Rating control allows that. You just write some CSS and paint some graphics.

The main idea is:

  • Have some pretty graphics on the background.
  • Use transparent boxes for Filled "stars". These boxes will reveal the background graphics.
  • Use filled boxes for Empty "stars". These boxes will cover the background.
  • Position the Rating control in CSS with padding to have "stars" placed over the required area of the background.
  • Change the MaxRating value. Add one to the value if you require a "zero" value.
  • For CSS attributes - change only the value of the CssClass attribute, leave the other CSS attributes untouched.

The sample Rating control's properties have these value:

MaxRating="21"
CssClass="ratingThermometer"
StarCssClass="ratingItem"
WaitingStarCssClass="Saved"
FilledStarCssClass="Filled"
EmptyStarCssClass="Empty"

... and shows a thermometer with values from 0 to 10 with a 0.5 step. Hence, MaxRating is computed as (10 / 0.5 ) + 1.

The modified control renders like this: AjaxRating_thermometer.gif, 2 kB

Finally, you need to compute the value that corresponds with your graphics, according to the control's CurrentValue, MaxRating, and the desired MinimumRange and MaximumRange:

    Public Shared Function EvaluateRating(ByVal CurrentValue As Integer, _
                      ByVal MaxRating As Integer, _
                      ByVal MinimumRange As Integer, _
                      ByVal MaximumRange As Integer) As Double

        ' If MinimumRange = 0 than compute value differently otherwise not
        Dim FromZero As Integer = IIf(MinimumRange = 0, 1, 0)
        Dim Delta As Double = (MaximumRange - MinimumRange) / (MaxRating - 1)
        Dim Result As Double = Delta * CurrentValue - Delta * FromZero
        
        Return result

    End Function

Points of interest

  1. You don't need to use the cc1 prefix and have the assembly registered unnecessarily on every page. You can register the AjaxControlToolkit assembly once in the Web.config. Add the following content into the configuration/system.web/pages/controls node:
    <add tagPrefix="ajaxToolkit" namespace="AjaxControlToolkit" 
                                 assembly="AjaxControlToolkit"/>

    Then, you can replace the cc1 prefix with a more readable ajaxToolkit prefix and remove the Register directive completely from any aspx page. The source code looks much better than before.

  2. There is currently a bug in the Rating control (AJAX Control Toolkit v1.0.10123.0). When you change the view from Source to Design, an error shows up: "value" could not be set on property 'CurrentRating', if value is >5. Nevertheless, everything works.
  3. And, you can surely write your code in C# if you prefer so. The idea of creating and evaluating doesn't change.

History

  • 2007-01-30: First version posted.
  • 2007-06-04: Text updated.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

Miroslav Sommer


Member
E-learning specialist. ASP.NET, PHP, AJAX and things like that Smile
Occupation: Software Developer (Senior)
Location: United Kingdom United Kingdom

Other popular Ajax and Atlas articles:

Article Top
You must Sign In to use this message board.
FAQ FAQ 
 
Noise Tolerance  Layout  Per page   
 Msgs 1 to 25 of 35 (Total in Forum: 35) (Refresh)FirstPrevNext
Newshow to set rating star's value from database value Pinmemberomkar mhaiskar3:34 28 May '09  
Generalproblem in Viewing image star in rating Pinmemberxccx3:30 7 Jan '09  
GeneralFor Displaying Message on Rating PinmemberDotNetGuts17:55 4 Dec '08  
GeneralDisplay - div Pinmembermgp2211:02 29 May '08  
GeneralRe: Display - div PinmemberMiroslav Sommer2:40 31 May '08  
GeneralRe: Display - div Pinmembermgp227:57 31 May '08  
GeneralRe: Display - div Pinmembermgp228:41 31 May '08  
GeneralRe: Display - div [modified] PinmemberMiroslav Sommer3:02 1 Jun '08  
GeneralRe: Display - div Pinmembermgp227:41 1 Jun '08  
GeneralHelp Pinmembermgp2211:00 29 May '08  
GeneralRe: Help PinmemberMiroslav Sommer2:30 31 May '08  
GeneralAsp.net ajax script managaer error Pinmembersaquibsa10:24 23 Apr '08  
GeneralRe: Asp.net ajax script managaer error PinmemberMiroslav Sommer2:24 31 May '08  
GeneralNew Object Instance Pinmembersaquibsa9:13 23 Apr '08  
GeneralRe: New Object Instance PinmemberMiroslav Sommer2:18 31 May '08  
Generaldevelop Pinmembermanasa16234:43 5 Oct '07  
GeneralRe: develop PinmemberMiroslav Sommer7:52 6 Oct '07  
Generalcontrol in datalist Pinmembervantoko0:44 19 Jul '07  
Questionblocking user to rate multiple times PinmemberArshad Raheed12:18 16 Jul '07  
AnswerRe: blocking user to rate multiple times [modified] PinmemberMiroslav Sommer12:05 29 Sep '07  
QuestionInstantiation of this rating control and assign it to my prducts list [modified] PinmemberM.Aghasi3:02 10 Jul '07  
AnswerRe: Instantiation of this rating control and assign it to my prducts list PinmemberMiroslav Sommer11:59 29 Sep '07  
GeneralHow to add rating on c# window application gridview Pinmemberkumar2721:20 29 May '07  
GeneralRe: How to add rating on c# window application gridview [modified] PinmemberMiroslav Sommer10:27 4 Jun '07  
Generalvote same value problem [modified] Pinmemberzatoichi190321:55 22 May '07  

General General    News News    Question Question    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

PermaLink | Privacy | Terms of Use
Last Updated: 4 Jun 2007
Editor: Smitha Vijayan
Copyright 2007 by Miroslav Sommer
Everything else Copyright © CodeProject, 1999-2009
Web15 | Advertise on the Code Project