Элемент Feature (Feature)

Область применения: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Определяет функцию, которую следует активировать или отключить при заданном диапазоне.

Определение

<Feature
  ActivateOnDefault = "TRUE" | "FALSE"
  AlwaysForceInstall = "TRUE" | "FALSE"
  AutoActivateInCentralAdmin = "TRUE" | "FALSE"
  Creator = "Text"
  DefaultResourceFile =  "Text"
  Description = "Text"
  Hidden = "TRUE" | "FALSE"
  Id = "Text"
  ImageUrl = "Text"
  ImageUrlAltText = "Text"
  ReceiverAssembly = "Text"
  ReceiverClass = "Text"
  RequireResources = "TRUE" | "FALSE"
  Scope = "Text"
  SolutionId = "Text"
  Title = "Text"
  UIVersion = "Text"
  Version = "Text" >
</Feature>

Элементы и атрибуты

В разделах ниже приводится описание атрибутов, дочерних и родительских элементов.

Атрибуты

Атрибут	Описание
ActivateOnDefault	Необязательный логический. Значение TRUE используется в случае, если функция активирована по умолчанию во время установки или при создании веб-приложения; значение FALSE используется, если функция не активирована. Данный атрибут по умолчанию использует значение TRUE. Атрибут ActivateOnDefault не применяется к функциям семейства веб-сайтов (сайт) или веб-сайта (веб-сайт). Как правило, компоненты на уровне фермы активируются во время установки, а при создании нового веб-приложения активируются все установленные компоненты области веб-приложения в нем.
AlwaysForceInstall	Необязательный логический. Значение TRUE используется в случае, если функция во время установки устанавливается принудительно, даже в случаях, когда она уже установлена. Например, если задано значение TRUE, обработчики событий развертывания компонентов всегда будут запускаться при попытке пользователя установить компонент (даже если он уже установлен) с помощью операции командной строки scanforfeatures или installfeature . Данный атрибут по умолчанию использует значение FALSE. Атрибут AlwaysForceInstall влияет на функции во всех диапазонах.
AutoActivateInCentralAdmin	Необязательный логический. Значение TRUE , если компонент активирован по умолчанию на веб-сайте администрирования, в семействе веб-сайтов или веб-приложении. Данный атрибут по умолчанию использует значение FALSE. Атрибут AutoActivateInCentralAdmin не применяется к функциям в диапазоне Farm.
Creator	Необязательный текст.
DefaultResourceFile	Необязательный текст. Обозначает общий файл ресурсов для извлечения ресурсов функции XML. Если ресурс не указан в файле, SharePoint Foundation по умолчанию будет выполнять поиск в папке %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATES\FEATURES\*FeatureName*\Resources\Resources._Culture_.resx. Однако если вы хотите предоставить общий файл ресурсов ядра для всех компонентов в приложении, можно указать альтернативный файл, через который можно получить доступ к ресурсам, с помощью DefaultResourceFile. Например, если задать defaultResourceFile="_MyFile_", SharePoint Foundation будет искать в папке %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\Resources\*MyFile*._Culture_.resx, чтобы получить локализованные ресурсы для компонента.
Описание	Необязательный атрибут типа String. Возвращает более развернутое представление о действии функции.
Hidden	Необязательный логический. Данный атрибут по умолчанию использует значение FALSE.
Id	Обязательный текст. Содержит глобальный уникальный идентификатор (GUID) для компонента.
Imageurl	Необязательный текст. Содержит URL-адрес относительно каталога \_layouts/IMAGES для изображения, используемого для представления компонента в пользовательском интерфейсе.
ImageUrlAltText	Необязательный атрибут типа Text. Содержит альтернативный текст для изображения, представляющего функцию.
ReceiverAssembly	Необязательный текст. Если данный атрибут задан вместе с ReceiverClass, он указывает сильное имя подписанной сборки, расположенной в глобальном кэше сборки, из которой загружается программа-получатель для обработки событий функции.
ReceiverClass	Необязательный текст. Если данный атрибут задан вместе с ReceiverAssembly, он указывает класс, реализующий обработчик событий функции.
RequireResources	Необязательный логический. ЗНАЧЕНИЕ TRUE , чтобы указать, что SharePoint Foundation проверяет, существуют ли ресурсы для компонента, проверяя наличие стандартного ресурса sentinel для компонента для определенного языка и региональных параметров. Имя файла ресурсов осуществляется в соответствии с форматом <Feature Directory>\Resources\Resources..resx, где <Culture Name> — это имя, определяющее язык и региональные параметры. SharePoint Foundation поддерживает следующие форматы для имен и региональных параметров: ll-CC ll-Ssss-CCпримеры названий культур: en-US English (США) de-DE German (Германия) fr-FR French (Франция) ja-JP Japanese (Japan) sr-Latn-CS Сербский (латиница, Сербия) Тег языка Internet Engineering Task Force (IETF) format имеет значение ll(l)-Ssss-CC, где:* ll(l) обозначает обязательный двухбуквенный идентификатор языка (или трехбуквенный, если для языка нет двухбуквенный код ISO). Ssss* Обозначает необязательный идентификатор скрипта.* CC Обозначает необязательный идентификатор региона. Атрибут RequireResources позволяет ограничить видимость определенных компонентов в зависимости от того, существуют ли ресурсы на определенном языке для компонента. Примечание. SharePoint Foundation не использует файл, указанный атрибутом DefaultResourceFile, если он есть, в качестве файла резервной копии для проверки поддержки определенного языка для компонента. Если файл отсутствует для языка определенного веб-сайта или семейства веб-сайтов, могут возникнуть два варианта поведения: * Компонент будет скрыт в пользовательском интерфейсе для активации компонентов на веб-сайте или в семействе веб-сайтов, если соответствующие ресурсы для этого языка недоступны. Помните, что атрибут RequireResources применяется только в пользовательском интерфейсе. Компонент без ресурсов для определенного языка по-прежнему можно активировать для веб-сайта с помощью операций командной строки с stsadm.exe или объектной модели. SharePoint Foundation не применяет RequireResources для компонентов, которые являются частью определения сайта большего размера. Если вы предоставляете, например, тайскую версию определения сайта, поместив webtempThai.xml в папку %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\1054\XML, необходимо убедиться, что каждый компонент, содержащийся в папке, содержит соответствующие ресурсы. * Как правило, SharePoint Foundation гарантирует, что компоненты расширения пользовательского интерфейса компонента не отображаются на веб-сайтах без ресурсов, но существуют исключения. Даже если вы выполняете тщательную работу по настройке RequireResources и не развертываете определения сайтов, если у всех компонентов есть ресурсы, функции по-прежнему могут отображаться на сайтах, где ресурсы недоступны. В качестве примера предположим, что у вас есть пользовательский компонент с ресурсами для двух языков, который предоставляет настраиваемые кнопки панели инструментов и ссылки на параметры сайта, и что вы подготовили новое семейство веб-сайтов с корневым веб-сайтом на одном из языков. Затем после скачивания и установки языкового пакета для третьего языка вы подготавливаете новый дочерний сайт на этом третьем языке на исходном корневом веб-сайте. Если параметр RequireResources не имеет значения TRUE, пользовательская функция попытается откатиться и использовать резервные ресурсы (другими словами, те, которые определены как Resources\Resources.resx, без языка и региональных параметров). Если резервных ресурсов нет, SharePoint Foundation отрисовывает пустые строки. Однако если параметр RequireResources имеет значение TRUE, компоненты расширения пользовательского интерфейса компонента (например, определенные с помощью элемента CustomAction, ListTemplate или FeatureSiteTemplateAssociation) не будут отображаться на дочерних сайтах, если нет доступных ресурсов, поэтому пользовательские ссылки и параметры сайта будут автоматически скрыты. Установка этого атрибута применяется только к активации компонентов через пользовательский интерфейс, а не через операции STSADM.EXE командной строки или объектную модель.
Scope	Обязательный текст. Указывает область, в которой можно активировать компонент, и содержит одно из следующих значений: Ферма (ферма), WebApplication (веб-приложение), Сайт (семейство веб-сайтов), Веб-сайт (веб-сайт ). Сведения о диапазоне см. в разделе Element Scope.
SolutionId	Необязательный текст. Обозначает решение, к которому принадлежит функция.
Title	Необязательный атрибут типа Text. Возвращает заголовок функции. Длина не более 255 знаков.
UIVersion	Необязательный атрибут типа Text. Задает версию пользовательского интерфейса для этой функции. UIVersion указывается несколькими способами. * =# — UIVersion сайта должен быть равен #.* <# — UIVersion сайта должен быть меньше , чем #.>#* — UIVersion сайта должен быть больше , чем #. <=#* — UIVersion сайта должен быть меньше или равен #. — UIVersion сайта должен быть больше или равен .>=#* — UIVersion сайта должен быть больше или равен #. * #;# — UIVersion сайта должен находиться в списке чисел с разделителями с запятой.
Версия	Необязательный текст. Указывает совместимое с System.Version представление версии функции. Представление может содержать до четырех чисел, разделенных разделителями десятичных знаков, представляющими функцию.

Дочерние элементы

ActivationDependencies, ElementManifests, Properties, UpgradeActions Element (Feature)

Родительские элементы

Нет

Замечания

SharePoint Foundation поддерживает только символы ASCII низкого порядка и без пробелов для имен папок и файлов компонентов.

Пример

Пример использования этого элемента см. в разделе файлыFeature.xml.