DependencyObject.AddHandler Method (System.Workflow.ComponentModel)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
DependencyObject.AddHandler Method

Adds a handler for an event of a DependencyObject.

Namespace:  System.Workflow.ComponentModel
Assembly:  System.Workflow.ComponentModel (in System.Workflow.ComponentModel.dll)
Syntax
Visual Basic
Public Sub AddHandler ( _
	dependencyEvent As DependencyProperty, _
	value As Object _
)
C#
public void AddHandler(
	DependencyProperty dependencyEvent,
	Object value
)
Visual C++
public:
void AddHandler(
	DependencyProperty^ dependencyEvent, 
	Object^ value
)
F#
member AddHandler : 
        dependencyEvent:DependencyProperty * 
        value:Object -> unit

Parameters

dependencyEvent
Type: System.Workflow.ComponentModel.DependencyProperty
The DependencyProperty.
value
Type: System.Object
The Object that represents the value of this property. In this case, a Delegate type.
Exceptions
Exception Condition
ArgumentNullException

Either of the arguments is a null reference (Nothing in Visual Basic).
ArgumentException

Value is of incorrect Type.
ArgumentException

The dependencyEvent represents a non-event DependencyProperty.
Remarks

When you create a delegate, you identify the method that handles the event. To associate the event with your event handler, add an instance of the delegate to the event. Unless you remove the delegate, the event handler is called whenever the event occurs. Multiple delegates can be added to handle an event. For more information about event-handler delegates, see Events and Delegates.

Examples

Handlers are added and removed using the following code. This code example is part of the Send E-mail SDK sample and is from the SendMailActivity.cs file. For more information, see Send E-mail Activity Sample.

Visual Basic


#Region "Public Events"

        <DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)> _
        <Description("The SendingEmail event is raised before an email is sent through SMTP.")> _
        <Category(EventsCategory)> _
        <Browsable(True)> _
        Public Custom Event SendingEmail As EventHandler
            AddHandler(ByVal value As EventHandler)
                MyBase.AddHandler(SendEmailActivity.SendingEmailEvent, value)
            End AddHandler

            RemoveHandler(ByVal value As EventHandler)
                MyBase.RemoveHandler(SendEmailActivity.SendingEmailEvent, value)
            End RemoveHandler

            RaiseEvent(ByVal sender As Object, ByVal e As System.EventArgs)

            End RaiseEvent
        End Event
C#

        #region Public Events

        [DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)]
        [Description("The SendingEmail event is raised before an email is sent through SMTP.")]
        [Category(EventsCategory)]
        [Browsable(true)]
        public event EventHandler SendingEmail
        {
            add
            {
                base.AddHandler(SendEmailActivity.SendingEmailEvent, value);
            }
            remove
            {
                base.RemoveHandler(SendEmailActivity.SendingEmailEvent, value);
            }
        }
Version Information

.NET Framework

Supported in: 4, 3.5, 3.0
.NET Framework Security
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
See Also

Reference

DependencyObject Class
System.Workflow.ComponentModel Namespace