CustomAction, élément
S’applique à : SharePoint 2016 | SharePoint Foundation 2013 | SharePoint En ligne | SharePoint Server 2013
Définit une extension pour l’interface utilisateur, telle qu’un bouton sur une barre d’outils ou un lien sur une page de paramètres du site.
Définition
<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>
Éléments et attributs
Les sections suivantes décrivent les attributs, les éléments enfants et les éléments parents.
Attributs
Attribut |
Description |
|---|---|
**RequiredAdmin** |
**Text** facultatif. Spécifie les droits d’administration requis pour l’application de l’action personnalisée. Cette valeur permet d'ajuster les liens dans l’Administration centrale. Les valeurs possibles sont les suivantes :
|
**ControlAssembly** |
**Text** facultatif. Spécifie l'assembly d'un contrôle qui prend en charge l'action personnalisée. |
**ControlClass** |
**Text** facultatif. Spécifie une classe de contrôle qui prend en charge l'action personnalisée. |
**ControlSrc** |
Texte **facultatif**. Spécifie l’URL relative du fichier .ascx qui sert de source pour l’action personnalisée, par exemple, `"~/_controltemplates/myCustomAction.ascx"` . |
**Description** |
**Text** facultatif. Spécifie une description plus longue pour l'action qui est exposée comme une info-bulle ou une sous-description de l'action. |
**FeatureId** |
**Text** facultatif. Identifie le Composant fonctionnel associé à l’action personnalisée. |
**GroupId** |
Texte **facultatif**. Identifie un groupe d’actions qui contient l’action, par exemple, `"SiteManagement"` . Si elle appartient à un groupe d’actions personnalisées, la valeur de l’attribut **GroupId** doit correspondre à l’ID de groupe de l’élément CustomActionGroup. Pour obtenir la liste des ID de groupe d’actions personnalisées par défaut utilisés dans Microsoft SharePoint Foundation, voir Default Custom Action Locations and IDs. |
**Id** |
**Text** facultatif. Spécifie un identificateur unique pour l’action personnalisée. L’ID peut être un GUID ou un terme unique, par `"HtmlViewer"` exemple. |
**ImageUrl** |
**Text** facultatif. Spécifie un lien relatif du serveur virtuel vers une image qui présente une icône de l'élément. |
**Location** |
Texte **facultatif**. Spécifie l’emplacement de cette action personnalisée, par exemple, `"Microsoft.SharePoint.SiteSettings"` . Si l’élément **CustomAction** contient un élément enfant **CommandUIExtension**, **Location** doit commencer par « CommandUI.Ribbon ». Pour obtenir la liste des emplacements par défaut utilisés avec le ruban serveur, voir Default Server Ribbon Customization Locations. Si l’action personnalisée est un élément de menu ou de barre d’outils, les options possibles sont **EditControlBlock**, **NewFormToolbar**, **DisplayFormToolbar** et **EditFormToolbar**. Si elle appartient à un groupe d’actions personnalisées, la valeur de l’attribut **Location** doit correspondre à l’emplacement de l’élément CustomActionGroup. Pour obtenir la liste des emplacements d’actions personnalisées par défaut utilisés dans SharePoint Foundation, voir Default Custom Action Locations and IDs. |
**RegistrationId** |
**Text** facultatif. Spécifie l'identificateur de la liste ou du type de contenu de l'élément auquel cette action est associée, ou le type de fichier ou l'identificateur du programme (**ProgID**). |
**RegistrationType** |
**Text** facultatif. Spécifie la pièce jointe d'inscription pour une action par élément. Les valeurs possibles sont les suivantes :
|
**RequireSiteAdministrator** |
Facultatif **Boolean**. **TRUE** pour spécifier que l’élément doit être affiché uniquement si l’utilisateur est un administrateur de site ; sinon, **FALSE**. **L’utilisation de l’attribut RequireSiteAdministrator** pour le menu déroulant des commandes SharePoint Foundation associées à des éléments de liste n’est pas prise en charge. |
**Rights** |
Texte **facultatif**. Spécifie un ensemble de droits dont l’utilisateur doit avoir pour que le lien soit visible, par exemple, `"ViewListItems,ManageAlerts"` . S’il n’est pas spécifié, l’action apparaît toujours dans la liste des actions. Pour spécifier plusieurs droits, séparez les valeurs à l’aide de virgules. Les droits sont regroupés logiquement en fonction de l’opérateur logique **AND**, ce qui signifie qu’un utilisateur doit disposer de tous les droits spécifiés pour voir une action. Pour obtenir la liste des valeurs possibles, voir Microsoft.SharePoint. SPBasePermissions. |
**RootWebOnly** |
Facultatif **Boolean**. **TRUE** pour déployer l’action personnalisée uniquement dans les sites Web racines. Cet attribut s’applique aux actions personnalisées dans une solution en bac à sable( sandbox). |
**ScriptSrc** |
**Text** facultatif. Spécifie un fichier qui contient un script à exécuter. Cet attribut n’est applicable que lorsque l’attribut **Location** est défini sur **ScriptLink**. |
**ScriptBlock** |
**Text** facultatif. Spécifie un bloc de script à exécuter. Cet attribut n’est applicable que lorsque l’attribut **Location** est défini sur **ScriptLink**. |
**Sequence** |
**Integer** facultatif. Spécifie la priorité du classement des actions. |
**ShowInLists** |
Cet attribut est désapprouvé et ne doit pas être utilisé. **Boolean** facultatif. **TRUE** si l’action personnalisée s’affiche uniquement pour les listes sur la page de gestion des types de contenu. La valeur par défaut est **FALSE**. |
**ShowInReadOnlyContentTypes** |
**Boolean** facultatif. **TRUE** si l'action personnalisée s'affiche uniquement pour les types de contenu en lecture seule sur la page de gestion des types de contenu. La valeur par défaut est **FALSE**. |
**ShowInSealedContentTypes** |
**Boolean** facultatif. **TRUE** si l'action personnalisée s'affiche uniquement pour les types de contenu verrouillé sur la page de gestion des types de contenu. La valeur par défaut est **FALSE**. |
**Title** |
**Text** obligatoire. Spécifie la description utilisateur final de cette action. |
**UIVersion** |
**Integer** facultatif. Spécifie la version de l’interface utilisateur dans laquelle cette action personnalisée doit être répertoriée. |
Éléments enfants
Éléments parents
Occurrences
Minimum : 1 Maximum : pas de limite |
Remarques
Vous pouvez utiliser l'élément CustomAction pour ajouter des contrôles ASP.NET standard et des contrôles utilisateur (par exemple, des zones de texte ou des cases d'option) en tant qu'actions personnalisées dans les barres d'outils. Toutefois, vous pouvez ajouter uniquement des contrôles insérant des éléments de menu dans les menus déroulants des barres d’outils . vous ne pouvez pas ajouter de composants Web Parts ou de contrôles arbitraires.
Exemple
L’exemple suivant fait partie d’une fonctionnalité qui remplace un bouton sur le ruban serveur.
<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>