IFilterConsumer.ClearFilter - Méthode

Article
05/12/2015

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

Permet de répondre à une demande pour supprimer un filtre à partir d'un événement ClearFilter d'un composant WebPart fournisseur.

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 ClearFilter ( _
    sender As Object, _
    e As EventArgs _
)
'Utilisation
Dim instance As IFilterConsumer
Dim sender As Object
Dim e As EventArgs

instance.ClearFilter(sender, e)

[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")]
void ClearFilter(
    Object sender,
    EventArgs e
)

Paramètres

sender
Type : System.Object

Référence à l'objet qui implémente l'interface sur le composant WebPart fournisseur.

e
Type : System.EventArgs

Les arguments d'événement qui sont passés à partir de l'événement ClearFilter . Il s'agit d'un objet NULL.

Exemples

L'exemple de code suivant illustre une implémentation de la méthode PartCommunicationMain qui déclenche l'événement ClearFilter . Cet exemple de code fait partie d'un exemple plus développé fourni pour l'interface IFilterConsumer .

' Step #10: Implement ClearFilter event handler.
' The connected provider part will call this method during its 
' PartCommunicationMain phase to remove the filter on the 
' consumer Web Part.
' <param name="sender">Provider Web Part</param>
' <param name="eventArgs">The Event Arguments</param>
Public Sub ClearFilter(sender As Object, eventArgs As EventArgs) Implements IFilterConsumer.ClearFilter
   ' Ensure that all of the Web Part's controls are created.
   EnsureChildControls()
         
   ' Clear the filter on the DataTable.
   _rowFilterExpression = String.Empty
         
   ' Clear out the cached row filter expression.
   _cachedRowFilter.Text = String.Empty
End Sub

// Step #10: Implement ClearFilter event handler.
// The connected provider part will call this method during its 
// PartCommunicationMain phase
// to remove the filter on the consumer Web Part.
// <param name="sender">Provider Web Part</param>
// <param name="eventArgs">The Event Arguments</param>

public void ClearFilter(object sender, EventArgs eventArgs)
{
    // Ensure that all of the Web Part's controls are created.
    EnsureChildControls();

    // Clear the filter on the DataTable.
    _rowFilterExpression = string.Empty;

    // Clear out the cached row filter expression.
    _cachedRowFilter.Text = string.Empty;
}

Voir aussi

Référence

IFilterConsumer interface

IFilterConsumer - Membres

Microsoft.SharePoint.WebPartPages.Communication - Espace de noms

Share via