This documentation is archived and is not being maintained.

WebPartTracker Class

Monitors Web Parts connections for circular connections.

System.Object
  System.Web.UI.WebControls.WebParts.WebPartTracker

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

public sealed class WebPartTracker : IDisposable

The WebPartTracker type exposes the following members.

  NameDescription
Public methodWebPartTrackerInitializes a new instance of the WebPartTracker class.
Top

  NameDescription
Public propertyIsCircularConnectionGets a value indicating whether a provider connection point is involved in more than one connection with a Web Parts control.
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 a hash function for a particular type. (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

  NameDescription
Explicit interface implemetationPrivate methodIDisposable.DisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Top

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

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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: