ParameterOutProperty.ParameterDisplayName property
NOTE: This API is now obsolete.
Gets or sets the display name of a parameter provided by a Web Part that implements the IParametersOutProvider interface when the ParametersOutProviderInit 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 ParameterDisplayName As String
Get
Set
'Usage
Dim instance As ParameterOutProperty
Dim value As String
value = instance.ParameterDisplayName
instance.ParameterDisplayName = value
[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")]
public string ParameterDisplayName { get; set; }
Property value
Type: System.String
The display name of the parameter. The ParameterDisplayName property is an optional value for a parameter.
Examples
The following code example shows an overridden WebPart.PartCommunicationInitmethod that sets the ParameterDisplayName property of multiple instances of the ParameterOutProperty class. 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
// 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 that all of the Web Part's controls are created.
EnsureChildControls();
// Check if connected.
if(_connected)
{
// If there is a listener, send init 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);
}
}
}