DocumentListEventHandler Delegate

Represents the method that will handle the DocumentActivated event, DeletingDocument event, or SelectedDirectoryChanged event of a DocumentList.

Namespace:  Microsoft.WindowsCE.Forms
Assembly:  Microsoft.WindowsCE.Forms (in Microsoft.WindowsCE.Forms.dll)

Syntax

'Declaration
Public Delegate Sub DocumentListEventHandler ( _
    sender As Object, _
    e As DocumentListEventArgs _
)
'Usage
Dim instance As New DocumentListEventHandler(AddressOf HandlerMethod)

public delegate void DocumentListEventHandler(
    Object sender,
    DocumentListEventArgs e
)

public delegate void DocumentListEventHandler(
    Object^ sender, 
    DocumentListEventArgs^ e
)

JScript does not support delegates.

Parameters

• sender
  Type: System.Object

  The source of the event.

• e
  Type: Microsoft.WindowsCE.Forms.DocumentListEventArgs

  A DocumentListEventArgs that contains the event data.

Remarks

When you create a DocumentListEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event-handler delegates, see Events and Delegates.

In Visual Basic, you do not need to create an instance of a delegate to handle an event. At design time, you can declare the event source with the WithEvents modifier and add a Handles clause to the method that handles the event. However, if you want to want to start and stop event handling at run time, you must create a delegate and pass it to the AddHandler statement.

Examples

The following code example sets the delegate for the DeletingDocument event. This code example is part of a larger example provided for the DocumentList class.

// Create an instance of the event handler delegate 
// using a reference to the OnDocActivated method, 
// which handles the DocumentActivated event. 
// Add the delegate instance to the DocumentActivated event.
DocList.DocumentActivated +=
   new DocumentListEventHandler(this.OnDocActivated);

Platforms

Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Compact Framework

Supported in: 3.5, 2.0

See Also

Reference

Microsoft.WindowsCE.Forms Namespace

Other Resources

How to: Use a DocumentList Control