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

Four real world uses of Partial classes and Partial methods

, 17 Jan 2012 CPOL
Rate this:
Please Sign up or sign in to vote.
In this article we will explain for real world use of Partial classes and partial methods.

Table of contents

Introduction

Recently I was researching about partial classes and their real world use. Many of the postings found on Google talked about the concept of partial classes and partial methods, but very few highlighted in what scenarios to use them.

In this article, we will first start with the fundamentals of partial classes and methods and then discuss four real world uses. I have also created a video here where I have discussed about partial classes and shown their real world use.

Fundamentals of partial classes

A partial class allows a single class to be divided into two separate physical files. During compile time, these files get compiled into a single class. For instance, you can see in the below figure we have the customer class divided into two different files “customer1.cs” and “customer2.cs”.

During compilation, these files get compiled into a single class internally. So when you create an object of the Customer class, you will be able to see methods lying in both the physical files. For instance, you can see the Add method belongs to customer1.cs and the Delete method belongs to customer2.cs, but when the Customer object is created, we can see both the Add and Delete methods.

Fundamentals of partial methods

There is one more important concept in partial classes called partial methods. Partial methods helps us to define a method in one physical file and we can implement that method in another physical file, as shown in the below figure.

In the figure, you can see we have defined the Validate method in Customer1.cs and this Validate method is implemented in Customer2.cs. Please note the partial keywords attached to both of these methods.

Use number 1: ASP.NET auto generated code

The biggest use of partial classes is in technologies where there is code generation. The Microsoft team themselves use partial classes in ASP.NET, LINQ, and EF code generation. For instance when we look at ASP.NET, there are two parts: the auto generated code of a page and the code-behind where you write your custom logic.

The custom logic is written in the “.aspx.cs” file while the auto generated logic is in the “.aspx.designer.cs” file, as shown in the below figure.

As a developer, you would like the auto generated code to do its work, i.e., generate code when you drag and drop a button in the ASP.NET designer.

Below is how the auto generated code looks like:

public partial class WebForm1 {
        
    /// <summary>
    /// form1 control.
    /// 
    /// <remarks>
    /// Auto-generated field.
    /// To modify move field declaration from designer file to code-behind file.
    /// </remarks>
    protected global::System.Web.UI.HtmlControls.HtmlForm form1;
    
    /// <summary>
    /// Button1 control.
    /// </summary>
    /// <remarks>
    /// Auto-generated field.
    /// To modify move field declaration from designer file to code-behind file.
    /// </remarks>
    protected global::System.Web.UI.WebControls.Button Button1;
        
    /// <summary>
    /// Label1 control.
    /// </summary>
    /// <remarks>
    /// Auto-generated field.
    /// To modify move field declaration from designer file to code-behind file.
    /// </remarks>
    protected global::System.Web.UI.WebControls.Label Label1;
}

At the same time, you would also like to customize the code in some other file in such a way that the auto generation part is not disturbed. For that, ASP.NET provides the “.aspx.cs” file which is a partial class where you can put your own custom logic.

public partial class WebForm1 : System.Web.UI.Page
{
    protected void Page_Load(object sender, EventArgs e)
    {
        // Your custom logic
    }
}

This is only possible when the class is split into two physical files but united via the partial keyword. So if you look at any ASP.NET code-behind class file, it’ll be marked with the word partial.

By using the partial keyword in ASP.NET, the Microsoft team has made VS and developers work side by side thus not fiddling with each other’s code and increasing productivity.

Use number 2: LINQ and Entity Framework

LINQ and EF also use partial classes and methods heavily because of the auto generation nature of these technologies. So when you drag tables in these framework, they create auto generated classes as shown in the below figure.

In the figure, you can see how the auto generated code has partial classes and partial methods.

The partial methods later can be extended to put custom logic. For instance, you can see in the below code that for the above auto-generated class tblCustomer, we have used partial methods to override the OnCustomerCodeChanged event to ensure that customer code is not more than 8 characters.

public partial class tblCustomer
{
    partial void OnCustomerCodeChanged()
    {
        if (_CustomerCode.Length > 8)
        {
            throw new Exception("Customer code can not be greater than 8");
        }
    }
}

So by using partial classes and partial methods, LINQ and EF keep auto generating classes and by using partial methods, we can customize the classes with our own logic.

Use number 3: Better maintenance by compacting large classes

The other important use of partial classes is for better maintenance of the project. If you have large classes with lots of methods as shown in the figure, it’s a bit of a pain to maintain those classes.

By using partial classes, you can split them into physical files as shown in the below figure, thus making your project better and easy to maintain.

Use number 4: Multiple people working on the same class

The last and final real world use I see of partial classes is when we want developers to work simultaneously in the same class. I agree this can be a very rare use as there are better options like using a version control software like TFS or Subversion, but in case you want something quick and local, this option is not bad at all.

You can also watch my 500 videos on different technologies like .NET, C#, Silverlight, Azure, VSTS, WCF, WPF, WWF, SharePoint, Design Patterns, UML, and lots more.

License

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

Share

About the Author

Shivprasad koirala
Architect http://www.questpond.com
India India

