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

Статья
05/13/2015

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

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

Синтаксис

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

Параметры

featureId
Тип: System.Guid

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

force
Тип: System.Boolean

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

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

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

Исключения

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

Замечания

Функция определения могут быть развернуты на уровне фермы, так и на уровне семейства узлов. Эта перегрузка метода Add можно использовать только для определения функций, которые были развернуты на уровне фермы. Для активации функции Определение компонента, который развернут на уровне семейства узлов с помощью — через изолированные решения, определение функции, используйте перегрузку метода AddAdd(Guid, Boolean, SPFeatureDefinitionScope) .

Можно получить коллекцию объектов SPFeatureDefinition , представляющих определениям компонентов, установленных на уровне фермы с помощью свойства FeatureDefinitions объекта SPFarm . Определение компонента, в коллекции уровня фермы можно активировать для веб-приложения, семейства веб-сайтов или веб-узла, при условии, что свойство Scope объекта SPFeatureDefinition соответствует уровню коллекции, к которому добавляется компонент.

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

См. также

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

SPFeatureCollection класс

Элементы SPFeatureCollection

Перегрузка Add

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

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