Share via


ParameterOutProperty class

NOTE: This API is now obsolete.

Provides descriptive information about a parameter in a parameter list to the ParametersOutProviderInit event of the IParametersOutProvider interface.

Inheritance hierarchy

System.Object
  Microsoft.SharePoint.WebPartPages.Communication.ParameterOutProperty

Namespace:  Microsoft.SharePoint.WebPartPages.Communication
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")> _
Public NotInheritable Class ParameterOutProperty
'Usage
Dim instance As ParameterOutProperty
[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")]
public sealed class ParameterOutProperty

Examples

The following code example shows an overridden PartCommunicationInit method that creates an instance of the ParameterOutProperty class to define the parameters that will be passed in the ParametersOutProviderInitEventArgs object when the ParametersOutProviderInit event occurs. This code example is part of a larger example provided for the IParametersOutProvider interface.

      ' Step #7: Override the PartCommunicationInit method.
      ' The PartCommunicationInit method is called by the Web Part infrastructure during the ASP.Net PreRender 
      ' phase to allow the part to pass initialization information to the other connected parts.
      ' It is important to always pass initialization information. Some parts
      ' may not behave properly if this initialization information is not received. 
      Public Overrides Sub PartCommunicationInit()
            ' Ensure that all of the Web Part's controls are created.
            EnsureChildControls()

            ' Check if connected.
            If _connected Then
                ' Need to create the ParametersOutProviderInitEventArgs object for the ParametersOutProviderInit event.
                Dim parametersOutProviderInitInitEventArgs As New ParametersOutProviderInitEventArgs()

                ' Set the ParameterOutProperties.
                parametersOutProviderInitInitEventArgs.ParameterOutProperties = New ParameterOutProperty(3) {}

                ' There are 4 parameters types that will be passed: Font Family, Color, Weight, and Size.
                parametersOutProviderInitInitEventArgs.ParameterOutProperties(0) = New ParameterOutProperty()
                parametersOutProviderInitInitEventArgs.ParameterOutProperties(0).Description = _fontFamilyParamDescription
                parametersOutProviderInitInitEventArgs.ParameterOutProperties(0).ParameterDisplayName = _fontFamilyParamDisplayName
                parametersOutProviderInitInitEventArgs.ParameterOutProperties(0).ParameterName = _fontFamilyParamName

                parametersOutProviderInitInitEventArgs.ParameterOutProperties(1) = New ParameterOutProperty()
                parametersOutProviderInitInitEventArgs.ParameterOutProperties(1).Description = _fontColorParamDescription
                parametersOutProviderInitInitEventArgs.ParameterOutProperties(1).ParameterDisplayName = _fontColorParamDisplayName
                parametersOutProviderInitInitEventArgs.ParameterOutProperties(1).ParameterName = _fontColorParamName

                parametersOutProviderInitInitEventArgs.ParameterOutProperties(2) = New ParameterOutProperty()
                parametersOutProviderInitInitEventArgs.ParameterOutProperties(2).Description = _fontWeightParamDescription
                parametersOutProviderInitInitEventArgs.ParameterOutProperties(2).ParameterDisplayName = _fontWeightParamDisplayName
                parametersOutProviderInitInitEventArgs.ParameterOutProperties(2).ParameterName = _fontWeightParamName

                parametersOutProviderInitInitEventArgs.ParameterOutProperties(3) = New ParameterOutProperty()
                parametersOutProviderInitInitEventArgs.ParameterOutProperties(3).Description = _fontSizeParamDescription
                parametersOutProviderInitInitEventArgs.ParameterOutProperties(3).ParameterDisplayName = _fontSizeParamDisplayName
                parametersOutProviderInitInitEventArgs.ParameterOutProperties(3).ParameterName = _fontSizeParamName

                ' Fire the ParametersOutProviderInit event.
                RaiseEvent ParametersOutProviderInit(Me, parametersOutProviderInitInitEventArgs)
            End If
        End Sub
public override void PartCommunicationInit()
{
    // Ensure that all of the Web Part's controls are created.
    EnsureChildControls();

    // Check if connected.
    if(_connected)
    {
        // If there is a listener, fire the ParametersOutProviderInit event.
        if (ParametersOutProviderInit != null)
        {
            // Need to create the ParametersOutProviderInitEventArgs object for the ParametersOutProviderInit event.
            ParametersOutProviderInitEventArgs parametersOutProviderInitInitEventArgs = new ParametersOutProviderInitEventArgs();
            
            // Set the ParameterOutProperties.
            parametersOutProviderInitInitEventArgs.ParameterOutProperties = new ParameterOutProperty[4];

            // There are 4 parameters types that will be passed: Font Family, Color, Weight, and Size.
            parametersOutProviderInitInitEventArgs.ParameterOutProperties[0] = new ParameterOutProperty();
            parametersOutProviderInitInitEventArgs.ParameterOutProperties[0].Description = _fontFamilyParamDescription;
            parametersOutProviderInitInitEventArgs.ParameterOutProperties[0].ParameterDisplayName = _fontFamilyParamDisplayName;
            parametersOutProviderInitInitEventArgs.ParameterOutProperties[0].ParameterName = _fontFamilyParamName;

            parametersOutProviderInitInitEventArgs.ParameterOutProperties[1] = new ParameterOutProperty();
            parametersOutProviderInitInitEventArgs.ParameterOutProperties[1].Description = _fontColorParamDescription;
            parametersOutProviderInitInitEventArgs.ParameterOutProperties[1].ParameterDisplayName = _fontColorParamDisplayName;
            parametersOutProviderInitInitEventArgs.ParameterOutProperties[1].ParameterName = _fontColorParamName;

            parametersOutProviderInitInitEventArgs.ParameterOutProperties[2] = new ParameterOutProperty();
            parametersOutProviderInitInitEventArgs.ParameterOutProperties[2].Description = _fontWeightParamDescription;
            parametersOutProviderInitInitEventArgs.ParameterOutProperties[2].ParameterDisplayName = _fontWeightParamDisplayName;
            parametersOutProviderInitInitEventArgs.ParameterOutProperties[2].ParameterName = _fontWeightParamName;

            parametersOutProviderInitInitEventArgs.ParameterOutProperties[3] = new ParameterOutProperty();
            parametersOutProviderInitInitEventArgs.ParameterOutProperties[3].Description = _fontSizeParamDescription;
            parametersOutProviderInitInitEventArgs.ParameterOutProperties[3].ParameterDisplayName = _fontSizeParamDisplayName;
            parametersOutProviderInitInitEventArgs.ParameterOutProperties[3].ParameterName = _fontSizeParamName;

            // Fire the ParametersOutProviderInit event.
            ParametersOutProviderInit(this, parametersOutProviderInitInitEventArgs);
        }
    }
}

Thread safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See also

Reference

ParameterOutProperty members

Microsoft.SharePoint.WebPartPages.Communication namespace