WebPartConnectionsCancelEventHandler Delegate


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Represents the method that will handle the WebPartsConnecting event or WebPartsDisconnecting event of a WebPartManager control.

Namespace:   System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)

public delegate void WebPartConnectionsCancelEventHandler(
	Object^ sender,
	WebPartConnectionsCancelEventArgs^ e


Type: System::Object^

The source of the event.

Type: System.Web.UI.WebControls.WebParts::WebPartConnectionsCancelEventArgs^

A WebPartConnectionsCancelEventArgs that contains the event data.

The WebPartsConnecting event is raised by the OnWebPartsConnecting method, and it signals that the connection process has begun (for example, a user has selected a control and clicked a connect verb), but is not yet completed. The event provides an opportunity to cancel a connection before it is complete. If the connection is successfully completed, this event is followed by the WebPartsConnected event.

The WebPartsDisconnecting event is raised by the OnWebPartsDisconnecting method, and it signals the fact that a user has clicked a disconnect verb, or the DisconnectWebParts method has otherwise been called. The event provides an opportunity to cancel the process of ending a connection before it is complete. If the connection is ended successfully, this event is followed by the WebPartsDisconnected event.

The method specified in the WebPartConnectionsCancelEventHandler delegate is called when a WebPartsConnecting or WebPartsDisconnecting event is raised.

Page developers can add custom handlers for the events by adding the OnWebPartsDisconnecting and OnWebPartsConnecting attributes to the <asp:webpartmanager> element, and assigning custom method names to the attributes. A custom handler can also be assigned programmatically. For more information on programmatically assigning an event handler, see NIB: How to: Connect Event Handler Methods to Events.

.NET Framework
Available since 2.0
Return to top