WebPartTracker Class

Definition

Namespace:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

Monitors Web Parts connections for circular connections.

public ref class WebPartTracker sealed : IDisposable

public sealed class WebPartTracker : IDisposable

type WebPartTracker = class
    interface IDisposable

Public NotInheritable Class WebPartTracker
Implements IDisposable

Inheritance

Object

WebPartTracker

Implements

IDisposable

Remarks

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.

Constructors

WebPartTracker(WebPart, ProviderConnectionPoint)

Initializes a new instance of the WebPartTracker class.

Properties

IsCircularConnection

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

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

IDisposable.Dispose()

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