SPFeatureCollection.Add - Méthode (Guid, Boolean, SPFeatureDefinitionScope)
Active une fonctionnalité à l'aide de la définition de fonctionnalité avec l'ID spécifié au niveau de la portée spécifiée pour créer un nouvel objet SPFeature et puis l'ajouter à la collection, en forçant éventuellement l'activation même s'il existe des erreurs.
Espace de noms : Microsoft.SharePoint
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)
Syntaxe
'Déclaration
Public Function Add ( _
featureId As Guid, _
force As Boolean, _
featdefScope As SPFeatureDefinitionScope _
) As SPFeature
'Utilisation
Dim instance As SPFeatureCollection
Dim featureId As Guid
Dim force As Boolean
Dim featdefScope As SPFeatureDefinitionScope
Dim returnValue As SPFeature
returnValue = instance.Add(featureId, _
force, featdefScope)
public SPFeature Add(
Guid featureId,
bool force,
SPFeatureDefinitionScope featdefScope
)
Paramètres
featureId
Type : System.GuidLa valeur de la propriété Id d'un objet SPFeatureDefinition .
force
Type : System.Booleantrue pour forcer l'activation de la fonctionnalité, même s'il existe des erreurs ; dans le cas contraire, false.
featdefScope
Type : Microsoft.SharePoint.SPFeatureDefinitionScopeValeur d'énumération qui indique où la définition de fonctionnalité est déployée. Pour activer une instance d'une fonctionnalité qui est disponible par le biais de solutions bac à sable, transmettez SPFeatureDefinitionScope.Site comme argument. Dans le cas contraire, passez SPFeatureDefinitionScope.Farm.
Valeur renvoyée
Type : Microsoft.SharePoint.SPFeature
Un objet qui représente l'instance de fonctionnalité. La propriété FeatureDefinitionScope de l'objet SPFeature est définie à la valeur qui est passée dans le paramètre featdefScope .
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | La valeur de la propriété Scope de l'objet SPFeatureDefinition ne correspond pas le niveau de la collection à laquelle vous ajoutez la fonctionnalité. |
| SPFeatureDependencyNotActivatedException | La fonctionnalité dépend d'une autre fonctionnalité qui n'a pas été activée pour cette étendue. |
Remarques
Définitions de fonction peuvent être installées au niveau de la batterie ou le niveau de la collection de sites. Utilisez la propriété FeatureDefinitions de l'objet SPFarm pour accéder à la collection d'objets SPFeatureDefinition qui représentent des définitions de fonctionnalité installées au niveau de la batterie de serveurs. Utilisez la propriété FeatureDefinitions de l'objet SPSite pour accéder à la collection installée au niveau de la collection de sites.
Une définition de fonctionnalité qui est installée au niveau de la batterie de serveurs peut être activée pour une application Web, une collection de sites ou un site Web. Dans les trois cas, vous devez passer SPFeatureDefinitionScope.Farm dans l' featdefScope de la méthode Add . Ce paramètre indique simplement à la méthode Add où chercher la définition de fonctionnalité.
Une définition de fonctionnalité qui est installée au niveau de la collection de sites peut être activée pour une collection de sites ou un site Web. Dans les deux cas, vous devez passer SPFeatureDefinitionScope.Site dans l' featdefScope de la méthode Add .
Pour activer une définition de fonction pour une application Web, vous devez l'ajouter à l'objet SPFeatureCollection qui est retourné par la propriété Features d'un objet SPWebApplication . Pour l'activer pour une collection de sites, vous devez l'ajouter à la collection qui est retournée par la propriété Features d'un objet SPSite . Pour l'activer pour un site Web, vous devez l'ajouter à la collection qui est retournée par la propriété Features d'un objet SPWeb . La méthode Add lève une exception InvalidOperationException si la valeur de la propriété Scope de l'objet SPFeatureDefinition ne correspond pas le niveau de la collection à laquelle vous ajoutez la fonctionnalité.