SPFeatureCollection.Add method (Guid, Boolean)
Ativa um recurso usando a definição de recurso com a ID especificada 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 _
) As SPFeature
'Uso
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
)
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.
Valor retornado
Type: Microsoft.SharePoint.SPFeature
Um objeto que representa a instância do recurso. A propriedade FeatureDefinitionScope do objeto SPFeature é definida como SPFeatureDefinitionScope.Farm.
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | A definição de recurso não foi instalada no farm de servidores ou o valor da propriedade Scope do objeto SPFeatureDefinition não correspondem ao nível da 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 implantadas no nível do farm ou no nível do conjunto de sites. Essa sobrecarga do método Add pode ser usada apenas com as definições de recurso que foram implantadas no nível do farm. Para ativar um recurso usando uma definição de recurso que é implantada no nível de conjunto de sites — ou seja, uma definição de recurso disponibilizada por meio do soluçăos em área restrita— use a sobrecarga de Add(Guid, Boolean, SPFeatureDefinitionScope) do método Add .
Você pode obter a coleção de objetos SPFeatureDefinition que representam as definições de recurso instaladas no nível do farm, acessando a propriedade FeatureDefinitions do objeto SPFarm . Uma definição de recurso que faz parte da coleção de nível de farm pode ser ativada para um aplicativo da Web, um conjunto de sites ou um site da Web — como o nível da coleção ao qual você deseja adicionar o recurso coincide com a propriedade Scope do objeto SPFeatureDefinition .
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.