ParameterInProperty.Required - Propriété

Remarque : cette API est désormais obsolète.

Obtient ou définit l'état d'un paramètre fourni par un WebPart qui implémente l'interface IParametersInConsumer lorsque se produit l'événementde ParametersInConsumerInitobligatoire.

Espace de noms :  Microsoft.SharePoint.WebPartPages.Communication
Assembly :  Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartParameters instead")> _
Public Property Required As Boolean
    Get
    Set
'Utilisation
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; }

Valeur de propriété

Type : System.Boolean
true si le paramètre est obligatoire ; dans le cas contraire, false.

Remarques

La propriété Required indique si un paramètre est nécessaire ou non. Si false est spécifié, indiquant que le paramètre est facultatif et aucun mappage n'est spécifié par l'utilisateur, puis une chaîne vide est passée comme valeur pour le paramètre facultatif pour le composant WebPart consommateur.

Exemples

L'exemple de code suivant montre une méthode substituée WebPart.PartCommunicationInitqui définit la propriété Required d'une instance de la classe ParameterInProperty . Cet exemple de code fait partie d'un exemple plus développé fourni pour l'interface 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);
       
    }
}

Voir aussi

Référence

ParameterInProperty classe

ParameterInProperty - Membres

Microsoft.SharePoint.WebPartPages.Communication - Espace de noms