Generic Delegates in CSharp (Func, Action, Predicate)

Introduction

في المقال ده، هنتكلم عن الـ Generic Delegates في C# بالأمثلة. يا ريت تقرا مقالنا اللي فات اللي ناقشنا فيه أمثلة واقعية للـ Delegate في C#. كجزء من المقال ده، هنتكلم عن النقط المهمة دي بالتفصيل:

• إيه هي الـ Generic Delegates في C#؟
• أنواع الـ Generic Delegates في C#.
• ليه بنحتاج Generic Delegates؟
• الـ Func Generic Delegate في C#.
• الـ Action Generic Delegate في C#.
• الـ Predicate Generic Delegate في C#.
• أمثلة عشان نفهم Generic Delegates.

What are Generic Delegates in C#?

الـ Generic Delegates في C# تم تقديمها كجزء من .NET Framework 3.5 وهي مش بتحتاج إنك تعرّف delegate instance عشان تستدعي الـ methods. عشان تفهم Generic Delegates، لازم يكون عندك معرفة أساسية بالـ Delegates.

Types of Generic Delegates in C#

الـ C# بتوفر تلاتة built-in generic delegates، هما كالتالي:

• Func
• Action
• Predicate

Why do we need the Generic Delegates in C#?

خلونا نفهم الحاجة لـ Generic Delegates بمثال. الأول، خلونا نفهم إزاي بنستخدم delegates عشان نستدعي methods. خلونا نقول إن عندنا التلات methods دول وعايزين نستدعيهم باستخدام delegates.

// Method 1: Takes three parameters and returns a double
public static double AddNumber1(int no1, float no2, double no3) { /* ... */ }
 
// Method 2: Takes three parameters and returns void
public static void AddNumber2(int no1, float no2, double no3) { /* ... */ }
 
// Method 3: Takes one string and returns a boolean
public static bool CheckLength(string name) { /* ... */ }

دلوقتي، لو عايزين نستدعي التلات methods اللي فوق دول باستخدام delegates، يبقى لازم نعمل تلاتة delegates الـ signatures بتاعتهم تطابق الـ signatures بتاعة الـ methods دي:

// Delegate for AddNumber1
public delegate double AddNumber1Delegate(int no1, float no2, double no3);
// Delegate for AddNumber2
public delegate void AddNumber2Delegate(int no1, float no2, double no3);
// Delegate for CheckLength
public delegate bool CheckLengthDelegate(string name);

وبمجرد ما بنعمل delegates، نقدر نستدعي الـ methods بإننا نعمل instances من كل delegate بتشير للـ method بتاعتها:

AddNumber1Delegate obj1 = new AddNumber1Delegate(AddNumber1);
double Result = obj1.Invoke(100, 125.45f, 456.789);

Do we really need to create Custom Delegates to Invoke Methods in C#?

الإجابة هي لأ. الـ .NET Framework بيوفر شوية generic delegates تقدر تقوم بالوظيفة دي لينا. الـ C# بتوفر تلاتة Generic Delegates؛ هما: Func, Action, Predicate.

What is Func Generic Delegate in C#?

الـ Func Generic Delegate موجود في System namespace. الـ delegate ده بياخد input parameter أو أكتر وبيرجع out parameter واحد. آخر parameter بيعتبر قيمة الإرجاع (return value).

• الـ Func Generic Delegate يقدر ياخد لحد 16 input parameters من أنواع بيانات مختلفة أو زي بعض.
• لازم يكون ليه return type واحد. الـ return type إجباري لكن الـ input parameter مش إجباري.

ملاحظة: كل ما الـ delegate بتاعك يرجع قيمة، سواء كان بياخد input parameter أو لأ، لازم تستخدم Func Generic delegate.

What is Action Generic Delegate in C#?

الـ Action Generic Delegate موجود برضه في System namespace. هو بياخد input parameter أو أكتر ومبيرجعش أي حاجة (void). الـ delegate ده يقدر ياخد بحد أقصى 16 input parameters.

ملاحظة: كل ما الـ delegate بتاعك ميرجعش أي قيمة، سواء كان بياخد input parameter أو لأ، يبقى لازم تستخدم Action Generic delegate.

What is Predicate Generic Delegate in C#?

الـ Predicate Generic Delegate موجود برضه في System namespace. الـ delegate ده بيُستخدم عشان يتحقق من معايير معينة للـ method وبيرجع الـ output كقيمة Boolean، يا True يا False.

