WebPartTracker Class


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

Monitors Web Parts connections for circular connections.

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


public sealed class WebPartTracker : IDisposable

System_CAPS_pubmethodWebPartTracker(WebPart, ProviderConnectionPoint)

Initializes a new instance of the WebPartTracker class.


Gets a value indicating whether a provider connection point is involved in more than one connection with a Web Parts control.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Returns a string that represents the current object.(Inherited from Object.)


Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

A Web Parts connection is a link or association between two WebPart (or other server or user) controls that enables them to share data. In every Web Parts connection, one control acts as a provider of data and another as a consumer of data.

When a Web Parts control is both a provider and a consumer, and the provided data depends on the consumed data, there is the possibility of creating a connection that results in an infinite loop between Web Parts controls. These loops are called circular connections. A developer can prevent a circular connection by using the WebPartTracker class to track the number of connections for a provider connection point and a Web Parts control. The provider connection point and the control are specified in the WebPartTracker constructor.

If a circular connection is detected, the WebPartTracker object sets the WebPart.ConnectErrorMessage property on the provider Web Parts control. The IsCircularConnection property will return true.

.NET Framework
Available since 2.0

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

Return to top