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

Extended Vertical Label Control in C# .NET

, 26 Sep 2007 CPOL
Rate this:
Please Sign up or sign in to vote.
A custom vertical label user control in C#.NET with support for transparent backgrounds.

Screenshot - trans_vertical.png

Introduction

This article describes how to create a custom vertical label user control in C# .NET. The user control provides text draw from top or from bottom. This article is a derivation of Raman Tayal's Vertical Label Control in VB.NET. I just translated his work to C# and added the functionality of drawing text starting from bottom to top. Also, an updated version now supports transparent backgrounds.

Background

On one of my projects, I needed a label control that can display text vertically. I encountered Raman Tayal's Vertical Label Control in VB.NET and translated it to C#. But, I needed additional functionality of drawing text starting from the top, so I just added the functionality. This control has been useful to me, and I hope others would find it useful too.

Using the Code

The code provided is a class that creates a DLL that can be added as an item in the Toolbox of the Windows Forms designer. The class uses the following namespaces:

using System;
using System.ComponentModel;
using System.Drawing;

Code

The part of the code that really does the job is the override for the OnPaint event.

protected override void OnPaint(System.Windows.Forms.PaintEventArgs e)
{
    float vlblControlWidth;
    float vlblControlHeight;
    float vlblTransformX;
    float vlblTransformY;

    Color controlBackColor = BackColor;
    Pen labelBorderPen;
    SolidBrush labelBackColorBrush;

    if (_transparentBG)
    {
        labelBorderPen = new Pen(Color.Empty, 0);
        labelBackColorBrush = new SolidBrush(Color.Empty);
    }
    else
    {
        labelBorderPen = new Pen(controlBackColor, 0);
        labelBackColorBrush = new SolidBrush(controlBackColor);
    }
    
    SolidBrush labelForeColorBrush = new SolidBrush(base.ForeColor);
    base.OnPaint(e);
    vlblControlWidth = this.Size.Width;
    vlblControlHeight = this.Size.Height;
    e.Graphics.DrawRectangle(labelBorderPen, 0, 0, 
                             vlblControlWidth, vlblControlHeight);
    e.Graphics.FillRectangle(labelBackColorBrush, 0, 0, 
                             vlblControlWidth, vlblControlHeight);
    e.Graphics.TextRenderingHint = this._renderMode;
    e.Graphics.SmoothingMode = 
               System.Drawing.Drawing2D.SmoothingMode.HighQuality;
    
    if (this.TextDrawMode == DrawMode.BottomUp)
    {
        vlblTransformX = 0;
        vlblTransformY = vlblControlHeight;
        e.Graphics.TranslateTransform(vlblTransformX, vlblTransformY);
        e.Graphics.RotateTransform(270);
        e.Graphics.DrawString(labelText, Font, labelForeColorBrush, 0, 0);
    }
    else
    {
        vlblTransformX = vlblControlWidth;
        vlblTransformY = vlblControlHeight;
        e.Graphics.TranslateTransform(vlblControlWidth, 0);
        e.Graphics.RotateTransform(90);
        e.Graphics.DrawString(labelText, Font, labelForeColorBrush, 0, 0, 
                              StringFormat.GenericTypographic);
    }            
}

As you can see, I have an if condition in if (this.TextDrawMode == DrawMode.BottomUp). This tells us where the control decides whether to draw the text from bottom up or from top to bottom depending on the value of the property TextDrawMode.

When the value of TextDrawMode is BottomUp, you will notice that TranslateTransform accepts values zero for the X component of the translation and the height of the control as value for Y of the translation. This tells GDI to start drawing from the bottom left of the rectangle occupied by the control.

When the value of TextDrawMode is TopBottom, you will see that TranslateTransform accepts the control's width as the X component of the translation and zero as the Y component of the translation. This tells GDI to start drawing from top right of the rectangle occupied by the control.

The TextDrawMode property is an additional property that can be set during design time and also during runtime.

