Share via


CellProviderInitEventArgs.FieldDisplayName property

NOTE: This API is now obsolete.

Obtém ou define o nome para exibição da célula.

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

Syntax

'Declaração
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")> _
Public Property FieldDisplayName As String
    Get
    Set
'Uso
Dim instance As CellProviderInitEventArgs
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
O campo nome do valor da célula fornecido para a ICellConsumer Web Part para exibição. Esse valor é opcional.

Examples

O exemplo de código a seguir mostra um método substituído PartCommunicationInit que cria uma estrutura de dados para conter os valores das propriedades FieldName e FieldDisplayNameCellProviderInitEventArgs , define os valores de propriedade e dispara o evento CellProviderInit . Este exemplo de código é parte de um exemplo maior fornecido para a interface ICellProvider .

      ' Step #9: 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 InitEventArgs structure for the 
           ' CellProviderInit event.
            Dim cellProviderInitArgs As New CellProviderInitEventArgs()

            ' Set the FieldName and FieldDisplay values.
             cellProviderInitArgs.FieldName = _cellName
             cellProviderInitArgs.FieldDisplayName = _cellDisplayName

            ' Fire the CellProviderInit event. 
            RaiseEvent CellProviderInit(Me, cellProviderInitArgs)

          End If
      End Sub
        // Step #9: 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 CellProviderInit 
                // event.
                if (CellProviderInit != null)
                {
                    // Create the InitEventArgs structure for the 
                    // CellProviderInit event.
                    CellProviderInitEventArgs cellProviderInitArgs = new CellProviderInitEventArgs();
                    
                    // Set the FieldName and FieldDisplay values.
                    cellProviderInitArgs.FieldName = _cellName;
                    cellProviderInitArgs.FieldDisplayName = _cellDisplayName;
                    
                    // Fire the CellProviderInit event.
                    CellProviderInit(this, cellProviderInitArgs);
                }
            }
        }

Ver também

Referência

CellProviderInitEventArgs class

CellProviderInitEventArgs members

Microsoft.SharePoint.WebPartPages.Communication namespace