CustomAction-Element

  • Artikel

Letzte Änderung: Mittwoch, 13. Oktober 2010

Gilt für: SharePoint Foundation 2010

Inhalt dieses Artikels
Attribute
Untergeordnete Elemente
Übergeordnete Elemente
Vorkommen

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

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

Attribute

Attribut

Beschreibung

RequiredAdmin

Optionaler Text-Wert. Gibt die administrativen Rechte an, die erforderlich sind, damit die benutzerdefinierte Aktion übernommen wird. Dieser Wert dient zum Trimmen von Links in der Zentraladministration. Mögliche Werte:

  • Delegated

  • Farm

  • Machine

ControlAssembly

Optionaler Text-Wert. Gibt die Assembly eines Steuerelements an, das die benutzerdefinierte Aktion unterstützt.

ControlClass

Optionaler Text-Wert. Gibt eine Steuerelementklasse an, die die benutzerdefinierte Aktion unterstützt.

ControlSrc

Optionaler Text-Wert. Gibt die relative URL der ASCX-Datei an, die als Quelle der benutzerdefinierten Aktion fungiert, z. B. "~/_controltemplates/myCustomAction.ascx".

Description

Optionaler Text-Wert. Gibt eine längere Beschreibung der Aktion an, die als QuickInfo oder untergeordnete Beschreibung der Aktion zur Verfügung gestellt wird.

FeatureId

Optionaler Text-Wert. Gibt das Feature an, das der benutzerdefinierten Aktion zugeordnet ist.

GroupId

Optionaler Text-Wert. Gibt eine Aktionsgruppe an, die die Aktion enthält, z. B. "SiteManagement". Falls diese in einer benutzerdefinierten Aktionsgruppe enthalten ist, muss der Wert des GroupId-Attributs der Gruppen-ID des CustomActionGroup-Elements entsprechen.

Eine Liste der Standard-IDs für benutzerdefinierte Aktionsgruppen, die in Microsoft SharePoint Foundationverwendet werden, finden Sie unter Benutzerdefinierte Standardaktionsspeicherorte und IDs.

Id

Optionaler Text-Wert. Gibt eine eindeutige ID für die benutzerdefinierte Aktion an. Die ID kann eine GUID oder ein eindeutiger Begriff sein, z. B. "HtmlViewer".

ImageUrl

Optionaler Text-Wert. Gibt einen zum virtuellen Server relativen Link zu einem Bild an, der das Symbol des Elements anzeigt.

Location

Optionaler Text-Wert. Gibt die Position dieser benutzerdefinierten Aktion an, z. B. "Microsoft.SharePoint.SiteSettings".

Wenn das CustomAction-Element ein untergeordnetes CommandUIExtension-Element enthält, muss Location mit "CommandUI.Ribbon" beginnen. Eine Liste der Standardpositionen in Menüband für die Serverkomponente finden Sie unter Anpassen von Standardobjekten im Menüband der Serverkomponente.

Wenn die benutzerdefinierte Aktion ein Menüelement oder eine Symbolleistenschaltfläche ist, zählen EditControlBlock, NewFormToolbar, DisplayFormToolbar und EditFormToolbar zu den möglichen Optionen.

Falls sie in einer benutzerdefinierten Aktionsgruppe enthalten ist, muss der Wert des Location-Attributs der Positions-ID des CustomActionGroup-Elements entsprechen.

Eine Liste der Standardpositionen benutzerdefinierter Aktionen in SharePoint Foundation finden Sie unter Benutzerdefinierte Standardaktionsspeicherorte und IDs.

RegistrationId

Optionaler Text-Wert. Gibt die ID des Listen- oder Elementinhaltstyps, die dieser Aktion zugeordnet ist, oder den Dateityp oder die ProgID (ProgID) an.

RegistrationType

Optionaler Text-Wert. Gibt die Registrierungsanfügung für eine elementbezogene Aktion an. Mögliche Werte:

  • None

  • List

  • ContentType

  • ProgId

  • FileType

RequireSiteAdministrator

