Action<T> Delegate
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Encapsulates a method that takes a single parameter and does not return a value.
Assembly: mscorlib (in mscorlib.dll)
Type Parameters
- in T
The type of the parameter of the method that this delegate encapsulates.
This type parameter is contravariant. That is, you can use either the type you specified or any type that is less derived. For more information about covariance and contravariance, see [2678dc63-c7f9-4590-9ddc-0a4df684d42e].
Parameters
- obj
- Type: T
The parameter of the method that this delegate encapsulates.
You can use the Action<T> delegate to pass a method as a parameter without explicitly declaring a custom delegate. The encapsulated method must correspond to the method signature that is defined by this delegate. This means that the encapsulated method must have one parameter that is passed to it by value, and it must not return a value. (In C#, the method must return void. In Visual Basic, it must be defined by the Sub…End Sub construct. It can also be a method that returns a value that is ignored.) Typically, such a method is used to perform an operation.
Note: |
|---|
To reference a method that has one parameter and returns a value, use the generic Func<T, TResult> delegate instead. |
When you use the Action<T> delegate, you do not have to explicitly define a delegate that encapsulates a method with a single parameter. For example, the following code explicitly declares a delegate named DisplayMessage and assigns a reference to either the WriteLine method or the ShowWindowsMessage method to its delegate instance.
The following example simplifies this code by instantiating the Action<T> delegate rather than explicitly defining a new delegate and assigning a named method to it.
You can also use the Action<T> delegate with anonymous methods in C#, as the following example illustrates.
using System; public class Example { public static System.Windows.Controls.TextBlock outputBlock; public static void Demo(System.Windows.Controls.TextBlock outputBlock) { Example.outputBlock = outputBlock; Action<string> messageTarget; Random rnd = new Random(); if (rnd.NextDouble() <= .5) messageTarget = delegate(string s) { ShowAlertMessage(s); }; else messageTarget = delegate(string s) { ShowBrowserMessage(s); }; messageTarget("Hello, World!"); } private static void ShowAlertMessage(string message) { System.Windows.Browser.HtmlPage.Window.Alert(message); } private static void ShowBrowserMessage(string message) { outputBlock.Text += message + "\n"; } }
You can also assign a lambda expression to an Action<T> delegate instance, as the following example illustrates.
The ForEach and ForEach<T> methods each take an Action<T> delegate as a parameter. The method encapsulated by the delegate allows you to perform an action on each element in the array or list. The example uses the ForEach method to provide an illustration.
The following example demonstrates the use of the Action<T> delegate to print the contents of a List<T> object. In this example, the Print method is used to display the contents of the list to the console. In addition, the C# example also demonstrates the use of anonymous methods to display the contents to the console. Note that the example does not explicitly declare an Action<T> variable. Instead, it passes a reference to a method that takes a single parameter and that does not return a value to the List<T>::ForEach method, whose single parameter is an Action<T> delegate. Similarly, in the C# example, an Action<T> delegate is not explicitly instantiated because the signature of the anonymous method matches the signature of the Action<T> delegate that is expected by the List<T>::ForEach method.
Note: