SPFeatureCollection.Add - Méthode (Guid, Boolean)
Active une fonctionnalité à l'aide de la définition de fonctionnalité avec l'ID spécifié 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 _
) As SPFeature
'Utilisation
Dim instance As SPFeatureCollection
Dim featureId As Guid
Dim force As Boolean
Dim returnValue As SPFeature
returnValue = instance.Add(featureId, _
force)
public SPFeature Add(
Guid featureId,
bool force
)
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.
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 à SPFeatureDefinitionScope.Farm.
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | La définition de fonctionnalité n'a pas été installée dans la batterie de serveurs, ou 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 déployées au niveau de la batterie ou au niveau de la collection de sites. Cette surcharge de la méthode Add peut être utilisée uniquement avec les définitions de fonction qui ont été déployées au niveau de la batterie de serveurs. Pour activer une fonctionnalité à l'aide d'une définition de fonctionnalité qui est déployée au niveau de la collection de sites — en d'autres termes, une définition de fonction mises à disposition par le biais de solutions bac à sable, utilisez la surcharge de la méthode Add de la Add(Guid, Boolean, SPFeatureDefinitionScope) .
Vous pouvez obtenir la collection d'objets SPFeatureDefinition qui représentent des définitions de fonctionnalité installées au niveau de la batterie de serveurs en accédant à la propriété FeatureDefinitions de l'objet SPFarm . Une définition de fonction qui se trouve dans la collection au niveau de la batterie de serveurs peut être activée pour une application Web, une collection de sites ou un site Web, tant que la propriété Scope de l'objet SPFeatureDefinition correspondant au niveau de la collection à laquelle vous ajoutez la fonctionnalité.
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é.