Introduction
If you guys were following me through the last article, then you now know what partial class is. For new readers, you can visit this article on
Partial class.
In partial class, we can have executable code in 2 or more different files right, because the entry point for the class can be anywhere, any method, event, or constructor. We never know exactly which one. After that, the compiler follows the path that we set by calling another method or constructor chain, as the developer desires.
Problem
Let's say that I have one partial method in one file, as follows:
FileOne.cs
- partial class PlanetEarth
- {
- partial void DisplayProperties()
- {
- int num1 = 10;
- int num2 = 10;
- int result = num1 + num2;
- System.Console.WriteLine("Addition: "+result);
- }
- }
And another partial method:
FileTwo.cs
- partial class PlanetEarth
- {
- public void DisplayProperties()
- {
- int num1 = 20;
- int num2 = 20;
- int result = num1 * num2;
- System.Console.WriteLine("Multiplication: " + result);
- }
- }
The compiler will treat these 2 methods and create one, something like this:
- partial void DisplayProperties()
- {
- int num1 = 10;
- int num2 = 10;
- int result = num1 + num2;
- System.Console.WriteLine("Addition: "+result);
- int num1 = 20;
- int num2 = 20;
- int result = num1 * num2;
- System.Console.WriteLine("Multiplication: " + result);
-
- }
It will also throw a few exceptions as a gift.
The point of explaining all this is to make you realize that we simply can't chop the method's definition into two parts. It is just wrong on so many levels.
Partial Method
We can still have one method in 2 different files. Such methods are called partial methods. The condition is that they need to be declared and defined inside a partial class only.
- Partial methods have to have a declaration in one partial class & a definition in another. We can't have a definition split into 2 partial classes, we saw that problem above.
- It can also have both the declaration & definition in the same partial class.
- It has no return types (i.e. only void.)
- Both signatures should be the same.
- Partial methods are implicitly private, the compiler won't allow for any other access to be specified.
DisplayProperties declaration in PlanetEarth.cs file:
- public partial class PlanetEarth
- {
- public string Volume { get; set; }
- public string Mass { get; set; }
- public string Age { get; set; }
-
- partial void DisplayProperties();
- }
DisplayProperties defination in PrintEarthProperties.cs file:
- partial class PlanetEarth
- {
- partial void DisplayProperties()
- {
- System.Console.WriteLine("Volume: "+Volume + " Mass:"+ Mass + " Age:"+Age);
- }
- }
Smart Compiler
- Treats as a single class file. The compiler collects all those different files with the same class name & puts them together while compiling.
- We saw how to chop the definition from the declaration, but it is really up to the developers and business logic whether to provide a definition or not. If the developer doesn't provide any definition, then the compiler won't even consider a declaration of the method as well.
Conclusion
Now we know how to use partial methods, when to use it & what are the obvious errors we can pass.
Partial classes & methods are powerful tools together, they keep code neat, clean & easy to understand. Believe me, it takes away a lot of confusion.
I suggest you use them in your projects.
Thank you all. Keep coding!
Bohdan StupakPosted May 21, 2021, 8:15 AM
I was recently reading an article on reflection and noticed interesting usage of partial methods. In case you're interested you may refer to it as well in section "What does a generator look like for a consumer?". Here's the link https://blog.marcgravell.com/2021/05/is-era-of-reflection-heavy-c-libraries.html
Khushbu SainiPosted Aug 25, 2020, 1:52 AM
Can i call your DisplayProperties method in another partial class like in Class2 instead of PlanetEarth