Export (0) Print
Expand All

WebPartConnectionsCancelEventArgs Class

Provides data for the WebPartsConnecting and WebPartsDisconnecting events.

System.Object
  System.EventArgs
    System.ComponentModel.CancelEventArgs
      System.Web.UI.WebControls.WebParts.WebPartConnectionsCancelEventArgs

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

public class WebPartConnectionsCancelEventArgs : CancelEventArgs

The WebPartConnectionsCancelEventArgs type exposes the following members.

  NameDescription
Public methodWebPartConnectionsCancelEventArgs(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint)Initializes a new instance of the WebPartConnectionsCancelEventArgs class without a specified connection.
Public methodWebPartConnectionsCancelEventArgs(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint, WebPartConnection)Initializes a new instance of the WebPartConnectionsCancelEventArgs class with the specified connection.
Top

  NameDescription
Public propertyCancelGets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs.)
Public propertyConnectionGets the Web Parts connection involved in the event.
Public propertyConsumerGets the Web Parts control acting as the consumer in the connection.
Public propertyConsumerConnectionPointGets the connection point that consumes data in the Web Parts connection.
Public propertyProviderGets the Web Parts control acting as the provider in the connection.
Public propertyProviderConnectionPointGets the connection point that provides data in the Web Parts connection.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The WebPartsConnecting event is raised by the OnWebPartsConnecting method, and it indicates 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 indicates 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 WebPartConnectionsCancelEventArgs class contains information about the WebPartsConnecting and WebPartsDisconnecting events. It provides access to the Web Parts controls that are being connected or disconnected.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft