ParametersOutReadyEventArgs - Classe

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

Fournit un tableau de valeurs de paramètre à l'événement ParametersOutReady de l'interface IParametersOutProvider .

Hiérarchie d’héritage

System.Object
  System.EventArgs
    Microsoft.SharePoint.WebPartPages.Communication.ParametersOutReadyEventArgs

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")> _
Public Class ParametersOutReadyEventArgs _
    Inherits EventArgs
'Utilisation
Dim instance As ParametersOutReadyEventArgs
[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")]
public class ParametersOutReadyEventArgs : EventArgs

Exemples

L'exemple de code suivant montre une méthode substituée WebPart.PartCommunicationMainqui crée une instance de la classe ParametersOutReadyEventArgs à envoyer lors de l'événement ParametersOutReady se produit. Cet exemple de code fait partie d'un exemple plus développé fourni pour l'interface IParametersOutProvider .

      ' Step #8: Override the PartCommunicationMain() method.
      ' The PartCommunicationMain method is called by the Web Part 
      ' infrastructure on the client during the ASP.NET PreRender
      ' event to allow the part to pass its primary data to the other 
      ' connected parts. It is important to always fire either the 
      ' ParametersOutReady or the NoParametersOut event. Some parts
      ' may not behave properly if they are left waiting for this 
      ' information. ParametersOutReady should be fired to send the 
      ' parameters. NoParametersOut should be fired to indicate that 
      ' there is no change in the parameters.
      Public Overrides Sub PartCommunicationMain()
         ' Ensure that all of the Web Part's controls are created.
         EnsureChildControls()
         
         ' Check if connected.
         If _connected Then
            ' If there is a listener, fire the ParametersOutReady 
            ' event.
            If Not (ParametersOutReady Is Nothing) Then
               ' Need to create the ParametersOutReadyEventArgs object 
               ' for the ParametersOutReady event.
               Dim parametersOutReadyEventArgs As New ParametersOutReadyEventArgs()
               
               If _parametersReadyButtonClicked Then 'ParametersOutReady Button was clicked
                  ' If there is a listener, fire the ParametersOutReady 
                  ' event.
                  If Not (ParametersOutReady Is Nothing) Then
                     ' Set the values to the values of the text
                     boxes.parametersOutReadyEventArgs.ParameterValues = New String(3) {}
                     parametersOutReadyEventArgs.ParameterValues(0) = _fontFamilyListBox.SelectedItem.Value
                     parametersOutReadyEventArgs.ParameterValues(1) = _fontColorListBox.SelectedItem.Value
                     parametersOutReadyEventArgs.ParameterValues(2) = _fontWeightListBox.SelectedItem.Value
                     parametersOutReadyEventArgs.ParameterValues(3) = _fontSizeListBox.SelectedItem.Value
                     
                     ' Fire the ParametersOutReady event.
                     RaiseEvent ParametersOutReady(Me, parametersOutReadyEventArgs)
                     
                     _parametersReadyButtonClicked = False
                  End If
               'The NoParametersOut button was clicked.
               ElseIf _noParametersOutButtonClicked Then
                  ' If there is a listener, fire the NoParametersOut 
                  ' event.
                  If Not (NoParametersOut Is Nothing) Then
                     ' Fire the event.
                     RaiseEvent NoParametersOut(Me, New EventArgs())
                     
                     _noParametersOutButtonClicked = False
                  End If
               ' The user didn't click any button.
               Else
                  ' If there is a listener, fire the NoParametersOut 
                  ' event.
                  If Not (NoParametersOut Is Nothing) Then
                     ' Fire the event.
                     RaiseEvent NoParametersOut(Me, New EventArgs())
                     
                     _noParametersOutButtonClicked = False
                  End If
               End If
            End If
         End If
      End Sub 'PartCommunicationMain
// Step #8: Override the PartCommunicationMain() method.
// The PartCommunicationMain method is called by the Web Part 
// infrastructure on the client during the ASP.NET PreRender
// phase to allow the part to pass its primary data to the other 
// connected parts.
// It is important to always fire either the ParametersOutReady or the 
// NoParametersOut event. Some parts
// may not behave properly if they are left waiting for this 
// information.
// ParametersOutReady should be fired to send the parameters.
// NoParametersOut should be fired to indicate that there is no change 
// in the parameters.public override void PartCommunicationMain()
{
    // Ensure that all of the Web Part's controls are created.
    EnsureChildControls();
    // Check if connected.
    if(_connected)
    {
        // If there is a listener, fire the ParametersOutReady event.
        if(ParametersOutReady != null)
        {
            // Need to create the ParametersOutReadyEventArgs object 
            // for the ParametersOutReady event.

            ParametersOutReadyEventArgs parametersOutReadyEventArgs = new ParametersOutReadyEventArgs();

            if(_parametersReadyButtonClicked) //ParametersOutReady Button was clicked
            {
                // If there is a listener, fire the ParametersOutReady 
                // event.
                if(ParametersOutReady != null)
                {
                    // Set the values to the values of the text
                    // boxes.
                    parametersOutReadyEventArgs.ParameterValues = new string[4];
                    parametersOutReadyEventArgs.ParameterValues[0] = _fontFamilyListBox.SelectedItem.Value;
                    parametersOutReadyEventArgs.ParameterValues[1] = _fontColorListBox.SelectedItem.Value;
                    parametersOutReadyEventArgs.ParameterValues[2] = _fontWeightListBox.SelectedItem.Value;
                    parametersOutReadyEventArgs.ParameterValues[3] = _fontSizeListBox.SelectedItem.Value;

                    // Fire the ParametersOutReady event.
                    ParametersOutReady(this, parametersOutReadyEventArgs);

                    _parametersReadyButtonClicked = false;
                }
            }
            //The NoParametersOut button was clicked.
            else if(_noParametersOutButtonClicked) 
            {
                // If there is a listener, fire the NoParametersOut 
                // event.
                if(NoParametersOut != null)
                {
                    // Fire the event.
                    NoParametersOut(this, new EventArgs());

                    _noParametersOutButtonClicked = false;
                }
            }
            // The user didn't click any button.
            else 
            {
                // If there is a listener, fire the NoParametersOut 
                // event.
                if(NoParametersOut != null)
                {
                    // Fire the event.
                    NoParametersOut(this, new EventArgs());

                    _noParametersOutButtonClicked = false;
                }
            }
        }
    }
}

Cohérence de thread

Tous les membres statique (Partagé dans Visual Basic)s publics de ce type sont thread-safe. Cela n’est pas garanti pour les membres d’instance.

Voir aussi

Référence

ParametersOutReadyEventArgs - Membres

Microsoft.SharePoint.WebPartPages.Communication - Espace de noms