• بياخد input parameter واحد.
• دايمًا بيرجع قيمة Boolean وده إجباري.

ملاحظة: كل ما الـ delegate بتاعك يرجع قيمة Boolean، بياخد input parameter واحد بس، يبقى لازم تستخدم Predicate Generic delegate.

Examples to understand Generic Delegates in C#

خلونا نستخدم generic delegates عشان نستدعي التلات methods بتوعنا:

How to use Func Generic Delegate in C#?

AddNumber1 method بتاخد input وبترجع output. فالـ signature بتاعها بيطابق Func generic delegate.

// Func<input1_type, input2_type, ..., return_type>
Func<int, float, double, double> obj1 = new Func<int, float, double, double>(AddNumber1);
double Result = obj1.Invoke(100, 125.45f, 456.789);

الـ Func هنا بياخد أربعة parameters، أول تلاتة هما input parameters والآخر هو return value.

How to use Action Generic Delegate in C#?

AddNumber2 method بتاخد input لكن مبترجعش أي قيمة. فالـ signature بتاعها بيطابق Action generic delegate.

// Action<input1_type, input2_type, ...>
Action<int, float, double> obj2 = new Action<int, float, double>(AddNumber2);
obj2.Invoke(50, 255.45f, 123.456);

How to use Predicate Generic Delegate in C#?

CheckLength method بتاخد input parameter واحد من نوع string وبترجع قيمة Boolean. فالـ signature بتاعها بيطابق Predicate generic delegate.

// Predicate<input_type>
Predicate<string> obj3 = new Predicate<string>(CheckLength);
bool Status = obj3.Invoke("Pranaya");

المثال الكامل باستخدام Func, Action, Predicate:

using System;
namespace GenericDelegateDemo
{
    public class GenericDelegates
    {
        static void Main(string[] args)
        {
            Func<int, float, double, double> obj1 = new Func<int, float, double, double>(AddNumber1);
            double Result = obj1.Invoke(100, 125.45f, 456.789);
            Console.WriteLine(Result);
 
            Action<int, float, double> obj2 = new Action<int, float, double>(AddNumber2);
            obj2.Invoke(50, 255.45f, 123.456);
 
            Predicate<string> obj3 = new Predicate<string>(CheckLength);
            bool Status = obj3.Invoke("Pranaya");
            Console.WriteLine(Status);
 
            Console.ReadKey();
        }
        public static double AddNumber1(int no1, float no2, double no3) { /* ... */ }
        public static void AddNumber2(int no1, float no2, double no3) { /* ... */ }
        public static bool CheckLength(string name) { /* ... */ }
    }
}

Generic Delegates with Lambda Expression in C#

خلونا نشوف إزاي نستخدم Lambda Expression مع Generic Delegates. في المثال ده، بدل ما نمرر methods، هنستخدم lambda expressions:

using System;
namespace GenericDelegateDemo
{
    public class GenericDelegates
    {
        static void Main(string[] args)
        {
            Func<int, float, double, double> obj1 = (x, y, z) =>
            {
                return x + y + z;
            };
            double Result = obj1.Invoke(100, 125.45f, 456.789);
            Console.WriteLine(Result);
 
            Action<int, float, double> obj2 = (x, y, z) =>
            {
                Console.WriteLine(x + y + z);
            };
            obj2.Invoke(50, 255.45f, 123.456);
 
            // You can also use a method for Predicate if you prefer
            Predicate<string> obj3 = new Predicate<string>(CheckLength);
            bool Status = obj3.Invoke("Pranaya");
            Console.WriteLine(Status);
            Console.ReadKey();
        }
        // ... methods
    }
}

Points to Remember while working with C# Generic Delegates

• Func, Action, Predicate هما Generic Inbuilt delegates موجودين في System namespace.
• التلاتة delegates دول ممكن يُستخدموا مع method, Anonymous Method, و Lambda Expressions.
• الـ Func يقدر يحتوي على 16 input parameter كحد أقصى ولازم يكون ليه return type واحد وهو آخر parameter.
• الـ Action يقدر يحتوي على 16 input parameter كحد أقصى ومعندوش أي return type.
• الـ Predicate لازم يحقق معايير معينة لـ method ولازم يكون ليه input parameter واحد بس. بشكل افتراضي، ليه output parameter واحد من نوع return ومش محتاجين نمرر output parameter للـ Predicate.