Skip to main content

Partial Methods in C#

Partial Methods in C# Explained

The partial method is a special type of method which will contain a declaration part in one partial class and the definition part in another partial class or in the same partial class.

 

Generally, the partial methods will exist either in partial class or struct and it will contain two main parts one is declaration and definition. Here, the declaration part represents a signature of the partial method and the definition part will represent an implementation of the partial method.

 

In the partial method, the definition part is optional so it may or may not have an implementation in partial classes. In case, the implementation part of the partial method is not available in any partial class, then the compiler will remove the definition of the method and all the calls related to that particular method in the final class.

 

Following is the example of implementing a partial method using partial keyword in two class files, Person1.cs and Person2.cs.

 

Person1.cs file code snippet

                                         

public partial class Person

{

    // Partial Method Declaration

    partial void GetPersonDetails(string name, string location);

    public void TestMethod()

    {

        Console.WriteLine("Testing partial method in Person1 class");

    }

}

 

From above code, we declared a partial method called GetPersonDetails in Person1.cs class file using partial keyword along with normal method called TestMethod().

 

Person2.cs file code snippet

 

public partial class Person

{

    public Person(string name, string location)

    {

        GetPersonDetails(name, location);

    }

    // Partial Method Implementation

    partial void GetPersonDetails(string name, string location)

    {

        Console.WriteLine("Name: " + name);

        Console.WriteLine("Location: " + location);

    }

}                                                

 

If we observed above code carefully, we will found an implementation of a partial method called GetPersonDetails in Person1.cs class file using partial keyword with required variables and constructor.

When we execute the above code, the compiler will combine these two partial classes into one Person class like as shown below.

 

public class Person

{

    public Person(string name, string location)

    {

        GetUserDetails(name, location);

    }

    public void TestMethod()

    {

        Console.WriteLine("Test");

    }

    private void GetUserDetails(string name, string location)

    {

        Console.WriteLine("Name: " + name);

 

        Console.WriteLine("Location: " + location);

 

    }

}


Rules to follow in Implementing Partial Method

We need to follow certain rules to implement the partial method in our applications.

 

  • In c#, the partial method can be implemented within partial class or structure only and the signatures in both parts of the partial type must be the same.
  • The partial method declaration must begin with partial keyword and method must return void.
  • By default, partial methods are implicitly private so no access modifiers are allowed and they cannot be virtual.
  • Partial methods can have ref but not out parameters.
  • Partial methods can be static and generic.

 

Partial Method Example in C#

Following is the example of defining a partial method in partial class using partial modifier in C#.

 

using System;

namespace CsharpnaijaTutorial

{

    public partial class Person

    {

        // Partial Method Declaration

        partial void GetPersonDetails(string name, string location);

    }

    public partial class Person

    {

        public Person(string name, string location)

        {

            GetPersonDetails(name, location);

        }

        // Partial Method Implementation

        partial void GetPersonDetails(string name, string location)

        {

            Console.WriteLine("Name: " + name);

            Console.WriteLine("Location: " + location);

        }

    }

 

    class Program

    {

        static void Main(string[] args)

        {

            var person = new Person("Musa Sule", "Abuja");

            Console.WriteLine("\nPress Enter Key to Exit..");

            Console.ReadLine();

        }

    }

}

When you execute the above C# program, we will get the result as shown below.

partial method
 


Thank you

 

References

1.      Tutlane

2.      Documentation– Microsoft

3.      Geeks forGeeks


Labels:
Location: Abuja, Nigeria

Comments

Post a Comment

Popular posts from this blog

Classes in C# Explained

C# Class Explained A class is nothing but an encapsulation of properties and methods that are used to represent a real-time entity, as explained by Guru99 . For instance, if you want to work with Guest’s data as in our previous DataDriven Web application . The properties of the Guest would be the Id, GuestName, Address, Phone number etc of the Guest. The methods would include the entry and modification of Guest data. All of these operations can be represented as a class in C# as shown below. using System; namespace CsharpnaijaClassTutorial {     public class Guest     {         public int Id { get ; set ; }         public string GuestName { get ; set ; }         public string Address { get ; set ; }         public string WhomToSee { get ; set ; }     ...
1 comment
Read more

ASP.NET MVC Routing

ASP.NET MVC Routing ASP.NET MVC routing is a pattern matching system that is responsible for mapping incoming browser requests to specified MVC controller actions. When the ASP.NET MVC application launches then the application registers one or more patterns with the framework's route table to tell the routing engine what to do with any requests that matches those patterns. When the routing engine receives a request at runtime, it matches that request's URL against the URL patterns registered with it and gives the response according to a pattern match. Routing pattern is as follows A URL is requested from a browser, the URL is parsed (that is, break into controller and action), the parsed URL is compared to registered route pattern in the framework’s route table, if a route is found, its process and send response to the browser with the required response, otherwise, the HTTP 404 error is send to the browser. Route Properties ASP.NET MVC routes are res...
Post a Comment
Read more

Role-Based Authorization in ASP.NET MVC

Role-Based Authorization Explained The most challenge aspect of any web application is implementing its security. In traditional web development with ASP.NET (from version 2.0 onwards), we have been using Membership and Role providers. These providers allows us to define Roles, Users and assign roles to users which helps us to manage Authorization. But with an increase in social networking and global authentication providers, we needed an upgraded membership system. ASP.NET Identity is the new membership system for building ASP.NET web applications, phone, store, or hybrid applications using social identities for authentication and authorization. So we can now use Windows Live (e.g. Hotmail), Gmail, Facebook and Twitter for authentication before the user starts using our web application. For internal application, we need to create users and roles for providing users access to creating items, products or managing other users. Necessary references are provided by MVC 5 applicatio...
1 comment
Read more