In this update, please notice that I am checking for the value of the _transparentBG variable which gets its value from a public boolean property TransparentBackground. If this is set to true, notice that the Brush color is set to Color.Empty; otherwise, it uses the control's assigned Color.

Also, I made the modifications on the constructor of the VerticalLabel control to include the following line:

SetStyle(System.Windows.Forms.ControlStyles.Opaque, true);

And finally, to enable transparency, the following override was added:

protected override CreateParams CreateParams
{
    get
    {
        CreateParams cp = base.CreateParams;
        cp.ExStyle |= 0x20;  // Turn on WS_EX_TRANSPARENT
        return cp;
    }
}

On the screenshot that I have provided, the horizontally-aligned text uses a WinForms Label control. The three vertical labels were displayed in different orientation (Bottom-Up | Top-Bottom) and also with different transparency (BackgroundTransparent = true|false) settings.

Points of Interest

Since this is my first time writing a program using GDI+, I tried to do it using trial and error, but it was frustrating at first, until I found a nice article on how to use Graphics.RotateTransform.

History

  • July 27, 2007: Initial version.
  • September 27: Updated with support for transparent background.

License

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

Share

About the Author

/randz
Software Developer (Senior)
United States United States
I am working as as a full-time Software Developer in Downtown DC Area
Follow on   Twitter

Comments and Discussions

 
QuestionAbout the Vertical Label Control Pinmember熊熊2-Sep-14 23:12 
GeneralMy vote of 5 Pinmemberpcs041425-Apr-12 4:58 
Generalvery thanks Pinmembertalinhu23-Nov-09 20:25 
GeneralThis is copied from another source PinmemberMonkeyCat28-Jan-09 5:41 
GeneralRe: This is copied from another source Pinmember/randz14-Mar-10 21:49 
NewsI have posted previously an article on this subject!!! PinmemberHoria Tudosie6-Nov-08 4:58 
You may find my article here:
 
http://www.codeproject.com/KB/custom-controls/VerticalLabel.aspx[^]
 
Mad | :mad:
 
Horia Tudosie

GeneralRe: I have posted previously an article on this subject!!! PinmvpJohn Simmons / outlaw programmer19-Nov-08 16:24 
GeneralThanks PinmemberSpikeAustin20-Aug-08 11:20 
GeneralRe: Thanks Pinmember/randz21-Aug-08 1:40 
QuestionLabel at Run-time PinmemberAlexB4716-Nov-07 4:32 
AnswerRe: Label at Run-time Pinmember/randz18-Nov-07 16:03 
QuestionVertical control does not clear old text before writing new one Pinmemberdmcyu30-Oct-07 7:12 
AnswerRe: Vertical control does not clear old text before writing new one Pinmember/randz9-Nov-07 19:52 
AnswerRe: Vertical control does not clear old text before writing new one Pinmemberdmcyu11-Nov-07 5:24 
GeneralRe: Vertical control does not clear old text before writing new one Pinmember/randz13-Nov-07 14:43 
GeneralRe: Vertical control does not clear old text before writing new one Pinmemberdmcyu13-Nov-07 19:47 
GeneralRe: Vertical control does not clear old text before writing new one Pinmember/randz13-Nov-07 20:28 
GeneralRe: Vertical control does not clear old text before writing new one Pinmemberm0nk3yi3unz5-Oct-08 19:38 
GeneralTransparent Background PinmemberBenjaminHelbig25-Sep-07 22:28 
AnswerRe: Transparent Background [modified] Pinmember/randz26-Sep-07 17:31 
AnswerRe: Transparent Background PinmemberJinHwan4624-Jul-08 20:40 
GeneralWith anti-aliasing support Pinmemberflops428-Aug-07 6:49 
GeneralRe: With anti-aliasing support [modified] Pinmember/randz8-Aug-07 18:56 

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

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.141223.1 | Last Updated 26 Sep 2007
Article Copyright 2007 by /randz
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid