CustomAction-Element

Artikel
04/08/2023

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

Definiert eine Erweiterung der Benutzeroberfläche, z. B. eine Schaltfläche auf einer Symbolleiste oder einen Link auf einer Seite mit Websiteeinstellungen.

Definition

<CustomAction
  RequiredAdmin = "Delegated | Farm | Machine"
  ControlAssembly = "Text"
  ControlClass = "Text"
  ControlSrc = "Text"
  Description = "Text"
  FeatureId = "Text"
  GroupId = "Text"
  Id = "Text"
  ImageUrl = "Text"
  Location = "Text"
  RegistrationId = "Text"
  RegistrationType = "Text"
  RequireSiteAdministrator = "TRUE" | "FALSE"
  Rights = "Text"
  RootWebOnly = "TRUE" | "FALSE"
  ScriptSrc = "Text"
  ScriptBlock = "Text"
  Sequence = "Integer"
  ShowInLists = "TRUE" | "FALSE"
  ShowInReadOnlyContentTypes = "TRUE" | "FALSE"
  ShowInSealedContentTypes = "TRUE" | "FALSE"
  Title = "Text"
  UIVersion = "Integer">
</CustomAction>

Elemente und Attribute

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

Attribute

Attribut	Beschreibung
`RequiredAdmin`	Optional `Text`. Gibt die administrativen Rechte an, die erforderlich sind, damit die benutzerdefinierte Aktion übernommen wird. Dieser Wert dient zum Trimmen von Links in der Zentraladministration. Die folgenden Werte sind möglich: `Delegated` `Farm` `Machine`
`ControlAssembly`	Optional `Text`. Gibt die Assembly eines Steuerelements an, das die benutzerdefinierte Aktion unterstützt.
`ControlClass`	Optional `Text`. Gibt eine Steuerelementklasse an, die die benutzerdefinierte Aktion unterstützt.
`ControlSrc`	Optional `Text`. Gibt die relative URL der ASCX-Datei an, die als Quelle für die benutzerdefinierte Aktion dient, z. B `"~/_controltemplates/myCustomAction.ascx"`. .
`Description`	Optional `Text`. Gibt eine längere Beschreibung der Aktion an, die als QuickInfo oder untergeordnete Beschreibung der Aktion zur Verfügung gestellt wird.
`FeatureId`	Optional `Text`. Gibt das Feature an, das der benutzerdefinierten Aktion zugeordnet ist.
`GroupId`	Optional `Text`. Identifiziert eine Aktionsgruppe, die die Aktion enthält, `"SiteManagement"`z. B. . Wenn es in einer benutzerdefinierten Aktionsgruppe enthalten ist, muss der Wert des `GroupId` Attributs der Gruppen-ID des CustomActionGroup-Elements entsprechen. Eine Liste der standardmäßigen benutzerdefinierten Aktionsgruppen-IDs, die in Microsoft SharePoint Foundation verwendet werden, finden Sie unter Standardspeicherorte und IDs für benutzerdefinierte Aktionen.
`Id`	Optional `Text`. Gibt eine eindeutige ID für die benutzerdefinierte Aktion an. Die ID kann eine GUID oder ein eindeutiger Begriff sein, z. B `"HtmlViewer"`. .
`ImageUrl`	Optional `Text`. Gibt einen zum virtuellen Server relativen Link zu einem Bild an, der das Symbol des Elements anzeigt.
`Location`	Optional `Text`. Gibt den Speicherort dieser benutzerdefinierten Aktion an, `"Microsoft.SharePoint.SiteSettings"`z. B. . Wenn das `CustomAction` Element ein untergeordnetes `CommandUIExtension` Element enthält, muss mit `Location` "CommandUI.Ribbon" beginnen. Eine Liste der Standardspeicherorte, die mit dem Menüband "Server" verwendet werden, finden Sie unter Standardserver-Menübandanpassungsspeicherorte. Wenn es sich bei der benutzerdefinierten Aktion um ein Menüelement oder eine Symbolleistenschaltfläche handelt, sind `EditControlBlock`die möglichen Optionen , `NewFormToolbar`, `DisplayFormToolbar`und `EditFormToolbar`. Wenn es in einer benutzerdefinierten Aktionsgruppe enthalten ist, muss der Wert des `Location` Attributs dem Speicherort des CustomActionGroup-Elements entsprechen. Eine Liste der standardmäßigen Speicherorte für benutzerdefinierte Aktionen, die in SharePoint Foundation verwendet werden, finden Sie unter Standardspeicherorte und IDs für benutzerdefinierte Aktionen.
`RegistrationId`	Optional `Text`. Gibt den Bezeichner des Listen- oder Elementinhaltstyps an, dem diese Aktion zugeordnet ist, oder den Dateityp oder programmgesteuerten Bezeichner (`ProgID`).
`RegistrationType`	Optional `Text`. Gibt die Registrierungsanfügung für eine elementbezogene Aktion an. Mögliche Werte sind: `None` `List` `ContentType` `ProgId` `FileType`
`RequireSiteAdministrator`	Optional `Boolean`. `TRUE` , um anzugeben, dass das Element nur angezeigt wird, wenn der Benutzer ein Websiteadministrator ist; `FALSE`andernfalls . Die Verwendung des `RequireSiteAdministrator` -Attributs für das Dropdownmenü von SharePoint Foundation-Befehlen, die Listenelementen zugeordnet sind, wird nicht unterstützt.
`Rights`	Optional `Text`. Gibt einen Satz von Rechten an, über die der Benutzer verfügen muss, `"ViewListItems,ManageAlerts"`damit der Link sichtbar ist, z. B. . Wenn sie nicht angegeben ist, wird die Aktion immer in der Liste der Aktionen angezeigt. Um mehrere Rechte anzugeben, trennen Sie die Werte durch Kommas. Der Rechtesatz wird logisch nach `AND` Logik gruppiert, was bedeutet, dass ein Benutzer über alle angegebenen Rechte verfügen muss, um eine Aktion anzuzeigen. Eine Liste der möglichen Werte finden Sie unter Microsoft.SharePoint.SPBasePermissions.
`RootWebOnly`	Optional `Boolean`. `TRUE` , um die benutzerdefinierte Aktion nur auf Stammwebsites bereitzustellen. Dieses Attribut gilt für benutzerdefinierte Aktionen in einer Sandkastenlösung.
`ScriptSrc`	Optional `Text`. Gibt eine Datei an, die auszuführende Skripts enthält. Dieses Attribut ist nur anwendbar, wenn das `Location` Attribut auf `ScriptLink`festgelegt ist.
`ScriptBlock`	Optional `Text`. Gibt einen Skriptblock an, der ausgeführt werden soll. Dieses Attribut ist nur anwendbar, wenn das `Location` Attribut auf `ScriptLink`festgelegt ist.
`Sequence`	Optional `Integer`. Gibt die Reihenfolgespriorität für Aktionen an.
`ShowInLists`	Dieses Attribut ist veraltet und sollte nicht verwendet werden. Optional `Boolean`. `TRUE` , wenn die benutzerdefinierte Aktion nur für Listen auf der Seite zum Verwalten von Inhaltstypen angezeigt wird. Der Standardwert ist `FALSE`.
`ShowInReadOnlyContentTypes`	Optional `Boolean`. `TRUE` , wenn die benutzerdefinierte Aktion nur für schreibgeschützte Inhaltstypen auf der Seite zum Verwalten von Inhaltstypen angezeigt wird. Der Standardwert ist `FALSE`.
`ShowInSealedContentTypes`	Optional `Boolean`. `TRUE` , wenn die benutzerdefinierte Aktion nur für versiegelte Inhaltstypen auf der Seite zum Verwalten von Inhaltstypen angezeigt wird. Der Standardwert ist `FALSE`.
`Title`	Erforderlich `Text`. Gibt die Endbenutzerbeschreibung für diese Aktion an.
`UIVersion`	Optional `Integer`. Gibt die Version der Benutzeroberfläche an, in der diese benutzerdefinierte Aktion aufgeführt werden soll.

Untergeordnete Elemente

CommandUIExtension

UrlAction

Übergeordnete Elemente

Elemente

Vorkommen

Minimum: 1

Maximum: Unbegrenzt

Hinweise

Sie können das CustomAction-Element verwenden, um Standard-ASP.NET-Steuerelemente und Benutzersteuerelemente (z. B. Textfelder oder Optionsfelder) als benutzerdefinierte Aktionen in Symbolleisten hinzuzufügen. Sie können jedoch nur Steuerelemente zum Instanziieren von Menüelementen zu den Dropdownmenüs von Symbolleisten hinzufügen. Sie können keine Webparts oder beliebige Steuerelemente hinzufügen.

Beispiel

Das folgende Beispiel ist Teil eines Features, das eine Schaltfläche im Menüband "Server" ersetzt.

    <Elements xmlns="http://schemas.microsoft.com/sharepoint/">
      <CustomAction Id="Ribbon.Library.Actions.ReplacementButton"
        Location="CommandUI.Ribbon"
        RegistrationId="101"
        RegistrationType="List"
        Title="Replace a Ribbon Button">
        <CommandUIExtension>
          <CommandUIDefinitions>
            <CommandUIDefinition
              Location="Ribbon.Library.Actions.ConnectToClient">
                 <Button Id="Ribbon.Library.Actions.ConnectToClient.ReplacementButton"
                   Command="ReplacementButtonCommand"
                   Image16by16="Insert an image URL here."
                   Image32by32="Insert an image URL here."
                   LabelText="Replaced Button"
                   TemplateAlias="o2" />
            </CommandUIDefinition>
          </CommandUIDefinitions>
          <CommandUIHandlers>
            <CommandUIHandler
              Command="ReplacementButtonCommand"
              CommandAction="javascript:alert('This button has been replaced.');" />
          </CommandUIHandlers>
        </CommandUIExtension>
      </CustomAction>
    </Elements>

