Click here to Skip to main content
Click here to Skip to main content

Aqua Gauge

By , 4 Sep 2007
 
Screenshot - AquaGauge.gif

Introduction

I have chosen to develop this .NET user control to explore the easy yet powerful .NET GDI+. This simple gauge control developed using .NET 2.0 can cater to the entire range of monitoring purposes. Let's see how to develop such a glossy control using GDI+.

Overridden UserControl Methods

Normally, If we create user controls that have been fully drawn by the user, we should override the OnPaint and OnPaintBackground methods. Additionally, the control styles are to be set as appropriate. The following common styles can be set using this.SetStyle(ControlStyles.XXXXX, true/false);.

SupportsTransparentBackColor This will enable your control to support a transparent backcolor if set to true.
ControlStyles.ResizeRedraw Allows repainting when the control is resized.
ControlStyles.AllPaintingInWmPaint If true, the control ignores the window message WM_ERASEBKGND to reduce flicker.
This style should only be applied if the UserPaint bit is set to true.
ControlStyles.UserPaint If true, the control paints itself rather than the operating system doing so.
ControlStyles.OptimizedDoubleBuffer If true, the control is first drawn to a buffer rather than directly to the screen, which can reduce flicker. If you set this property to true, you should also set the AllPaintingInWmPaint to true.

The OnPaint and OnPaintBackground methods will be called whenever the control needs to be repainted. For example, when the control is resized or the form is minimized and maximized, the OnPaint method will be called.

OnPaintBackground vs. OnPaint

OnPaintBackground paints the background (and thereby the shape) of the Window and is guaranteed to be fast. In contrast, OnPaint paints the details and might be slower because individual paint requests are combined into one Paint event that covers all areas that have to be redrawn. You might want to invoke the OnPaintBackground if, for instance, you want to draw a gradient-colored background for your control.

While OnPaintBackground has an event-like nomenclature and takes the same argument as the OnPaint method, OnPaintBackground is not a true event method. There is no PaintBackground event and OnPaintBackground does not invoke event delegates. When overriding the OnPaintBackground method, a derived class is not required to invoke the OnPaintBackground method of its base class.

Drawing the Guage Dial

First, let's see how to draw the dial. The dial requires a Scale, Threshold Indicator, some text and the current value to be displayed.

Drawing the scale requires calculating the positions for the rules that are to be drawn at the circumference. Let's say we need to draw a scale starting from 0 to 10 from angle 90 degrees to 270 degrees on the dial. In this case, the difference in the degrees (270-90 = 180) must be divided into 10 parts. To find the position for each part to be drawn, we need the following formula:

x = centerX + radius * cos(180/partNo)
y = centerY + radius * sin(180/partNo)

Note: when using Math.Cos or Math.Sin we should give angles in radians.

Circle Formula

After finding the position, we can draw any type of scale mark on the circumference. I have chosen to draw a line as a scale mark. Since the dial area is not going to be changed often, it can be drawn in OnPaintBackground overridden method.

Drawing the Pointer

The pointer may need to be repainted often. So, it is better to draw it in the OnPaint method. Finding the pointer position is the same as the logic for drawing the scale. The pointer can be drawn using graphicsObj.FillPolygon() method and it can be transformed to any angle that will represent the current value. Otherwise, the pointer can be redrawn for every change made for the current value.

Drawing the Glossiness

Drawing the glossiness is very simple. All you have to do is, after painting all the dial and pointer, fill two ellipses with gradient coloring. The LinearGradientBrush class provides the ability to draw gradient fills. Masking the gradient layer over the dial gives the glossiness as shown in the below figure.

Glosiness

Using the AquaGauge Control

This AquaGauge control can be used as any other user control provided by Windows. The following are the control-specific properties that can be used to configure this gauge to suit your requirements.

Property Name Type Description
DialColor Color Gets or Sets the background color for the gauge.
DialText String Gets or Sets the Text displayed on the gauge dial.
EnableTransparentBackground bool Enables or Disables Transparent Background color. Note: Enabling this will reduce the performance and may make the control flicker.
Glossiness float Gets or Sets the strength of the Glossiness.
MaxValue float Gets or Sets the maximum value shown on the gauge scale.
MinValue float Gets or Sets the minimum value shown on the gauge scale.
NoOfDivisions int Gets or Sets the number of divisions on the gauge scale.
NoOfSubDivisions int Gets or Sets the number of subdivisions displayed on the scale for each division.
RecommendedValue float Gets or Sets the recommended value on the scale. This will be used as a pivot point for drawing the threshold area.
ThresholdPercent float Gets or Sets the Threshold area percentage on the scale.
Value float Gets or Sets the value to which the pointer will point.

Points of Interest

Whenever we draw images with lots of manipulations, it is recommended to draw it on an image object and then paint. For example, drawing the gauge dial requires lots of CPU-consuming operations. So, we can draw the dial onto an image and then draw using graphicsObj.DrawImage(). Whenever changes are made on the dial properties, we can recreate the image object. It would improve the performance.

History

  • Version 1.0 - Initial Version

