CellConsumerInitEventArgs.FieldDisplayName Property

NOTE: This API is now obsolete.

Gets or sets the display name of the cell.

Namespace:  Microsoft.SharePoint.WebPartPages.Communication
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")> _
Public Property FieldDisplayName As String
    Get
    Set
'Usage
Dim instance As CellConsumerInitEventArgs
Dim value As String

value = instance.FieldDisplayName

instance.FieldDisplayName = value

[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")]
public string FieldDisplayName { get; set; }

Property Value

Type: System.String
String Display name of the cell. This value is optional.

Examples

The following code example shows an overridden WebPart.PartCommunicationInit method that creates a CellConsumerInitEventArgs object, sets the FieldName and FieldDisplayName properties, and then fires the CellConsumerInit event. This code example is part of a larger example provided for the ICellConsumer interface.

' Step #10: Override the PartCommunicationInit() method.
' PartCommunicationInit() is called by the Web Part infrastructure 
' during the ASP.NET PreRender event to allow the part to pass 
' initialization information to the other connected parts.
' It is important to always pass initialization information as some 
' parts may not behave properly if this initialization information is 
' not received.
Public Overrides Sub PartCommunicationInit()
    ' Check if connected.
    If _connected Then
        ' Create the CellConsumerInitEventArgs structure for the 
        ' CellConsumerInit event.
        Dim cellConsumerInitArgs As New CellConsumerInitEventArgs()

        ' Set the FieldName and FieldDisplayName values.
        cellConsumerInitArgs.FieldName = _cellName
        cellConsumerInitArgs.FieldDisplayName = _cellDisplayName

        ' Fire the CellConsumerInit event.
        RaiseEvent CellConsumerInit(Me, cellConsumerInitArgs)
    End If
End Sub

// Step #10: Override the PartCommunicationInit() method.
// PartCommunicationInit() is called by the Web Part infrastructure 
// during the ASP.NET PreRender event to allow the part to pass 
// initialization information to the other connected parts.
// It is important to always pass initialization information as some 
// parts may not behave properly if this initialization information is
// not received.
public override void PartCommunicationInit()
{
    // Check if connected.
    if(_connected)
    {
        // If there is a listener, fire the CellConsumerInit event.
        if (CellConsumerInit != null)
        {
            // Create the CellConsumerInitEventArgs structure for the 
            // CellConsumerInit event.
            CellConsumerInitEventArgs cellConsumerInitArgs = 
                new CellConsumerInitEventArgs();
            
            // Set the FieldName and FieldDisplayName values.
            cellConsumerInitArgs.FieldName = _cellName;
            cellConsumerInitArgs.FieldDisplayName = _cellDisplayName;

            // Fire the CellConsumerInit event.
            CellConsumerInit(this, cellConsumerInitArgs);
        }
    }
}

See Also

Reference

CellConsumerInitEventArgs Class

CellConsumerInitEventArgs Members

Microsoft.SharePoint.WebPartPages.Communication Namespace