IParametersInConsumer.ParametersInReady - Méthode

Article
05/12/2015

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

Fournit un gestionnaire d'événements pour l'événement ParametersInReady d'un WebPart fournisseur qui implémente l'interface IParametersInProvider .

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 ParametersInReady ( _
    sender As Object, _
    parametersInReadyEventArgs As ParametersInReadyEventArgs _
)
'Utilisation
Dim instance As IParametersInConsumer
Dim sender As Object
Dim parametersInReadyEventArgs As ParametersInReadyEventArgs

instance.ParametersInReady(sender, parametersInReadyEventArgs)

[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")]
void ParametersInReady(
    Object sender,
    ParametersInReadyEventArgs parametersInReadyEventArgs
)

Paramètres

sender
Type : System.Object

Un composant WebPart qui implémente l'interface IParametersInProvider .

parametersInReadyEventArgs
Type : Microsoft.SharePoint.WebPartPages.Communication.ParametersInReadyEventArgs

ParametersInReadyEventArgs qui fournit un tableau de chaînes de valeurs de paramètre par le biais de sa propriété ParameterValues . Le nombre et l'ordre des paramètres contenus dans ce tableau doivent correspondre à ceux spécifiés par l'argument ParametersInConsumerInitEventArgs de la méthode ParametersInConsumerInit .

Exemples

L'exemple de code suivant illustre l'implémentation d'un gestionnaire d'événements ParametersInReady . Cet exemple de code fait partie d'un exemple plus développé fourni pour l'interface IParametersInConsumer .

' Step #8: Implement the ParametersInReady event handler.
' The connected provider part may call this method during its 
' PartCommunicationMain phase
' to pass its primary data to the consumer Web Part.
' <param name="sender">Provider Web Part</param>
' <param name="parametersInReadyEventArgs">The args passed by the 
' Provider</param>
Public Sub ParametersInReady(sender As Object, parametersInReadyEventArgs As ParametersInReadyEventArgs) _
      Implements IParametersInConsumer.ParametersInReady
   _parametersInReadyFlag = True
   
   ' Set the text box values to the values of the parameters.
   If Not (parametersInReadyEventArgs.ParameterValues Is Nothing) Then
      _fontFamily = parametersInReadyEventArgs.ParameterValues(0)
      _fontColor = parametersInReadyEventArgs.ParameterValues(1)
      _fontWeight = parametersInReadyEventArgs.ParameterValues(2)
      _fontSize = parametersInReadyEventArgs.ParameterValues(3)
           
      ' Store font attributes in a State Bag for use by the NoParametersIn event handler.
      ViewState("FontFamily") = _fontFamily
      ViewState("FontColor") = _fontColor
      ViewState("FontWeight") = _fontWeight
      ViewState("FontSize") = _fontSize
   End If
End Sub

// Step #8: Implement the ParametersInReady event handler.
// The connected provider part may call this method during its 
// PartCommunicationMain phase
// to pass its primary data to the consumer Web Part.
// <param name="sender">Provider Web Part</param>
// <param name="parametersInReadyEventArgs">The args passed by the 
// Provider</param>
public void ParametersInReady(object sender, ParametersInReadyEventArgs parametersInReadyEventArgs)
{
    _parametersInReadyFlag = true;

    // Set the text box values to the values of the Parameters.
    if(parametersInReadyEventArgs.ParameterValues != null)
    {
        _fontFamily = parametersInReadyEventArgs.ParameterValues[0];
        _fontColor = parametersInReadyEventArgs.ParameterValues[1];
        _fontWeight = parametersInReadyEventArgs.ParameterValues[2];
        _fontSize = parametersInReadyEventArgs.ParameterValues[3];

        // Store font attributes in a State Bag for use by the 
        // NoParametersIn event handler.
        ViewState["FontFamily"] = _fontFamily;
        ViewState["FontColor"] = _fontColor;
        ViewState["FontWeight"] = _fontWeight;
        ViewState["FontSize"] = _fontSize;
    }
}

Voir aussi

Référence

IParametersInConsumer interface

IParametersInConsumer - Membres

Microsoft.SharePoint.WebPartPages.Communication - Espace de noms

Partager via