I am a Microsoft MVP for ASP/ASP.NET and currently a CEO of a small
E-learning company in India. We are very much active in making training videos ,
writing books and corporate trainings. Do visit my site for 
.NET, C# , design pattern , WCF , Silverlight
, LINQ , ASP.NET , ADO.NET , Sharepoint , UML , SQL Server  training 
and Interview questions and answers


Comments and Discussions

 
GeneralMy vote of 4 Pinmemberraven8er17-Sep-14 6:56 
SuggestionAnother Use Case PinmemberFIorian Schneidereit10-Jul-14 23:18 
GeneralRe: Another Use Case PinmemberFranc Morales14-Nov-14 0:16 
QuestionC# concept applied to C++/CLI? PinmemberRogueClay10-Jun-14 11:24 
GeneralRe: C# concept applied to C++/CLI? PinmemberPIEBALDconsult10-Jun-14 12:36 
GeneralRe: C# concept applied to C++/CLI? PinmvpShivprasad koirala12-Jun-14 19:56 
QuestionMessage Automatically Removed PinmemberAyesha Sharma3-Apr-14 23:35 
GeneralVery clear! PinmemberTam Mai19-Jan-14 4:35 
GeneralMy vote of 5 PinprofessionalPratik Bhuva19-Nov-13 20:29 
QuestionVery nice Pinmemberjagadishkr15-Jul-13 22:59 
GeneralMy vote of 5 PinmemberJuhi Paunikar8-Jul-13 1:25 
GeneralMy vote of 5 Pinmembercsharpbd19-Jun-13 9:27 
Questiongr8 Pinmemberlovelyim31-May-13 6:44 
GeneralMy vote of 5 PinmemberMember 92709757-May-13 1:05 
QuestionWell Done. PinmemberJustin Shepertycki12-Mar-13 9:14 
GeneralNice Article Shiv Pinmemberrajneeshrai7-Mar-13 22:06 
GeneralMy vote of 5 PinmemberVitorHugoGarcia7-Mar-13 4:34 
GeneralMy vote of 5 PinmemberDaniele Rota Nodari11-Feb-13 0:33 
GeneralMy vote of 5 PinmemberPraveen Raghuvanshi18-Jan-13 7:04 
Answercc Pinmemberjaiyaprada2-Jan-13 2:14 
SuggestionObsolete members Pinmemberjswolf1926-Oct-12 17:16 
GeneralMy vote of 5 Pinmembersathish5712-Oct-12 4:40 
GeneralMy vote of 4 Pinmemberthalavi31-Jul-12 3:17 
GeneralMy vote of 5 PinmemberAnoop Ananthan19-Jul-12 21:46 
GeneralMy vote of 1 Pinmemberthomsenj7231-Mar-12 1:13 
Confusing
QuestionI haven't voted: PinmentorKeith Barrow18-Feb-12 23:22 
AnswerRe: I haven't voted: PinmemberShivprasad koirala20-Feb-12 7:47 
AnswerRe: I haven't voted: Pinmembermark merrens9-Mar-12 8:54 
GeneralMy vote of 3 PinmemberClifford Nelson15-Feb-12 12:00 
Questionnice PinmemberCIDev13-Feb-12 10:54 
GeneralMy vote of 5 PinmemberRene Pilon11-Feb-12 8:03 
GeneralMy vote of 5 PinmemberMihai MOGA8-Feb-12 7:34 
GeneralMy vote of 5 PinmemberSridhar Patnayak6-Feb-12 18:10 
GeneralMy vote of 5 PinmemberKevinQiang.K6-Feb-12 7:51 
SuggestionPartial methods feel like premature optimization. PinmemberDwayne J. Baldwin28-Jan-12 7:46 
GeneralMy vote of 5 PinmemberAzhar Iqbal SE24-Jan-12 21:05 
GeneralMy vote of 5 PinmvpKanasz Robert24-Jan-12 12:17 
GeneralMy vote of 5 PinmemberSChristmas20-Jan-12 4:09 
GeneralMy vote of 3 PinmemberJacek Gajek18-Jan-12 7:28 
GeneralRe: My vote of 3 PinmemberShivprasad koirala20-Feb-12 8:05 
GeneralRe: My vote of 3 PinmemberJacek Gajek20-Feb-12 13:26 
QuestionSeparate Data and Code in WCF PinmemberMember 136679718-Jan-12 5:51 
QuestionNice Pinmembersurajfrommumbai18-Jan-12 1:46 
GeneralMy vote of 2 PinmemberKlaus Luedenscheidt17-Jan-12 20:10 
GeneralRe: My vote of 2 PinmemberShivprasad koirala18-Jan-12 1:53 
GeneralRe: My vote of 2 PinmemberShivprasad koirala18-Jan-12 2:05 
GeneralRe: My vote of 2 PinmemberJames H18-Jan-12 6:58 
GeneralRe: My vote of 2 Pinmemberbryce23-Jan-12 16:43 
GeneralRe: My vote of 2 PinmemberMohammad A Rahman18-Feb-12 23:28 
SuggestionAnother Use: Multiple Projects With Shared Classes But Divergent Implementations (XNA) PinprotectorAspDotNetDev17-Jan-12 11:22 

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
Web04 | 2.8.141220.1 | Last Updated 17 Jan 2012
Article Copyright 2012 by Shivprasad koirala
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid