ParametersInReadyEventArgs.ParameterValues - Propriété

Article
05/12/2015

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

Obtient ou définit les valeurs de paramètre fournies par un composant qui implémente l'interface IParametersInProvider lorsque l'événement ParametersInReady se produit

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 Property ParameterValues As String()
    Get
    Set
'Utilisation
Dim instance As ParametersInReadyEventArgs
Dim value As String()

value = instance.ParameterValues

instance.ParameterValues = value

[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")]
public string[] ParameterValues { get; set; }

Valeur de propriété

Type : []
Un tableau de valeurs de paramètre.

Remarques

La propriété ParameterValues est un tableau unidimensionnel de chaînes où chaque chaîne est la valeur d'un paramètre. Le nombre et l'ordre des paramètres contenus dans ce tableau doivent correspondre à ceux spécifiés dans l'argument ParametersInConsumerInitEventArgs de l'événement ParametersInConsumerInit .

Exemples

L'exemple de code suivant illustre l'implémentation d'un gestionnaire d'événements ParametersInReady qui utilise la propriété ParameterValues pour obtenir les valeurs à partir d'une instance de la classe ParametersInReadyEventArgs provenance d'un composant WebPart fournisseur. 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 'ParametersInReady

//  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

ParametersInReadyEventArgs classe

ParametersInReadyEventArgs - Membres

Microsoft.SharePoint.WebPartPages.Communication - Espace de noms

Partager via