SPFeatureCollection.Add-Methode (Guid, Boolean, SPFeatureDefinitionScope)
Aktiviert ein Feature mithilfe der Featuredefinition mit der angegebenen ID im angegebenen Bereich ein neue SPFeature -Objekt erstellt, und fügen Sie es der Auflistung, erzwingt optional die Aktivierung, auch wenn Fehler aufgetreten sind.
Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaration
Public Function Add ( _
featureId As Guid, _
force As Boolean, _
featdefScope As SPFeatureDefinitionScope _
) As SPFeature
'Usage
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
)
Parameter
featureId
Typ: System.GuidDer Wert der Id -Eigenschaft eines SPFeatureDefinition -Objekts.
force
Typ: System.Booleantrue Aktivierung des Features zu erzwingen, auch wenn Fehler aufgetreten sind; andernfalls false.
featdefScope
Typ: Microsoft.SharePoint.SPFeatureDefinitionScopeEin-Wert, der angibt, in denen die Featuredefinition bereitgestellt wird. Um eine Instanz eines Features zu aktivieren, die über Sandkastenlösungenverfügbar gemacht wird, übergeben Sie SPFeatureDefinitionScope.Site als Argument. Übergeben Sie andernfalls SPFeatureDefinitionScope.Farm.
Rückgabewert
Typ: Microsoft.SharePoint.SPFeature
Ein Objekt, die Feature-Instanz darstellt. Die FeatureDefinitionScope -Eigenschaft des Objekts SPFeature ist auf den Wert festlegen, die in der featdefScope -Parameter übergeben wird.
Ausnahmen
| Ausnahme | Bedingung |
|---|---|
| InvalidOperationException | Der Wert der Scope -Eigenschaft des Objekts SPFeatureDefinition entspricht die Ebene der Auflistung nicht an, 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 die Websitesammlung-Ebene installiert werden. Verwenden Sie die FeatureDefinitions -Eigenschaft des SPFarm -Objekts, um Zugriff auf die Auflistung von SPFeatureDefinition -Objekten, die auf Farmebene installierte Featuredefinitionen darstellen. Verwenden Sie die FeatureDefinitions -Eigenschaft des SPSite -Objekts auf die Auflistung installiert Ebene der Websitesammlung zugreifen.
Eine Featuredefinition, die auf Farmebene installiert ist, kann für eine Webanwendung, eine Websitesammlung oder einer Website aktiviert werden. In allen drei Fällen müssen Sie SPFeatureDefinitionScope.FarmfeatdefScope der Add -Methode übergeben. Dieser Parameter weist einfach wo sich für die Featuredefinition für der Add -Methode.
Eine Featuredefinition, die Ebene der Websitesammlung installiert ist, kann für eine Websitesammlung oder einer Website aktiviert werden. In beiden Fällen müssen Sie SPFeatureDefinitionScope.SitefeatdefScope der Add -Methode übergeben.
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.