Share via


CellProviderInitEventArgs Class

The CellProviderInitEventArgs class holds the data structure that is initialized when an ICellProvider Web Part creates a connection and fires an CellProviderInit event to an ICellConsumer Web Part. This data structure provides the name and display name of the provided cell to the consumer Web Part. This class cannot be inherited.

System.Object

    System.EventArgs

       Microsoft.SharePoint.WebPartPages.Communication.InitEventArgs

          Microsoft.SharePoint.WebPartPages.Communication.CellProviderInitEventArgs

Public Constructors

The following table shows the constructors of the CellProviderInitEventArgs class and a brief description of each.

Name Description
CellProviderInitEventArgs Initializes an instance of the CellProviderInitEventArgs class.

Public Properties

The following table shows the properties of the CellProviderInitEventArgs class, the data type of each property, and a brief description of each.

Name Data type Description
FieldDisplayName String Display name of the cell
FieldName String Name of the cell

Thread Safety

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

Example

The following code example shows an overridden

Visit PartCommunicationInit

method that creates a CellProviderInitEventArgs data structure to contain the FieldName and FieldDisplayName property values, sets the property values, and then fires the CellProviderInit event. This code example is part of a larger example provided for the ICellProvider interface.

Requirements

Namespace: Microsoft.SharePoint.WebPartPages.Communication

Platforms: Microsoft Windows Server 2003

Assembly: Windows SharePoint Services (in Microsoft.SharePoint.dll)

Security: Code Access Security. In addition, the WebPartPermissions.Connections permission is required to use this member.