CellProviderInitEventArgs.FieldDisplayName - Propriété

Remarque : cette API est désormais obsolète.

Obtient ou définit le nom complet de la cellule.

Espace de noms :  Microsoft.SharePoint.WebPartPages.Communication
Assembly :  Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")> _
Public Property FieldDisplayName As String
    Get
    Set
'Utilisation
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; }

Valeur de propriété

Type : System.String
Le champ nom complet de la valeur de la cellule pour le composant WebPart ICellConsumer . Cette valeur est facultative.

Exemples

L'exemple de code suivant montre une méthode substituée PartCommunicationInit qui crée une structure de données CellProviderInitEventArgs pour contenir les valeurs des propriétés FieldName et FieldDisplayName , définit les valeurs de propriété, puis déclenche l'événement CellProviderInit . Cet exemple de code fait partie d'un exemple plus développé fourni pour l'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);
                }
            }
        }

Voir aussi

Référence

CellProviderInitEventArgs classe

CellProviderInitEventArgs - Membres

Microsoft.SharePoint.WebPartPages.Communication - Espace de noms