IFilterProvider.FilterConsumerInit - Méthode

Article
05/12/2015

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

Un gestionnaire d'événements pour l'événement FilterConsumerInit qui reçoit la liste des champs et éventuellement le champ des noms complets.

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

Syntaxe

'Déclaration
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")> _
Sub FilterConsumerInit ( _
    sender As Object, _
    filterConsumerInitEventArgs As FilterConsumerInitEventArgs _
)
'Utilisation
Dim instance As IFilterProvider
Dim sender As Object
Dim filterConsumerInitEventArgs As FilterConsumerInitEventArgs

instance.FilterConsumerInit(sender, filterConsumerInitEventArgs)

[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")]
void FilterConsumerInit(
    Object sender,
    FilterConsumerInitEventArgs filterConsumerInitEventArgs
)

Paramètres

sender
Type : System.Object

Référence à l'objet de l'appel de cette méthode, qui est généralement this.

filterConsumerInitEventArgs
Type : Microsoft.SharePoint.WebPartPages.Communication.FilterConsumerInitEventArgs

Un objet FilterConsumerInitEventArgs qui contient la liste de champs et les noms complets de champ facultatif envoyés au composant WebPart consommateur.

Exemples

L'exemple de code suivant illustre une implémentation de la FilterConsumerInit. Cet exemple de code fait partie d'un exemple plus développé fourni pour l'interface IFilterProvider .

      ' Step #8: Implement the FilterConsumerInit() method.
      ' The connected consumer part will call this method during its 
      ' PartCommunicationInit phase
      ' to pass initialization information to the provider Web Part.
      ' The column names from the
      ' consumer Web Part are passed in. In this example, these values 
      ' are used to dynamcially 
      ' generate the input text boxes in the provider Web Part.
      ' <param name="sender">Consumer Web Part</param>
      ' <param name="filterConsumerInitArgs">The args passed by the 
      ' Consumer</param>
      Public Sub FilterConsumerInit(sender As Object, 
         filterConsumerInitEventArgs As FilterConsumerInitEventArgs) 
            Implements IFilterProvider.FilterConsumerInit
         If Not (filterConsumerInitEventArgs.FieldList Is Nothing) Then
            _fieldList = filterConsumerInitEventArgs.FieldList
         Else
            _fieldList = Nothing
         End If 
         If Not (filterConsumerInitEventArgs.FieldDisplayList Is 
            Nothing) Then
            _fieldDisplayList = 
               filterConsumerInitEventArgs.FieldDisplayList
         Else
            _fieldDisplayList = Nothing
         End If 
      End Sub

// Step #8: Implement the FilterConsumerInit() method.
// The connected consumer part will call this method during its 
// PartCommunicationInit phase
// to pass initialization information to the provider Web Part. The 
// column names from the
// consumer Web Part are passed in. In this example, these values are 
// used to dynamcially 
// generate the input text boxes in the provider Web Part.
// <param name="sender">Consumer Web Part</param>
// <param name="filterConsumerInitArgs">The args passed by the 
// Consumer</param>

public void FilterConsumerInit(object sender, 
   FilterConsumerInitEventArgs filterConsumerInitEventArgs)
{
    if(filterConsumerInitEventArgs.FieldList != null)
        _fieldList = filterConsumerInitEventArgs.FieldList;
    else
        _fieldList = null;

    if(filterConsumerInitEventArgs.FieldDisplayList != null)
        _fieldDisplayList = 
           filterConsumerInitEventArgs.FieldDisplayList;
    else
        _fieldDisplayList = null;

}

Voir aussi

Référence

IFilterProvider interface

IFilterProvider - Membres

Microsoft.SharePoint.WebPartPages.Communication - Espace de noms

Partager via