Метод SPFeatureCollection.Add (Guid, Boolean, SPFeatureDefinitionScope)

Статья
05/13/2015

Активирует компонент с помощью определения компонента с указанным Идентификатором в заданной области ограниченного действия для создания нового объекта SPFeature и затем добавить его в коллекцию, при необходимости последующей активации, даже при наличии ошибок.

Пространство имен: Microsoft.SharePoint
Сборка: Microsoft.SharePoint (в Microsoft.SharePoint.dll)

Синтаксис

'Декларация
Public Function Add ( _
    featureId As Guid, _
    force As Boolean, _
    featdefScope As SPFeatureDefinitionScope _
) As SPFeature
'Применение
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
)

Параметры

featureId
Тип: System.Guid

Значение свойства Id объекта SPFeatureDefinition .

force
Тип: System.Boolean

true для активации компонента, даже если есть ошибки; в противном случае — false.

featdefScope
Тип: Microsoft.SharePoint.SPFeatureDefinitionScope

Значение перечисления, указывающее, где развертывается в определении функции. Для активации экземпляра компонента, которая доступна через изолированные решения, передайте в качестве аргумента SPFeatureDefinitionScope.Site . В противном случае передайте SPFeatureDefinitionScope.Farm.

Возвращаемое значение

Тип: Microsoft.SharePoint.SPFeature
Объект, представляющий экземпляр компонента. Свойство FeatureDefinitionScope объекта SPFeature присваивается значение, передаваемое в параметре featdefScope .

Исключения

Исключение	Условие
InvalidOperationException	Значение свойства Scope объекта SPFeatureDefinition не соответствует уровня коллекции, к которому добавляется компонент.
SPFeatureDependencyNotActivatedException	Функция зависит от другой компонент, который не был активирован в этой области.

Замечания

Функция определения могут быть установлены на уровне фермы или на уровне семейства узлов. Свойство FeatureDefinitions объекта SPFarm для доступа к коллекции объектов SPFeatureDefinition , представляющих определениям компонентов, установленных на уровне фермы. Свойство FeatureDefinitions объекта SPSite для доступа к коллекции, установленные на уровне семейства узлов.

Определение компонента, который установлен на уровне фермы можно активировать для веб-приложения, семейства веб-сайтов или веб-узла. Во всех трех случаях необходимо передать в featdefScopeAdd метода SPFeatureDefinitionScope.Farm . Этот параметр просто сообщает метод Add , где искать Определение компонента.

Определение компонента, который установлен на уровне семейства узлов может быть активирован для семейства веб-сайтов или веб-узла. В любом случае необходимо передать SPFeatureDefinitionScope.SitefeatdefScope метода Add .

Чтобы включить определение компонента для веб-приложения, добавьте объект SPFeatureCollection , который возвращается свойством Features объекта SPWebApplication . Чтобы активировать его для семейства веб-сайтов, добавьте его в коллекцию, возвращается в свойстве Features объекта SPSite . Чтобы активировать его для веб-узла, добавьте его в коллекцию, возвращается в свойстве Features объекта SPWeb . Метод Add создает исключение InvalidOperationException , если значение свойства Scope объекта SPFeatureDefinition не соответствует уровня коллекции, к которому добавляется компонент.

См. также

Справочные материалы

SPFeatureCollection класс

Элементы SPFeatureCollection

Перегрузка Add

Пространство имен Microsoft.SharePoint

Поделиться через