de la propiedad ParameterInProperty.ParameterDisplayName

NOTA: esta API está ahora obsoleta.

Obtiene o establece el nombre para mostrar de un parámetro proporcionado por un elemento Web que implementa la interfaz de IParametersInConsumer cuando se produce el evento ParametersInConsumerInit .

Espacio de nombres:  Microsoft.SharePoint.WebPartPages.Communication
Ensamblado:  Microsoft.SharePoint (en Microsoft.SharePoint.dll)

Sintaxis

'Declaración
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")> _
Public Property ParameterDisplayName As String
    Get
    Set
'Uso
Dim instance As ParameterInProperty
Dim value As String

value = instance.ParameterDisplayName

instance.ParameterDisplayName = value

[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")]
public string ParameterDisplayName { get; set; }

Valor de propiedad

Tipo: System.String
El nombre para mostrar del parámetro. La propiedad ParameterDisplayName es un valor opcional para un parámetro.

Ejemplos

En el ejemplo de código siguiente se muestra un método invalidado WebPart.PartCommunicationInit que establece la propiedad ParameterDisplayName de una instancia de la clase ParameterInProperty . Este ejemplo de código forma parte de un ejemplo más extenso de la interfaz 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

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

Vea también

Referencia

clase ParameterInProperty

Miembros ParameterInProperty

Espacio de nombres Microsoft.SharePoint.WebPartPages.Communication