Feature-Element (Feature)

Gilt für: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online-| SharePoint Server 2013

Definiert ein Feature, das in einem angegebenen Bereich aktiviert oder deaktiviert werden soll.

Definition

<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>

Elemente und Attribute

In den folgenden Abschnitten werden Attribute, untergeordnete und übergeordnete Elemente erläutert.

Attribute

Attribut Beschreibung
ActivateOnDefault Optionaler Boolean-Wert. TRUE, wenn das Feature während der Installation oder beim Erstellen einer Webanwendung standardmäßig aktiviert wird; FALSE, wenn das Feature nicht aktiviert wird. Dieses Attribut ist standardmäßig TRUE. Das ActivateOnDefault-Attribut gilt nicht für Websitesammlungsfunktionen (Website) oder Website (Web).

Im Allgemeinen werden Features im Bereich der Farm während der Installation aktiviert, und wenn eine neue Webanwendung erstellt wird, werden alle darin installierten Webanwendungsfunktionen aktiviert.
AlwaysForceInstall Optionaler Boolean-Wert. TRUE, wenn die Installation des Features während der Installation erzwungen wird, selbst wenn das Feature bereits installiert ist. Wenn beispielsweise auf TRUE festgelegt ist, werden Ereignishandler für die Featurebereitstellung immer ausgelöst, wenn ein Benutzer versucht, das Feature zu installieren (auch wenn es bereits installiert ist), indem er entweder den Befehlszeilenvorgang scanforfeatures oder installfeature verwendet. Dieses Attribut ist standardmäßig FALSE. Das AlwaysForceInstall-Attribut gilt für Features aller Bereiche.
AutoActivateInCentralAdmin Optionaler Boolean-Wert. TRUE , wenn das Feature standardmäßig in der Administrativen Website, Websitesammlung oder Webanwendung aktiviert ist. Dieses Attribut ist standardmäßig FALSE. Das AutoActivateInCentralAdmin-Attribut gilt nicht für Features mit Farm-Bereich.
Creator Optionaler Text.
DefaultResourceFile Optionaler Text. Gibt eine allgemeine Ressourcendatei zum Abrufen von Feature-XML-Ressourcen an. Wenn Sie keine Ressource in der Datei angeben, sucht SharePoint Foundation standardmäßig in %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATES\FEATURES\*FeatureName*\Resources\Resources._Culture_.resx.

Wenn Sie jedoch eine freigegebene Kernressourcendatei für alle Features in Ihrer Anwendung bereitstellen möchten, können Sie mithilfe von DefaultResourceFile eine alternative Datei angeben, über die auf Ressourcen zugegriffen werden soll. Wenn Sie beispielsweise DefaultResourceFile="_MyFile_" festlegen, sucht SharePoint Foundation in %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\Resources\*MyFile*._Culture_.resx nach lokalisierten Ressourcen für Ihr Feature.
Beschreibung Optionaler String-Wert. Gibt eine längere Darstellung der Featurefunktion zurück.
Hidden Optionaler Boolean-Wert. Dieses Attribut ist standardmäßig FALSE.
Id Erforderlicher Text. Enthält die GUID (Globally Unique Identifier) für das Feature.
ImageUrl Optionaler Text. Enthält eine URL relativ zum Verzeichnis \_layouts/IMAGES für ein Bild, das verwendet werden soll, um das Feature auf der Benutzeroberfläche darzustellen.
ImageUrlAltText Optionaler Text-Wert. Enthält den alternativen Text für das Bild, das das Feature darstellt.
ReceiverAssembly Optionaler Text. Gibt in Verbindung mit ReceiverClass den starken Namen der signierten Assembly im globalen Assemblycache an, aus der ein Empfänger für die Verarbeitung von Featureereignissen geladen werden soll.
ReceiverClass Optionaler Text. Gibt in Verbindung mit ReceiverAssembly die Klasse an, die den Featureereignisprozessor implementiert.
RequireResources Optionaler Boolean-Wert. TRUE , um anzugeben, dass SharePoint Foundation überprüft, ob Ressourcen für das Feature vorhanden sind, indem überprüft wird, ob die Standardressource "Sentinel" für das Feature für eine bestimmte Kultur vorhanden ist.

Die Ressourcendatei wird nach dem Format <Feature Directory>\Resources\Resources..resxbenannt, wobei <Culture Name> der Name ist, der die Kultur identifiziert. SharePoint Foundation unterstützt die folgenden Formate für Kulturnamen:



ll-Ssss-CCll-CC

Beispiele für Kulturnamen:

en-US Englisch (USA)

de-DE Deutsch (Deutschland)

fr-FR Französisch (Frankreich)

ja-JP Japanisch (Japan)

sr-Latn-CS Serbisch (Lateinisch, Serbien)

The Internet Engineering Task Force (IETF) Sprachtag format ist ll(l)-Ssss-CC, wobei:
ll(l)
* den erforderlichen Zweibuchstaben-Sprachbezeichner (oder drei Buchstaben, wenn kein ISO-Code aus zwei Buchstaben für die Sprache vorhanden ist).Ssss*
Bezeichnet einen optionalen Skriptbezeichner.* CC
Bezeichnet einen optionalen Regionsbezeichner.

Mit dem RequireResources-Attribut können Sie die Sichtbarkeit bestimmter Features einschränken, je nachdem, ob Ressourcen in einer bestimmten Sprache für das Feature vorhanden sind.

