Skip to main content

Extension Method C#


Once a type is defined and compiled into a .NET assembly, its definition is, more or less, final. In order to add new members, update members, or remove members we need to recode and recompile the code base into an updated assembly. Or we could use System.Reflection.Emit namespace to reshape a compiled type dynamically.

Extension methods allow us to extend the functionality of previously compiled types. Using extension methods, we can add functionality to precompiled types while providing the illusion these methods were there all along. When we create extension methods, the existing precompiled assembly is not literally modified. Rather, the type is extended within the current project. If we package extension methods into a custom .NET *.dll, other applications would need to reference this library to make use of the extensions. To this end, extension methods are really just a way to ‘pretend’ a type has new functionality. The real type is not modified in any way.

Why do we need extension methods.

  • When we need to inject new functionality into types for which we do not have an existing code base, we can use extension methods.
  • When we need to force a type to support a set of members (for the interest of polymorphism) but cannot modify the original type declaration.
  • To summarize it is helpful when we need to  extend the behavior of a type  for a specific functionality but we still want the type to keep behaving as it is, for other parts of application.



Example(s)
public static class ExtensionMethods
{
    public static IEnumerable<T> MyWhere<T>(this IEnumerable<T> that,Func<T,bool> predicate)
    {
        return that.Where(predicate);
    }
    public static double Distance(this Position currentPosition,Position finalPosition)
    {
       return System.Math.Sqrt(System.Math.Pow(System.Math.Abs(finalPosition.X - currentPosition.X),2) + System.Math.Pow(System.Math.Abs(finalPosition.X - currentPosition.X),2));
    }
    public static void Position(this Position that)
    {
        Console.WriteLine(that.X + " : " + that.Y);
    }
}
public class Position
{
    public float X { get; set; }
    public float Y { get; set; }
}


There are few things to note.

  1. In C#, extension methods can only be defined within a static class.
  2. Extension methods need to be static.
  3. All extension methods are marked as such by using the this keyword as a modifier on the first (and only the first) parameter of the method in question. This parameter represents the data type being extended. Once implemented, extension methods can be called either from the correct instance in memory or statically via the defining static class.
  4. In a single class we can extend different types.
  5. Types need not to be present in same namespace. For example we extended IEnumerable<T> and Position classes.



Usage
Using these extended methods:
class Program
    {
        static void Main(string[] args)
        {
            //new linq
            var students = new[]
                               {
                                   new student {Name = "anuj", Age = 26},
                                   new student {Name = "gyan", Age = 27}
                               };
           
            var studentQuery = students.MyWhere(i => i.Age < 27);
           
            foreach(student s in studentQuery)
            {
                Console.WriteLine(s.Name + ":" + s.Age.ToString());
            }
           
            Console.WriteLine("-------------------------------------------------------------");
           
            var position = new Position()
                                    {
                                        X = 2,
                                        Y = 2
                                    };
            position.Position();
            Console.WriteLine("-------------------------------------------------------------");
            int j = 0;
            while(true)
            {
                Console.WriteLine(position.Distance(new Position() {X = j,Y = j}));
                Console.ReadLine();
                j++;
            }
            Console.ReadLine();
        }
    }
    public class student
    {
        private string name;
        private int age;
        public string Name
        {
            get { return name; }
            set { name = value; }
        }
        public int Age
        {
            get { return age; }
            set { age = value; }
        }
    }


Output




Hope this will be of some help. Please provide your valuable inputs/comments.

Comments

Popular posts from this blog

Create a background / taskbar application in c# .NET

Recently, I was working on integration of two windows applications. First application will launch the second application on login and then they both will communicate using pre-defined set of instructions. There were some complications (I am not going into them) and thus we decided to have a third application which actually will act as mediator. First application will launch the mediator (third application) and it will launch the second application. For this purpose we needed to create a task bar application (which will run in background). How To ·          Create a new windows project and delete the default form (Form1). ·          In Program.cs create a new class and inherit it from Form. ·          Please refer the code below. ·          Now change the Main method. In Application.Run change the startup objec...

Check SQL Server Job status (State) using sp_help_job and xp_sqlagent_enum_jobs

This article is about checking the status of a SQL job. In our work place we have lot of SQL jobs. These jobs will run whole day and are business critical. They will load the data and generate extracts which will be used by business people. Thus, it becomes quite essential to support the system efficiently so that the job finishes in time and as desired. Also, while designing a new system sometimes we need to check the dependency of one job over another. In such scenario we need to check whether a particular job has finished or not. All this can be achieved in SQL Server by using the procedures:- sp_help_job xp_sqlagent_enum_jobs Note: xp_sqlagent_enum_jobs is an undocumented proc inside of sp_help_job and is used extensively to get SQL agent job information. sp_help_job: This procedure gives some insight into the status, and information, about a job. This stored procedure provides information such as last start time, job status etc. Syntax sp_help_job { [ @job_id= ] jo...

Java 8 JMX Default Metrics

This is more of a note. Here you can find default types and attributes for JMX on top of Java 8. Code: I will clean and explain it later :( private static void WriteAttributes(final MBeanServer mBeanServer, final ObjectName http) throws InstanceNotFoundException, IntrospectionException, ReflectionException { MBeanInfo info = mBeanServer.getMBeanInfo(http); MBeanAttributeInfo[] attrInfo = info.getAttributes(); System.out.println("Attributes for object: " + http +":\n"); for (MBeanAttributeInfo attr : attrInfo) { System.out.println(" " + attr.getName() + "\n"); } } Attributes for object: java.lang:type=MemoryPool,name=Metaspace:   Name   Type   Valid   Usage   PeakUsage   MemoryManagerNames   UsageThreshold   UsageThresholdExceeded   UsageThresholdCount   UsageThresholdSupported   CollectionUsageThreshold   Collectio...