SPFeatureCollection.Add-Methode (Guid)
Aktiviert ein Feature mithilfe der Featuredefinition mit der angegebenen ID zum Erstellen eines neuen SPFeature -Objekts und fügen Sie es der Auflistung.
Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaration
Public Function Add ( _
featureId As Guid _
) As SPFeature
'Usage
Dim instance As SPFeatureCollection
Dim featureId As Guid
Dim returnValue As SPFeature
returnValue = instance.Add(featureId)
public SPFeature Add(
Guid featureId
)
Parameter
featureId
Typ: System.GuidDer Wert der Id -Eigenschaft eines SPFeatureDefinition -Objekts.
Rückgabewert
Typ: Microsoft.SharePoint.SPFeature
Ein Objekt, die Feature-Instanz darstellt. Die FeatureDefinitionScope -Eigenschaft des Objekts SPFeature ist auf SPFeatureDefinitionScope.Farmfestgelegt.
Ausnahmen
| Ausnahme | Bedingung |
|---|---|
| InvalidOperationException | Die Featuredefinition noch nicht in der Farm installiert wurde, oder der Wert der Scope -Eigenschaft des Objekts SPFeatureDefinition entspricht nicht der Ebene der Auflistung, zu dem Sie das Feature hinzufügen. |
| SPFeatureDependencyNotActivatedException | Das Feature ist abhängig von einer anderen Features, die nicht in diesem Bereich aktiviert wurde. |
Hinweise
Featuredefinitionen können auf Farmebene oder auf der Ebene der Websitesammlung bereitgestellt werden. Diese Überladung der Add -Methode kann nur mit Featuredefinitionen verwendet werden, die auf Farmebene bereitgestellt wurden. Zum Aktivieren eines Features mithilfe einer Featuredefinition, die Ebene der Websitesammlung bereitgestellt wird – d. h., eine über Sandkastenlösungenverfügbar gemacht Featuredefinition – verwenden Sie die Add(Guid, Boolean, SPFeatureDefinitionScope) Überladung der Add -Methode.
Sie können die Auflistung der SPFeatureDefinition -Objekte abzurufen, die auf Farmebene auf die FeatureDefinitions -Eigenschaft des Objekts SPFarm installierte Featuredefinitionen darstellen. Eine Featuredefinition, die in der Auflistung auf Farmebene ist für eine Webanwendung, eine Websitesammlung oder einer Website aktiviert werden – sofern die Scope -Eigenschaft des Objekts SPFeatureDefinition die Ebene der Auflistung übereinstimmt, dem Sie das Feature hinzufügen.
Um eine Featuredefinition für eine Webanwendung zu aktivieren, fügen Sie es auf das SPFeatureCollection -Objekt, das von der Features -Eigenschaft eines SPWebApplication -Objekts zurückgegeben wird. Um es für eine Websitesammlung aktivieren, fügen Sie es der Auflistung, das von der Features -Eigenschaft eines SPSite -Objekts zurückgegeben wird. Zum Aktivieren einer Website fügen Sie es der Auflistung, das von der Features -Eigenschaft eines SPWeb -Objekts zurückgegeben wird. Die Add -Methode löst eine Ausnahme InvalidOperationException , wenn der Wert der Scope -Eigenschaft des Objekts SPFeatureDefinition nicht die Ebene der Auflistung übereinstimmt, dem Sie das Feature hinzufügen.