Hinweis: SharePoint Foundation verwendet die durch das DefaultResourceFile-Attribut angegebene Datei (sofern vorhanden) nicht als Sicherungsdatei zum Überprüfen der Unterstützung einer bestimmten Sprache für ein Feature.

Wenn die Datei für die Sprache einer bestimmten Website oder Websitesammlung nicht vorhanden ist, können zwei Verhaltensweisen auftreten:

* Das Feature wird auf der Benutzeroberfläche für die Aktivierung von Features in der Website oder Websitesammlung ausgeblendet, wenn die entsprechenden Ressourcen für die Sprache nicht verfügbar sind.

Beachten Sie, dass das RequireResources-Attribut nur auf der Benutzeroberfläche erzwungen wird. Ein Feature ohne Ressourcen für eine bestimmte Sprache kann für eine Website weiterhin über Befehlszeilenvorgänge mit stsadm.exe oder über das Objektmodell aktiviert werden.

SharePoint Foundation erzwingt keine RequireResources für Features, die Teil einer größeren Websitedefinition sind. Wenn Sie beispielsweise eine thailändische Version einer Websitedefinition angeben, indem Sie eine webtempThai.xml in %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\1054\XML ablegen, müssen Sie überprüfen, ob jedes feature im Ordner enthalten ist, über die entsprechenden Ressourcen verfügt.

* Im Allgemeinen stellt SharePoint Foundation sicher, dass Die Komponenten der Benutzeroberflächenerweiterung des Features nicht auf Websites ohne Ressourcen angezeigt werden, aber es gibt Ausnahmen. Selbst wenn Sie RequireResources sorgfältig festlegen und keine Websitedefinitionen bereitstellen, es sei denn, alle Features enthalten Ressourcen, können Features weiterhin auf Websites angezeigt werden, auf denen keine Ressourcen verfügbar sind.

Angenommen, Sie verfügen über ein benutzerdefiniertes Feature mit Ressourcen für zwei Sprachen, das benutzerdefinierte Symbolleistenschaltflächen und Links zu Websiteeinstellungen bereitstellt, und dass Sie eine neue Websitesammlung mit einer Stammwebsite in einer der Sprachen bereitgestellt haben. Nachdem Sie das Sprachpaket für eine dritte Sprache heruntergeladen und installiert haben, stellen Sie eine neue Unterwebsite in dieser dritten Sprache unter der ursprünglichen Stammwebsite bereit. Wenn RequireResources nicht auf TRUE festgelegt ist, versucht das benutzerdefinierte Feature, ein Fallback durchzuführen und Fallbackressourcen zu verwenden (d. h., die als Resources\Resources.resxdefiniert sind, ohne Kultur). Wenn keine Fallbackressourcen vorhanden sind, rendert SharePoint Foundation leere Zeichenfolgen. Wenn RequireResources jedoch auf TRUE festgelegt ist, werden die Komponenten der Benutzeroberflächenerweiterung des Features (z. B. die über ein CustomAction-, ListTemplate- oder FeatureSiteTemplateAssociation-Element definierten Komponenten) nicht auf Unterwebsites angezeigt, wenn keine Ressourcen verfügbar sind, sodass die benutzerdefinierten Links und Websiteeinstellungen automatisch ausgeblendet werden.

Das Festlegen dieses Attributs gilt nur für die Aktivierung von Features über die Benutzeroberfläche und nicht über STSADM.EXE Befehlszeilenvorgänge oder das Objektmodell.
Scope Erforderlicher Text. Gibt den Bereich an, in dem das Feature aktiviert werden kann, und enthält einen der folgenden Werte: Farm (Farm), WebApplication (Webanwendung), Website (Websitesammlung), Web (Website). Informationen zum Bereich finden Sie unter Element Scope.
Solutionid Optionaler Text. Gibt die Lösung an, zu der das Feature gehört.
Title Optionaler Text-Wert. Gibt den Titel des Features zurück. Maximal 255 Zeichen.
UIVersion Optionaler Text. Gibt die Version der Benutzeroberfläche für dieses Feature an. UIVersion wird auf verschiedene Arten angegeben.

* =# - die UIVersion der Website muss gleich #sein.* <#
- die UIVersion der Website muss kleiner als #sein.>#
* - die UIVersion der Website muss größer als #sein.
<=#* - die UIVersion der Website muss kleiner oder gleich #sein.*
>=# - Die UIVersion der Website muss größer als oder gleich sein. - die UIVersion der Website muss größer als oder gleich #sein.
* #;# - Die UIVersion der Website muss in der durch Semikolons getrennten Liste von Zahlen enthalten sein.
Version Optionaler Text. Gibt eine System.Version-konforme Darstellung der Version eines Features an. Kann bis zu vier Zahlen enthalten, die durch Dezimaltrennzeichen voneinander getrennt sind und eine Version darstellen.

Untergeordnete Elemente

ActivationDependencies, ElementManifests, Properties, UpgradeActions Element (Feature)

Übergeordnete Elemente

Keine

HinwBemerkungeneise

SharePoint Foundation unterstützt nur ASCII-Zeichen niedriger Reihenfolge und keine Leerzeichen für Featureordner- und Dateinamen.

Beispiel

Ein Beispiel für die Verwendung dieses Elements finden Sie unter Feature.xml Files.