ParametersOutReadyEventArgs.ParameterValues property
NOTE: This API is now obsolete.
Gets or sets the parameter values provided by a Web Part that implements the IParametersOutProvider interface when the ParametersOutReady event occurs
Namespace: Microsoft.SharePoint.WebPartPages.Communication
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaration
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")> _
Public Property ParameterValues As String()
Get
Set
'Usage
Dim instance As ParametersOutReadyEventArgs
Dim value As String()
value = instance.ParameterValues
instance.ParameterValues = value
[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")]
public string[] ParameterValues { get; set; }
Property value
Type: []
An array of parameter values.
Remarks
The ParameterValues property is a one-dimensional array of strings where each string is the value of a parameter. The number and order of parameters contained in this array must match those specified in the ParametersOutProviderInitEventArgs argument of the ParametersOutProviderInit event.
Examples
The following code example shows an overridden PartCommuncationMain method that uses the ParameterValues property to set the parameter values of an instance of the ParametersOutReadyEventArgs class. This code example is part of a larger example provided for the IParametersOutProvider interface.
' 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
// 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 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;
}
}
}
}
}
See also
Reference
ParametersOutReadyEventArgs class