ParametersInConsumerInit Event
The ParametersInConsumerInit event of the IParametersInConsumer interface allows the consumer Web Part to pass initialization information about the parameters it is expecting to the other connected parts.
Event Data
The event handler receives an argument of type ParametersInConsumerInitEventArgs containing data related to this event. The ParametersInConsumerInitEventArgs object contains an array of ParameterInProperty objects with the following properties.
| Property | Description |
|---|---|
| ParameterName | The name of a specific parameter, such as BackgroundColor. This should be unique. |
| ParameterDisplayName | The display name for the parameter. This is an optional value. |
| Required | A value indicating whether the parameter is required or not. This value will be either true or false. If false (meaning optional) is specified, and no mapping is specified by the user in the transformer, then an empty string is passed to the consumer part. |
| Description | An explanation of the parameter. |
Example
The following code example shows an overridden PartCommunicationInit method that fires the ParametersInConsumerInit event. This code example is part of a larger example provided for the IParametersInConsumer interface.
Requirements
Platforms: Microsoft Windows Server 2003
Security: Code Access Security