All comments and suggestions are welcome.

License

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

About the Author

Ambalavanar Thirugnanam
Architect BNY Mellon
India India
Member
Ambalavanar, working as a .NET Solutions Architect at BNY Mellon (iNautix), Chennai. Enjoys designing and developing UI & highly scalable apps.

Sign Up to vote   Poor Excellent
Add a reason or comment to your vote: x
Votes of 3 or less require a comment

Comments and Discussions

 
You must Sign In to use this message board.
Search this forum  
    Spacing  Noise  Layout  Per page   
GeneralMy vote of 5membercesarms895 Apr '13 - 6:35 
Excellent it's easy to use and very usefull thanks Smile | :)
Questionprogramatically create a gauge?memberleos7915 Feb '13 - 20:22 
Hi!
 
Thank you for your contribution!
 
I'm trying to dinamically crate gauges and put them on a tablelayoutpanel. But the problem I have is, although i get no error, i cant get the graph done.
 
I've tried 2 things; the one you recommend (getting the gague image) and, as that didn't worked, dinamically create a gauge and assigning it to a existent control. I've done this:
 
 
         g = New AquaControls.AquaGauge
         g.MaxValue = 100
         g.MinValue = 0
         g.DialText = Titulo
         g.NoOfDivisions = 10
         g.NoOfSubDivisions = 4
         g.Glossiness = 10
         g.DialColor = Color.Gray
         g.ForeColor = Color.Red
         g.BackColor = System.Drawing.Color.Transparent
         g.Size = New System.Drawing.Size(163, 163)
         g.Value = CSng(m_Actual)
         g.RecommendedValue = CSng((Maximo + Minimo) / 2)
         g.ThresholdPercent = CSng(Maximo - Minimo)
 
         g.Width = Ancho
         g.Height = Alto
         g.Update()
 
I return g, then, if I do this:
 
F.agCargaCPU = CargaCPU.g
 
(being "F" my form and "agCargaCPU" another aquagauge control I have on it), agcargacpu stays blank.
 
Of course, I have another aquagauge control on the form, which i initialize at design time and it shows OK.
 
Any tips?
 
Regards!
QuestionGauge Needle Update, But Value Does NotmemberMember 920084522 Aug '12 - 17:00 
Hi guys
 
I am attempting to use Aqua Gauge to display live values from six (6) data sources over the serial port. Within the one application I have six (6) gauges.
 
As the application reads the data, the gauge needles will change and update showing the correct values on the gauges, however the numerical value to the bottom of the gauges will not update.
 
Any ideas on how to get the numerical values to update as the dial changes?
AnswerRe: Gauge Needle Update, But Value Does NotmemberJoerg_Laukemper29 Aug '12 - 0:34 
Hi,
I had the same problem and found the solution in the post "digit value quick fix": Within OnPaintBackground you must set "requiresRedraw = true;" .
Good luck.
GeneralMy vote of 5membermanoj kumar choubey21 Aug '12 - 18:56 
Nice
QuestionSmoothnessmemberazizib11 Jun '12 - 2:46 
thanks for your very nice implementation
Is there any method that help in smooth movement? for example if my value changed from 50 to 100 , I want to have a smooth movement from 50 to 100 in my gauge.
I know that I can do that by an external method by myself, but I want to know that is there any way already exist in your solution?
 
Regards
Bamshad
AnswerRe: SmoothnessmemberAmbalavanar Thirugnanam11 Jun '12 - 16:58 
Sorry, there is no implementation for smooth movement in the code. Thanks.
-----------------------------
Go far with your knowledge...
Further with google...

GeneralRe: Smoothnessmemberazizib20 Jun '12 - 1:18 
Thanks for your reply
 
I implemented it by myself. but the problem is the gauge digital value does not change any more even using your default method for setting the gauge pointer value.
 
I did not modify part of your code, I just added my method for smoothness in pointer movement.
 
I checked the other comments but "reDraw = true" just helps me in changing the digital value , but it misses the stability instead and make a lot of exception during working. Is there any way to change the digital value by myself?
 
Regards
Bamshad
GeneralRe: Smoothnessmemberarenaxp11 Sep '12 - 22:24 
Could you share source code for smoothness and digital value?
 
thanks in advance.
GeneralRe: Smoothnessmemberazizib12 Sep '12 - 1:13 
I added the "smooth value" property, but the smoothness of changing the value was affecting the gauge label so I deleted it.
But you can easily implement it by just changing the value by adding 1. for example if you want to change the value from 10 -> 30 then add the value by one in a loop for 20 times : 10+1=11 ; 11+1=12 ;...; 29+1 = 30;
just take care about the multi threading , because your GUI will locked (freeze) so you need to use multi threading techniques like Background worker. Easily you can find in internet how to do it.
 
Regards
Bamshad

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Permalink | Advertise | Privacy | Mobile
Web03 | 2.6.130523.1 | Last Updated 4 Sep 2007
Article Copyright 2007 by Ambalavanar Thirugnanam
Everything else Copyright © CodeProject, 1999-2013
Terms of Use
Layout: fixed | fluid