SPFeatureCollection.Add method (Guid, Boolean, SPFeatureDefinitionScope)
Ativa um recurso usando a definição de recurso com a ID especificada no escopo especificado para criar um novo objeto de SPFeature e, em seguida, adicioná-lo à coleção, opcionalmente, forçando a ativação mesmo se houver erros.
Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaração
Public Function Add ( _
featureId As Guid, _
force As Boolean, _
featdefScope As SPFeatureDefinitionScope _
) As SPFeature
'Uso
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
)
Parâmetros
featureId
Type: System.GuidO valor da propriedade Id de um objeto SPFeatureDefinition .
force
Type: System.Booleantrue para forçar a ativação do recurso mesmo se houver erros; Caso contrário, false.
featdefScope
Type: Microsoft.SharePoint.SPFeatureDefinitionScopeUm valor de enumeração que indica onde a definição de recurso é implantada. Para ativar uma instância de um recurso é disponibilizado por meio de soluçăos em área restrita, passe SPFeatureDefinitionScope.Site como o argumento. Caso contrário, passe SPFeatureDefinitionScope.Farm.
Valor retornado
Type: Microsoft.SharePoint.SPFeature
Um objeto que representa a instância do recurso. A propriedade FeatureDefinitionScope do objeto SPFeature é definida para o valor que é passado no parâmetro featdefScope .
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | O valor da propriedade Scope do objeto SPFeatureDefinition não coincide com o nível de coleção ao qual você deseja adicionar o recurso. |
| SPFeatureDependencyNotActivatedException | O recurso depende de outro recurso que não foi ativado neste escopo. |
Comentários
As definições de recurso podem ser instaladas no nível do farm ou o nível de conjunto de sites. Use a propriedade FeatureDefinitions do objeto SPFarm para acessar a coleção de objetos SPFeatureDefinition que representam as definições de recurso instaladas no nível do farm. Use a propriedade FeatureDefinitions do objeto SPSite para acessar a coleção instalada no nível do conjunto de sites.
Uma definição de recurso que é instalada no nível do farm pode ser ativada para um aplicativo da Web, um conjunto de sites ou um site da Web. Em todos os três casos, você deve passar SPFeatureDefinitionScope.Farm em featdefScope do método Add . Esse parâmetro simplesmente informa o método de Add onde procurar a definição de recurso.
Uma definição de recurso que é instalada no nível do conjunto de sites pode ser ativada por um conjunto de sites ou um site da Web. Em ambos os casos, você deve passar SPFeatureDefinitionScope.Site em featdefScope do método Add .
Para ativar uma definição de recurso para um aplicativo da Web, adicione-o ao objeto SPFeatureCollection que é retornado pela propriedade Features de um objeto SPWebApplication . Para ativá-lo para um conjunto de sites, adicione-o à coleção retornada pela propriedade Features de um objeto SPSite . Para ativá-lo para um site da Web, adicione-o à coleção retornada pela propriedade Features de um objeto SPWeb . O método Add lança uma exceção InvalidOperationException se o valor da propriedade Scope do objeto SPFeatureDefinition não correspondem ao nível da coleção ao qual você deseja adicionar o recurso.