Library tutorials & articles

Making skinned custom controls

A simple sample control

Ok, now let's test out our base class by creating a simple sample control. The control will do nothing more than display some text, using a label control and a repeater control.

using System;
using System.Web.UI.WebControls;
namespace MySite.Controls
{
    public class SampleControl : SkinControl
    {
        // ***********
        //  VARIABLES
        // ***********
        private string skinVirtualPath = "SampleSkin.ascx";
        // *************
        //  CONSTRUCTOR
        // *************
        public SampleControl()
        {
            if (SkinVirtualPath == null)
                SkinVirtualPath = skinVirtualPath;
        }
        // *********
        //  METHODS
        // *********
        protected override void Initialize(System.Web.UI.Control skinControl)
        {
            Label label1 = (Label) skinControl.FindControl("Label1");
            Repeater repeater1 = (Repeater) skinControl.FindControl("Repeater1");
            label1.Text = "A few primes";
            repeater1.DataSource = new string[] { "1", "3", "5", "7", "11" };
            repeater1.DataBind();
        }
    }
}

The first thing we do besides of course declaring the class is to hard-code the default virtual path to the skin file for this specific control. In this case SampleSkin.ascx. Once this is done we add the constructor for this class and inside the constructor we need to check whether a virtual path to a skin file is set, if not we use the default path.

The most important thing comes next, and that is overriding the Initialize method to customize it for the control. In the method we first of all locate all the controls in the skin we want to control – in this case a label control and a repeater control. The retrieval process is done by taking advantage of the FindControl method. For this sample the controls in the skin are named Label1 and Repeater1
After we have found our controls we can customize the controls like we see fit.

AddThis

Comments

  1. 27 May 2004 at 17:49

    You have successfully plundered the concepts contained in the asp.net forums without offering anything new, or really showing the reader why they would want to use them


    Not to mention your wonderful coding practice of catch {}


    What happens if the InitialiseSkin method makes calls to controls that don't exist on the skin? The skin is just not going to load, it won't show the user any helpful message. You're forgetting the skills of the average developer probably don't encompass debugging stack traces which don't get rethrown.


    Nice one.

Leave a comment

Sign in or Join us (it's free).

Related discussion

Related jobs

Events coming up

  • Oct 14

    What’s New in Visual Studio 2008 Service Pack 1?

    Birmingham, United Kingdom

    “Service Pack? We’re calling it a Service Pack? Are you kidding??!?!” Visual Studio 2008 Service Pack 1 will release later in 2008 alongside .NET Framework V3.5 Service Pack 1 and, together, they represent a significant upgrade to Visual Studio 2008. There are enhancements across many areas of the .NET Framework such as data access, windows application development and web development and there are also corresponding changes in the development environment to support the new framework features.