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

Элемент Feature (Feature)

  • Статья

Дата последнего изменения: 9 марта 2015 г.

Применимо к: SharePoint Foundation 2010

В этой статье
Атрибуты
Дочерние элементы
Родительские элементы

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

<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

Необязательный атрибут типа Boolean. Значение TRUE используется в случае, если функция активирована по умолчанию во время установки или при создании веб-приложения; значение FALSE используется, если функция не активирована. Данный атрибут по умолчанию использует значение TRUE. Атрибут ActivateOnDefault не применяется к семейству веб-сайтов (Site) или функциям в диапазоне веб-сайта (Web).

В целом функции в диапазоне Farm активируются во время установки; при создании веб-приложения активируются все установленные в нем функции в диапазоне Web application.

AlwaysForceInstall

Необязательный атрибут типа Boolean. Значение TRUE используется в случае, если функция во время установки устанавливается принудительно, даже в случаях, когда она уже установлена. Например, если для функции присвоено значение TRUE, события компонента будут сигнализировать о попытке пользователя установить функцию (даже если она уже установлена) с помощью операции командной строки scanforfeatures или installfeature. Данный атрибут по умолчанию использует значение FALSE. Атрибут AlwaysForceInstall влияет на функции во всех диапазонах.

AutoActivateInCentralAdmin

Необязательный атрибут типа Boolean. Значение TRUE используется в случае, если функция активирована по умолчанию для веб-сайта администрирования, семейства веб-сайтов или веб-приложения. Данный атрибут по умолчанию использует значение FALSE. Атрибут AutoActivateInCentralAdmin не применяется к функциям в диапазоне Farm.

Creator

Необязательный атрибут типа Text.

DefaultResourceFile

Необязательный атрибут типа Text. Обозначает общий файл ресурсов для извлечения ресурсов функции XML. Если ресурс в файле не задан, SharePoint Foundation по умолчанию выполняет поиск в %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATES\FEATURES\FeatureName\Resources\Resources. Culture.resx. Тем не менее, если необходимо предоставить общий файл ресурсов ядра для всех функций в приложении, можно указать альтернативный файл, посредством которого осуществляется доступ к ресурсам с помощью DefaultResourceFile. Например, если задать DefaultResourceFile="MyFile", SharePoint Foundation выполняет поиск в %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\Resources\MyFile. Culture.resx и извлекает локализованные ресурсы для функции.

Description

Необязательный атрибут типа String. Возвращает более развернутое представление о действии функции.

Hidden

Необязательный атрибут типа Boolean. Данный атрибут по умолчанию использует значение FALSE.

Id

Обязательный атрибут типа Text.Содержит глобальный уникальный идентификатор (GUID) для функции.

ImageUrl

Необязательный атрибут типа Text. Содержит URL-адрес (относительно каталога /_layouts/IMAGES) изображения, которое используется для представления функции в пользовательском интерфейсе.

ImageUrlAltText

Необязательный атрибут типа Text. Содержит альтернативный текст для изображения, представляющего функцию.

ReceiverAssembly

Дополнительно используется Text. Если данный атрибут задан вместе с ReceiverClass, он указывает сильное имя подписанной сборки, расположенной в глобальном кэше сборки, из которой загружается программа-получатель для обработки событий функции.

ReceiverClass

Дополнительно используется Text. Если данный атрибут задан вместе с ReceiverAssembly, он указывает класс, реализующий обработчик событий функции.

RequireResources

Необязательный атрибут типа Boolean. Значение TRUE указывает, что SharePoint Foundation выполняет проверку на предмет существования ресурсов для функции путем подтверждения наличия для конкретных региональных параметров стандартного ресурса "сигнальная метка" для функции.

Имя файла ресурса имеет формат <Feature Directory>\Resources\Resources. <название_региональных параметров>.resx, где <название_региональных параметров> — это имя региональных параметров. В SharePoint Foundation поддерживаются следующие форматы названий региональных параметров.

ll-CC

ll-Ssss-CC

Примеры названий языков:

en-US Английский — США

de-DE Немецкий — Германия

fr-FR Французский — Франция

ja-JP Японский — Япония

sr-Latn-CS Сербский (латиница) — Сербия

Форматом языкового тега рабочей группы по стандартам IETF является 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\14\TEMPLATE\1054\XML необходимо убедиться, что для каждой функции, содержащейся в папке, существуют соответствующие ресурсы.

  • Как правило SharePoint Foundation обеспечивает скрытие компонентов расширения пользовательского интерфейса функции для веб-сайтов, для которых отсутствуют необходимые ресурсы. Однако есть исключения. Даже если выполнена точная настройка RequireResources и определения сайта развертываются, только если все функции имеют соответствующие ресурсы, функции все равно могут появляться на сайтах, для которых ресурсы недоступны.

    Для примера предположим, что существует пользовательская функция с ресурсами для двух языков, которая предоставляет настраиваемые кнопки панели инструментов и ссылки на параметры сайта, и предоставлено новое семейство веб-сайтов с корневым веб-сайтом на одном из языков. Далее после загрузки и установки языкового пакета для третьего языка предоставляется новый дочерний сайт с использованием данного третьего языка под оригинальным корневым веб-сайтом. Если для RequireResources не задано значение TRUE, пользовательская функция выполнит попытку перехода в аварийный режим и будет использовать ресурсы аварийного режима (то есть ресурсы, определенные как Resources\Resources.resx без региональных параметров). При отсутствии ресурсов аварийного режима SharePoint Foundation выводит пустые строки. Тем не менее, если для RequireResources задано значение TRUE, компоненты расширения пользовательского интерфейса для функции (например, определенные посредством элемента CustomAction, ListTemplate или FeatureSiteTemplateAssociation) не будут появляться на дочерних сайтах, если ресурсы недоступны; таким образом, пользовательские ссылки и параметры сайта будут автоматически скрыты.

Задать данный атрибут возможно только при активации функций посредством пользовательского интерфейса, а не с помощью операций командной строки STSADM.EXE или объектной модели.

Scope

Обязательный атрибут типа Text. Указывает диапазон, в котором может быть активирована функция, и содержит одно из следующих значений: Farm (ферма), WebApplication (веб-приложение), Site (семейство веб-сайтов), Web (веб-сайт). Сведения о диапазоне см. в разделе Область элемента.

SolutionId

Дополнительно используется Text. Обозначает решение, к которому принадлежит функция.

Title

Необязательный атрибут типа Text. Возвращает заголовок функции. Длина не более 255 знаков.

UIVersion

Необязательный атрибут типа Text. Задает версию пользовательского интерфейса для этой функции. Существует несколько способов задания значения UIVersion.

  • =# — значение UIVersion сайта должно быть равно #.

  • <# — значение UIVersion сайта должно быть меньше #.

  • ># — значение UIVersion сайта должно быть больше #.

  • <=# — значение UIVersion сайта должно быть меньше или равно #.

  • >=# — значение UIVersion сайта должно быть больше или равно #.

  • #;# — значения UIVersion сайта должны быть представлены в списке чисел, разделенных точками с запятой.

Version

Дополнительно используется Text. Указывает совместимое с System.Version представление версии функции. Представление может содержать до четырех чисел, разделенных разделителями десятичных знаков, представляющими функцию.

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

ActivationDependencies, ElementManifests, Properties, Элемент UpgradeActions (компонент)

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

Нет

Примечания

В именах папок и файлов функции в SharePoint Foundation можно использовать только первые 32 символа ASCII и нельзя использовать пробелы.

Пример

Примеры, демонстрирующие способы использования данного элемента, см. в разделе Файлы Feature.xml.