ParametersInConsumerInitEventArgs class

NOTE: This API is now obsolete.

提供的參數陣列的IParametersInConsumer介面的ParametersInConsumerInit初始化事件的屬性值。

Inheritance hierarchy

System.Object
  System.EventArgs
    Microsoft.SharePoint.WebPartPages.Communication.InitEventArgs
      Microsoft.SharePoint.WebPartPages.Communication.ParametersInConsumerInitEventArgs

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

Syntax

'宣告
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")> _
Public NotInheritable Class ParametersInConsumerInitEventArgs _
    Inherits InitEventArgs
'用途
Dim instance As ParametersInConsumerInitEventArgs

[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")]
public sealed class ParametersInConsumerInitEventArgs : InitEventArgs

Examples

下列程式碼範例顯示建立 ParametersInConsumerInit 事件發生時傳送 ParametersInConsumerInitEventArgs 類別的執行個體已覆寫的 PartCommunicationInit 方法。這個程式碼範例是提供IParametersInConsumer介面的完整範例的一部分。

      ' 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 all controls have been created.
         EnsureChildControls()
         
         ' Check if connected.
         If _connected Then
               'Need to create the args for the ParametersInConsumerInit event
               Dim parametersInConsumerInitEventArgs As New ParametersInConsumerInitEventArgs()
               
               'Set the ParameterInProperties
               parametersInConsumerInitEventArgs.ParameterInProperties = New ParameterInProperty(3) {}
               
               parametersInConsumerInitEventArgs.ParameterInProperties(0) = New ParameterInProperty()
               parametersInConsumerInitEventArgs.ParameterInProperties(0).Description = _fontFamilyParamDescription
               parametersInConsumerInitEventArgs.ParameterInProperties(0).ParameterDisplayName = _fontFamilyParamDisplayName
               parametersInConsumerInitEventArgs.ParameterInProperties(0).ParameterName = _fontFamilyParamName
               parametersInConsumerInitEventArgs.ParameterInProperties(0).Required = True
               
               parametersInConsumerInitEventArgs.ParameterInProperties(1) = New ParameterInProperty()
               parametersInConsumerInitEventArgs.ParameterInProperties(1).Description = _fontColorParamDescription
               parametersInConsumerInitEventArgs.ParameterInProperties(1).ParameterDisplayName = _fontColorParamDisplayName
               parametersInConsumerInitEventArgs.ParameterInProperties(1).ParameterName = _fontColorParamName
               parametersInConsumerInitEventArgs.ParameterInProperties(1).Required = False
               
               parametersInConsumerInitEventArgs.ParameterInProperties(2) = New ParameterInProperty()
               parametersInConsumerInitEventArgs.ParameterInProperties(2).Description = _fontWeightParamDescription
               parametersInConsumerInitEventArgs.ParameterInProperties(2).ParameterDisplayName = _fontWeightParamDisplayName
               parametersInConsumerInitEventArgs.ParameterInProperties(2).ParameterName = _fontWeightParamName
               parametersInConsumerInitEventArgs.ParameterInProperties(2).Required = True
               
               parametersInConsumerInitEventArgs.ParameterInProperties(3) = New ParameterInProperty()
               parametersInConsumerInitEventArgs.ParameterInProperties(3).Description = _fontSizeParamDescription
               parametersInConsumerInitEventArgs.ParameterInProperties(3).ParameterDisplayName = _fontSizeParamDisplayName
               parametersInConsumerInitEventArgs.ParameterInProperties(3).ParameterName = _fontSizeParamName
               parametersInConsumerInitEventArgs.ParameterInProperties(3).Required = False
               
               ' Fire the ParametersInConsumerInit event.
               RaiseEvent ParametersInConsumerInit(Me, parametersInConsumerInitEventArgs)
         End If
      End Sub 'PartCommunicationInit

// Step #7: Override the PartCommunicationInit method.
// The PartCommunicationInit method is called by the Web Part infrastructure during the ASP.NET PreRender 
// event 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 all controls have been created.
    EnsureChildControls();

    // Check if connected.
    if(_connected)
    {
       
            // Need to create the ParametersInConsumerInitEventArgs object for the ParametersInConsumerInit event.
            ParametersInConsumerInitEventArgs parametersInConsumerInitEventArgs = new ParametersInConsumerInitEventArgs();
            
            // Set the ParameterInProperties.
            parametersInConsumerInitEventArgs.ParameterInProperties = new ParameterInProperty[4];

            parametersInConsumerInitEventArgs.ParameterInProperties[0] = new ParameterInProperty();
            parametersInConsumerInitEventArgs.ParameterInProperties[0].Description = _fontFamilyParamDescription;
            parametersInConsumerInitEventArgs.ParameterInProperties[0].ParameterDisplayName = _fontFamilyParamDisplayName;
            parametersInConsumerInitEventArgs.ParameterInProperties[0].ParameterName = _fontFamilyParamName;
            parametersInConsumerInitEventArgs.ParameterInProperties[0].Required = true;

            parametersInConsumerInitEventArgs.ParameterInProperties[1] = new ParameterInProperty();
            parametersInConsumerInitEventArgs.ParameterInProperties[1].Description = _fontColorParamDescription;
            parametersInConsumerInitEventArgs.ParameterInProperties[1].ParameterDisplayName = _fontColorParamDisplayName;
            parametersInConsumerInitEventArgs.ParameterInProperties[1].ParameterName = _fontColorParamName;
            parametersInConsumerInitEventArgs.ParameterInProperties[1].Required = false;

            parametersInConsumerInitEventArgs.ParameterInProperties[2] = new ParameterInProperty();
            parametersInConsumerInitEventArgs.ParameterInProperties[2].Description = _fontWeightParamDescription;
            parametersInConsumerInitEventArgs.ParameterInProperties[2].ParameterDisplayName = _fontWeightParamDisplayName;
            parametersInConsumerInitEventArgs.ParameterInProperties[2].ParameterName = _fontWeightParamName;
            parametersInConsumerInitEventArgs.ParameterInProperties[2].Required = true;

            parametersInConsumerInitEventArgs.ParameterInProperties[3] = new ParameterInProperty();
            parametersInConsumerInitEventArgs.ParameterInProperties[3].Description = _fontSizeParamDescription;
            parametersInConsumerInitEventArgs.ParameterInProperties[3].ParameterDisplayName = _fontSizeParamDisplayName;
            parametersInConsumerInitEventArgs.ParameterInProperties[3].ParameterName = _fontSizeParamName;
            parametersInConsumerInitEventArgs.ParameterInProperties[3].Required = false;

            // Fire the ParametersInConsumerInit event.
            ParametersInConsumerInit(this, parametersInConsumerInitEventArgs);
       
    }
}

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.

請參閱

參照

ParametersInConsumerInitEventArgs members

Microsoft.SharePoint.WebPartPages.Communication namespace