Optionaler Boolean-Wert. TRUE zum Angeben, dass das Element nur angezeigt wird, wenn der Benutzer ein Websiteadministrator ist. FALSE. Das Verwenden des RequireSiteAdministrator-Attributs für das Dropdownmenü von SharePoint Foundation-Befehlen, die Listenelementen zugeordnet sind, wird nicht unterstützt.

Rights

Optionaler Text-Wert. Gibt eine Gruppe von Rechten an, die der Benutzer haben muss, damit der Link angezeigt wird, z. B. "ViewListItems,ManageAlerts". Falls nicht angegeben, wird die Aktion stets in der Liste der Aktionen angezeigt. Trennen Sie zum Angeben mehrerer Rechte die Werte durch ein Komma. Die Gruppe der Rechte ist gemäß der AND-Logik logisch angepasst, was bedeutet, dass ein Benutzer alle angegebenen Rechte haben muss, um eine Aktion zu sehen. Eine Liste möglicher Werte finden Sie unter Microsoft.SharePoint.SPBasePermissions.

RootWebOnly

Optionaler Boolean-Wert. TRUE zum Bereitstellen der benutzerdefinierten Aktion ausschließlich für Stammwebsites. Dieses Attribut gibt für benutzerdefinierte Aktionen in einer Lösung mit eingeschränkter Sicherheitsstufe.

ScriptSrc

Optionaler Text-Wert. Gibt eine Datei an, die auszuführendes Skript enthält. Dieses Attribut gilt nur, wenn das Location-Attribut auf ScriptLink festgelegt ist.

ScriptBlock

Optionaler Text-Wert. Gibt einen auszuführenden Skriptblock an. Dieses Attribut gilt nur, wenn das Location-Attribut auf ScriptLink festgelegt ist.

Sequence

Optionaler Integer-Wert. Gibt die Priorität der Reihenfolge für Aktionen an.

ShowInLists

Dieses Attribut ist veraltet und sollte nicht verwendet werden.

Optionaler Boolean-Wert. TRUE, wenn die benutzerdefinierte Aktion nur für Listen auf der Seite zur Verwaltung von Inhaltstypen angezeigt wird. Der Standardwert ist FALSE.

ShowInReadOnlyContentTypes

Optionaler Boolean-Wert. TRUE, wenn die benutzerdefinierte Aktion nur für schreibgeschützte Inhaltstypen auf der Seite zur Verwaltung von Inhaltstypen angezeigt wird. Der Standardwert ist FALSE.

ShowInSealedContentTypes

Optionaler Boolean-Wert. TRUE, wenn die benutzerdefinierte Aktion nur für gesperrte Inhaltstypen auf der Seite zur Verwaltung von Inhaltstypen angezeigt wird. Der Standardwert ist FALSE.

Title

Erforderlicher Text-Wert. Gibt die Endbenutzerbeschreibung dieser Aktion an.

UIVersion

Optionaler Integer-Wert. Gibt die Version der Benutzeroberfläche an, auf der diese benutzerdefinierte Aktion aufgeführt werden soll.

Untergeordnete Elemente

CommandUIExtension

UrlAction

Übergeordnete Elemente

Elements

Vorkommen

Minimum: 1

Maximum: Unbegrenzt

Hinweise

Mit dem CustomAction-Element können Sie standardmäßige ASP.NET-Steuerelemente und Benutzersteuerelemente (z. B. Textfelder oder Optionsschaltflächen) als benutzerdefinierte Aktionen zu Symbolleisten hinzufügen. Sie können jedoch nur Steuerelemente hinzufügen, die Menüelemente in den Dropdownmenüs von Symbolleisten instanziieren. Sie können keine Webpart- oder beliebigen Steuerelemente hinzufügen.

Beispiel

Das folgende Beispiel ist Teil eines Features, das eine Schaltfläche auf dem Menüband für die Serverkomponente ersetzt.

<Elements xmlns="https://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

Konzepte

Benutzerdefinierte Standardaktionsspeicherorte und IDs