ParameterInProperty.Required 属性
请注意：此 API 现在已过时。
获取或设置由ParametersInConsumerInit事件发生时实现IParametersInConsumer接口WebPart 提供的参数所需的状态。
命名空间： Microsoft.SharePoint.WebPartPages.Communication
程序集： Microsoft.SharePoint（位于 Microsoft.SharePoint.dll 中）
语法
声明
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")> _
Public Property Required As Boolean
Get
Set
用法
Dim instance As ParameterInProperty
Dim value As Boolean
value = instance.Required
instance.Required = value
[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")]
public bool Required { get; set; }
属性值
类型：System.Boolean
true如果该参数是必需的 ；否则为false。
备注
Required属性指示参数是否是必需的。如果指定了false ，指出参数是可选的并且没有映射指定用户，然后为空字符串作为传递可选参数的值使用者 Web 部件。
示例
下面的代码示例演示ParameterInProperty类的实例的Required属性设置重写的WebPart.PartCommunicationInit方法。此代码示例是示例的一个更大提供的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 'PartCommunicationInit
// 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);
}
}