ICellProvider.CellConsumerInit - Méthode

Article
05/12/2015

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

Un gestionnaire d'événements pour recevoir des informations d'initialisation passées par l'événement CellConsumerInit d'un composant WebPart connecté qui implémente l'interface ICellConsumer . Le délégué de ce gestionnaire d'événements est CellConsumerInitEventHandler.

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")> _
Sub CellConsumerInit ( _
    sender As Object, _
    cellConsumerInitEventArgs As CellConsumerInitEventArgs _
)
'Utilisation
Dim instance As ICellProvider
Dim sender As Object
Dim cellConsumerInitEventArgs As CellConsumerInitEventArgs

instance.CellConsumerInit(sender, cellConsumerInitEventArgs)

[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")]
void CellConsumerInit(
    Object sender,
    CellConsumerInitEventArgs cellConsumerInitEventArgs
)

Paramètres

sender
Type : System.Object

Une référence au composant WebPart consommateur.

cellConsumerInitEventArgs
Type : Microsoft.SharePoint.WebPartPages.Communication.CellConsumerInitEventArgs

La structure de données d'argument passée par le composant WebPart consommateur.

Exemples

L'exemple de code suivant illustre l'implémentation d'une méthode CellConsumerInit pour recevoir le nom complet du champ envoyé par un ICellConsumer WebPart. Cet exemple de code fait partie d'un exemple plus développé fourni pour l'interface ICellProvider .

Étant donné que cet exemple utilise la classe SPEncode , il requiert une directive using (Imports dans Visual Basic) pour l'espace de noms Microsoft.SharePoint.Utilities .

      ' Step #8: Implement the CellConsumerInit event handler.
      ' The connected consumer part(s) will call this method during its 
      ' PartCommunicationInit phase
      ' to pass initialization information to this provider Web Part.
      ' <param name="sender">Reference to the Consumer Web Part</param>
      ' <param name="cellConsumerInitEventArgs">The argument data 
      ' structure passed by the Consumer Web Part</param>
      Public Sub CellConsumerInit(sender As Object, 
         cellConsumerInitEventArgs As CellConsumerInitEventArgs) 
         Implements ICellProvider.CellConsumerInit
         'Encode and store the field display name.
         _connectedField = SPEncode.HtmlEncode(cellConsumerInitEventArgs.FieldDisplayName)
      End Sub

        // Step #8: Implement the CellConsumerInit event handler.
        // The connected consumer part(s) will call this method during 
        // its PartCommunicationInit phase
        // to pass initialization information to this provider Web 
        // Part.
        // <param name="sender">Reference to the consumer Web 
        // Part</param>
        // <param name="cellConsumerInitEventArgs">The argument data 
        // structure passed by the consumer Web Part</param>
        public void CellConsumerInit(object sender, 
           CellConsumerInitEventArgs cellConsumerInitEventArgs)
        {
            //Encode and store the field display name.
            _connectedField = SPEncode.HtmlEncode(cellConsumerInitEventArgs.FieldDisplayName);

        }

Voir aussi

Référence

ICellProvider interface

ICellProvider - Membres

Microsoft.SharePoint.WebPartPages.Communication - Espace de noms

Share via