ParametersOutProviderInitEventArgs.ParameterOutProperties property

NOTE: This API is now obsolete.

取得或設定 Web 組件實作IParametersOutProvider介面， ParametersOutProviderInit事件發生時所提供的參數陣列的屬性值。

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

Syntax

'宣告
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")> _
Public Property ParameterOutProperties As ParameterOutProperty()
    Get
    Set
'用途
Dim instance As ParametersOutProviderInitEventArgs
Dim value As ParameterOutProperty()

value = instance.ParameterOutProperties

instance.ParameterOutProperties = value

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

Property value

Type: []
指定參數值的型別ParameterOutProperty的陣列。

備註

ParameterOutProperties屬性提供ParameterOutProperty物件的陣列，其中每一個對應的參數。數字，表示此陣列中的參數順序必須符合在ParametersOutReady事件的ParametersInReadyEventArgs引數中指定。

Examples

下列程式碼範例顯示使用ParametersOutProperties屬性來設定陣列的ParametersOutProviderInitEventArgs類別的執行個體的值覆寫的PartCommunicationInit方法。這個程式碼範例是提供IParametersOutProvider介面的完整範例的一部分。

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

' 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 Overrides Sub PartCommunicationInit()
    ' Ensure that all of the Web Part's controls are created.
    EnsureChildControls()

    ' Check if connected.
    If _connected Then
        ' If there is a listener, send init event.
        If ParametersOutProviderInit IsNot Nothing 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 If
End Sub

請參閱

參照

ParametersOutProviderInitEventArgs class

ParametersOutProviderInitEventArgs members

Microsoft.SharePoint.WebPartPages.Communication namespace