Export (0) Print
Expand All

IParametersOutProvider.ParametersOutProviderInit event

NOTE: This API is now obsolete.

Allows the provider Web Part to pass initialization information about the parameters it is providing to the other connected parts.

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

[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")]
event ParametersOutProviderInitEventHandler ParametersOutProviderInit

The following code example shows an overridden WebPart.PartCommunicationInit method that fires the ParametersOutProviderInitevent. 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 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);
                }
            }
        }

Community Additions

ADD
Show:
© 2014 Microsoft