Siehe auch

Standorte und IDs für benutzerdefinierte Standardaktionen

Attribut	Beschreibung
`RequiredAdmin`	Optional `Text`. Gibt die administrativen Rechte an, die erforderlich sind, damit die benutzerdefinierte Aktion übernommen wird. Dieser Wert dient zum Trimmen von Links in der Zentraladministration. Die folgenden Werte sind möglich: `Delegated` `Farm` `Machine`
`ControlAssembly`	Optional `Text`. Gibt die Assembly eines Steuerelements an, das die benutzerdefinierte Aktion unterstützt.
`ControlClass`	Optional `Text`. Gibt eine Steuerelementklasse an, die die benutzerdefinierte Aktion unterstützt.
`ControlSrc`	Optional `Text`. Gibt die relative URL der ASCX-Datei an, die als Quelle für die benutzerdefinierte Aktion dient, z. B `"~/_controltemplates/myCustomAction.ascx"`. .
`Description`	Optional `Text`. Gibt eine längere Beschreibung der Aktion an, die als QuickInfo oder untergeordnete Beschreibung der Aktion zur Verfügung gestellt wird.
`FeatureId`	Optional `Text`. Gibt das Feature an, das der benutzerdefinierten Aktion zugeordnet ist.
`GroupId`	Optional `Text`. Identifiziert eine Aktionsgruppe, die die Aktion enthält, `"SiteManagement"`z. B. . Wenn es in einer benutzerdefinierten Aktionsgruppe enthalten ist, muss der Wert des `GroupId` Attributs der Gruppen-ID des CustomActionGroup-Elements entsprechen. Eine Liste der standardmäßigen benutzerdefinierten Aktionsgruppen-IDs, die in Microsoft SharePoint Foundation verwendet werden, finden Sie unter Standardspeicherorte und IDs für benutzerdefinierte Aktionen.
`Id`	Optional `Text`. Gibt eine eindeutige ID für die benutzerdefinierte Aktion an. Die ID kann eine GUID oder ein eindeutiger Begriff sein, z. B `"HtmlViewer"`. .
`ImageUrl`	Optional `Text`. Gibt einen zum virtuellen Server relativen Link zu einem Bild an, der das Symbol des Elements anzeigt.
`Location`	Optional `Text`. Gibt den Speicherort dieser benutzerdefinierten Aktion an, `"Microsoft.SharePoint.SiteSettings"`z. B. . Wenn das `CustomAction` Element ein untergeordnetes `CommandUIExtension` Element enthält, muss mit `Location` "CommandUI.Ribbon" beginnen. Eine Liste der Standardspeicherorte, die mit dem Menüband "Server" verwendet werden, finden Sie unter Standardserver-Menübandanpassungsspeicherorte. Wenn es sich bei der benutzerdefinierten Aktion um ein Menüelement oder eine Symbolleistenschaltfläche handelt, sind `EditControlBlock`die möglichen Optionen , `NewFormToolbar`, `DisplayFormToolbar`und `EditFormToolbar`. Wenn es in einer benutzerdefinierten Aktionsgruppe enthalten ist, muss der Wert des `Location` Attributs dem Speicherort des CustomActionGroup-Elements entsprechen. Eine Liste der standardmäßigen Speicherorte für benutzerdefinierte Aktionen, die in SharePoint Foundation verwendet werden, finden Sie unter Standardspeicherorte und IDs für benutzerdefinierte Aktionen.
`RegistrationId`	Optional `Text`. Gibt den Bezeichner des Listen- oder Elementinhaltstyps an, dem diese Aktion zugeordnet ist, oder den Dateityp oder programmgesteuerten Bezeichner (`ProgID`).
`RegistrationType`	Optional `Text`. Gibt die Registrierungsanfügung für eine elementbezogene Aktion an. Mögliche Werte sind: `None` `List` `ContentType` `ProgId` `FileType`
`RequireSiteAdministrator`	Optional `Boolean`. `TRUE` , um anzugeben, dass das Element nur angezeigt wird, wenn der Benutzer ein Websiteadministrator ist; `FALSE`andernfalls . Die Verwendung des `RequireSiteAdministrator` -Attributs für das Dropdownmenü von SharePoint Foundation-Befehlen, die Listenelementen zugeordnet sind, wird nicht unterstützt.
`Rights`	Optional `Text`. Gibt einen Satz von Rechten an, über die der Benutzer verfügen muss, `"ViewListItems,ManageAlerts"`damit der Link sichtbar ist, z. B. . Wenn sie nicht angegeben ist, wird die Aktion immer in der Liste der Aktionen angezeigt. Um mehrere Rechte anzugeben, trennen Sie die Werte durch Kommas. Der Rechtesatz wird logisch nach `AND` Logik gruppiert, was bedeutet, dass ein Benutzer über alle angegebenen Rechte verfügen muss, um eine Aktion anzuzeigen. Eine Liste der möglichen Werte finden Sie unter Microsoft.SharePoint.SPBasePermissions.
`RootWebOnly`	Optional `Boolean`. `TRUE` , um die benutzerdefinierte Aktion nur auf Stammwebsites bereitzustellen. Dieses Attribut gilt für benutzerdefinierte Aktionen in einer Sandkastenlösung.
`ScriptSrc`	Optional `Text`. Gibt eine Datei an, die auszuführende Skripts enthält. Dieses Attribut ist nur anwendbar, wenn das `Location` Attribut auf `ScriptLink`festgelegt ist.
`ScriptBlock`	Optional `Text`. Gibt einen Skriptblock an, der ausgeführt werden soll. Dieses Attribut ist nur anwendbar, wenn das `Location` Attribut auf `ScriptLink`festgelegt ist.
`Sequence`	Optional `Integer`. Gibt die Reihenfolgespriorität für Aktionen an.
`ShowInLists`	Dieses Attribut ist veraltet und sollte nicht verwendet werden. Optional `Boolean`. `TRUE` , wenn die benutzerdefinierte Aktion nur für Listen auf der Seite zum Verwalten von Inhaltstypen angezeigt wird. Der Standardwert ist `FALSE`.
`ShowInReadOnlyContentTypes`	Optional `Boolean`. `TRUE` , wenn die benutzerdefinierte Aktion nur für schreibgeschützte Inhaltstypen auf der Seite zum Verwalten von Inhaltstypen angezeigt wird. Der Standardwert ist `FALSE`.
`ShowInSealedContentTypes`	Optional `Boolean`. `TRUE` , wenn die benutzerdefinierte Aktion nur für versiegelte Inhaltstypen auf der Seite zum Verwalten von Inhaltstypen angezeigt wird. Der Standardwert ist `FALSE`.
`Title`	Erforderlich `Text`. Gibt die Endbenutzerbeschreibung für diese Aktion an.
`UIVersion`	Optional `Integer`. Gibt die Version der Benutzeroberfläche an, in der diese benutzerdefinierte Aktion aufgeführt werden soll.

Freigeben über