ParameterOutProperty.ParameterDisplayName 属性

请注意：此 API 现在已过时。

获取或设置参数提供的ParametersOutProviderInit事件发生时实现IParametersOutProvider接口的 Web 部件的显示名称。

命名空间：  Microsoft.SharePoint.WebPartPages.Communication
程序集：  Microsoft.SharePoint（位于 Microsoft.SharePoint.dll 中）

语法

声明
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")> _
Public Property ParameterDisplayName As String
    Get
    Set
用法
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; }

属性值

类型：System.String
参数的显示名称。ParameterDisplayName属性是可选参数的值。

示例

下面的代码示例演示ParameterOutProperty类的多个实例的ParameterDisplayName属性设置重写的WebPart.PartCommunicationInit方法。此代码示例是示例的一个更大提供的IParametersOutProvider接口的一部分。

      ' 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);
        }
    }
}

另请参阅

引用

ParameterOutProperty 类

ParameterOutProperty 成员

Microsoft.SharePoint.WebPartPages.Communication 命名空间