- Sitecore Cookbook for Developers
- Yogesh Patel
- 680字
- 2021-07-16 11:15:02
Adding a custom command to item context menu
The context menu is designed to increase the efficiency of content authors. The requirements may vary for content authors across different organizations.
In this recipe, we will create a menu item in the context menu of a Sitecore item that will display the number of children that the selected item contains. In the same way, you will be able to create a command button for the Content Editor and Experience Editor ribbons as well.
How to do it…
We will first create a Command class:
- In the
SitecoreCookbookproject, create aGetChildCountclass in theCommandsfolder. Inherit the class fromSitecore.Shell.Framework.Commands.Command. - Override the
Execute()method of theCommandclass to apply a command action as follows:public override void Execute(CommandContext context) { if (context.Items.Length == 1) { Item currentItem = context.Items[0]; SheerResponse.Alert(string.Format("Children count: {0}", currentItem.Children.Count)); } } - Override the
QueryState()method of theCommandclass to show or hide the button, which means changing the state of the command based on its children count. Here, when an item does not have any children, we hide the command:public override CommandState QueryState(CommandContext context) { if (context.Items.Length == 1) { Item currentItem = context.Items[0]; if (currentItem.Children.Count == 0) return CommandState.Hidden; } return base.QueryState(context); } - Open the
\App_Config\Commands.configfile, and add the following command above the</configuration>node with the fully qualified name of the class created in step 1:<command name="item:getchildcount" type="SitecoreCookbook.Commands.GetChildCount, SitecoreCookbook" /> - Open the Sitecore desktop mode and switch the database to
core. Open the Content Editor and select the/sitecore/Content/Applications/Content Editor/Context Menus/Defaultitem. Create a new item,Child Count, in it using the/sitecore/templates/System/Menus/Menu itemtemplate. - Enter field values in the item, as shown in the following image. Here,
item:getchildcountis the command that we created in theCommands.configfile in step 4:
- Now, right-click on any item in the content tree of the Content Editor; you will get a new menu item Count Children in the context menu, as shown on the left-hand side of the following image. Clicking on it will show an alert box displaying the number of children that it contains:
How it works…
The following image shows you how Sitecore renders the menu item in HTML. When the menu item is clicked, the scForm.postEvent() JavaScript method is called with parameters of the current event and an item:getchildcount(id=$Target) message, which passes these parameters to the Sitecore command engine:
When Sitecore receives the message from the browser, it first interprets it and extracts the command name (item:getchildcount) and parameters (id={$Target}). Then, based on the commands from Commands.config, it invokes the Execute() method of the respective class where we can write our custom logic.
Here, if you see step 2, the Execute() method of Command contains a parameter of the CommandContext type, where we can get parameters passed from. We can also get multiple parameters passed from the command using context.Parameters["Parameter Name"];.
In step 3, we overrode the QueryState() method, which returns CommandState to the ribbon or context menu. CommandState is the state of the menu item, which we can set as CommandState.Hidden, CommandState.Enabled, or CommandState.Disabled to hide, enable, or disable the menu item accordingly.
There's more…
We can add a custom tab (ribbon), group (Strip), or button (Chunk) to the Content Editor ribbon under the /sitecore/Content/Applications/Content Editor/Ribbons item of the core database. The button on the ribbon will look like the following image:
To create a custom button (Chunk) on the Content Editor ribbon, create an item named Count Children in /sitecore/Content/Applications/Content Editor/Ribbons/Chunks/Operations with the /System/Ribbon/Small Button item template and fill in fields as follows:
In the same way, you can find all the buttons of the Experience Editor ribbon under the /sitecore/Content/Applications/WebEdit/Ribbons/WebEdit item. You can add different types of buttons to the ribbon. You can find more details about this at https://goo.gl/4nNSQu.
See also
Sitecore provides two frameworks—Sheer UI and SPEAK—to manage user interfaces. Here, we used the Sheer UI to show an alert message. We could also use SPEAK to show an alert or open a modal dialog, which you can learn from http://goo.gl/8rFKr5.
- 深度實踐OpenStack：基于Python的OpenStack組件開發
- 程序員修煉之道：程序設計入門30講
- Spring Boot開發與測試實戰
- iOS 9 Game Development Essentials
- Mastering phpMyAdmin 3.4 for Effective MySQL Management
- Go語言高效編程：原理、可觀測性與優化
- MATLAB定量決策五大類問題
- 區塊鏈技術進階與實戰（第2版）
- Learning AWS
- QGIS 2 Cookbook
- Flink技術內幕：架構設計與實現原理
- Python 快速入門（第3版）
- Learning NHibernate 4
- HTML5+jQuery Mobile移動應用開發
- Illustrator CS6中文版應用教程（第二版）