Welcome!

Microsoft Cloud Authors: Kevin Benedict, Pat Romanski, Liz McMillan, Lori MacVittie, Elizabeth White

Blog Feed Post

Creating SharePoint Ribbon Custom Actions with Visual Studio 2012

Let’s face it.  In SharePoint 2010, creating ribbon custom actions was not a very pleasant experience.  You had to know the inner workings of the XML and the black-magic behind selecting the right Id in the CommandUIDefinition.  We had community tools like CKSDEV to help though.  Now, I am happy to see that a new Ribbon Custom Action SharePoint Project Item slipped into Preview 2 of the Office Developer Tools.  This new SPI provides a nice wizard interface to guide you through the process of creating an action.  Let’s take a look at it.

First, you’ll need to create a new SharePoint App project.  The downside of the tool is that it is only available for SharePoint apps.  It’s not in regular SharePoint 2013 projects.  In my example today, I am going to attach a custom action to a list item to take the user back to the default.aspx application page.  Of course, you can use traditional techniques as before to add JavaScript, pass parameters, and whatever else you need to do.  I just want to show you what the wizard looks like today.

In the Add New Item menu, you’ll see the new wizard here.  Choose Ribbon Custom Action and give it a name.

RibbonCustomActionSPI

Note, that there is also a new Menu Item Custom Action template as well.  When you click Add, you will be taken to the next step in the Wizard.  Here you first need to choose whether you will apply this to the Host Web or the App Web.  Remember that the App Web that has all of the pieces of your app and the Host Web is the site that hosts an instance of your app.  One way you might use this new feature is that a user clicks on an item in the host web, uses the ribbon action and gets redirected to your app.

You have the ability to bind the custom action to a list template or a list instance.  If Host Web is selected, selecting List Instance will provide you with a list of all instance on the particular host web that your app is currently configured to publish to.  Otherwise, if you choose List Template, it will provide you a list of common templates.  I don’t think the Wizard will let you pick a custom template, so you would probably have to edit the XML manually when you are done.

CustomRibbonActionWizardHostWebListTemplate

In my case, I have chosen App Web and then a specific List Instance.  It knows to look through the List Instances you have in your project and put them in the list.

CustomRibbonActionWizardAppWebListInstance

When you continue to the next step, it will allow you to specify the location of the ribbon, the text to display, and what page the user should be redirected to when clicking the link.  You can select any existing ASP.NET page in the project for the action to navigate to.  If you want to execute JavaScript instead, you would need to edit the XML once you complete the wizard.

RibbonCustomActionWizardStep2

It provides you with a list of locations that the control can be located at:

RibbonCustomActionWizardStep2ControlLocation

When you are finished, Visual Studio generates the XML that you need.  You can make edits as necessary.  However, at this point there is no going back to the Wizard and making changes.  If you want the Wizard again, you’ll have to delete the item and recreate it.

RibbonCustomActionXml

At this point we can run the project and go to the list that we set the action on.  Selecting the list item, will expose the action in the ribbon.

RibbonCustomActionVisibleOnList

Clicking on the Ribbon Action, I then get redirected to my app home page.

RibbonCustomActionDefault

I’m pretty excited about this feature since I have always struggled with creating custom actions.  I think this will make it much easier to create actions now.  This is important because this is one of the key ways to link between the host web and the app web.  Unfortunately, this action is only present in Apps, but you could always cut and paste it into another project.  You could also likely take the code it generates and use it in your SharePoint 2010 projects as well.

Read the original blog entry...

More Stories By Corey Roth

Corey Roth, a SharePoint Server MVP, is an independent consultant specializing in Cloud technologies such as Azure and Office 365. He also specializes in mobile development. Corey serves as the product manager for two cloud-first mobile app platforms: BrewZap and HappenZap.

IoT & Smart Cities Stories
Cloud-enabled transformation has evolved from cost saving measure to business innovation strategy -- one that combines the cloud with cognitive capabilities to drive market disruption. Learn how you can achieve the insight and agility you need to gain a competitive advantage. Industry-acclaimed CTO and cloud expert, Shankar Kalyana presents. Only the most exceptional IBMers are appointed with the rare distinction of IBM Fellow, the highest technical honor in the company. Shankar has also receive...
DXWorldEXPO LLC announced today that ICOHOLDER named "Media Sponsor" of Miami Blockchain Event by FinTechEXPO. ICOHOLDER gives detailed information and help the community to invest in the trusty projects. Miami Blockchain Event by FinTechEXPO has opened its Call for Papers. The two-day event will present 20 top Blockchain experts. All speaking inquiries which covers the following information can be submitted by email to [email protected] Miami Blockchain Event by FinTechEXPOalso offers sp...
DXWordEXPO New York 2018, colocated with CloudEXPO New York 2018 will be held November 11-13, 2018, in New York City and will bring together Cloud Computing, FinTech and Blockchain, Digital Transformation, Big Data, Internet of Things, DevOps, AI, Machine Learning and WebRTC to one location.
@DevOpsSummit at Cloud Expo, taking place November 12-13 in New York City, NY, is co-located with 22nd international CloudEXPO | first international DXWorldEXPO and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The widespread success of cloud computing is driving the DevOps revolution in enterprise IT. Now as never before, development teams must communicate and collaborate in a dynamic, 24/7/365 environment. There is no time t...
Headquartered in Plainsboro, NJ, Synametrics Technologies has provided IT professionals and computer systems developers since 1997. Based on the success of their initial product offerings (WinSQL and DeltaCopy), the company continues to create and hone innovative products that help its customers get more from their computer applications, databases and infrastructure. To date, over one million users around the world have chosen Synametrics solutions to help power their accelerated business or per...
Charles Araujo is an industry analyst, internationally recognized authority on the Digital Enterprise and author of The Quantum Age of IT: Why Everything You Know About IT is About to Change. As Principal Analyst with Intellyx, he writes, speaks and advises organizations on how to navigate through this time of disruption. He is also the founder of The Institute for Digital Transformation and a sought after keynote speaker. He has been a regular contributor to both InformationWeek and CIO Insight...
When talking IoT we often focus on the devices, the sensors, the hardware itself. The new smart appliances, the new smart or self-driving cars (which are amalgamations of many ‘things'). When we are looking at the world of IoT, we should take a step back, look at the big picture. What value are these devices providing. IoT is not about the devices, its about the data consumed and generated. The devices are tools, mechanisms, conduits. This paper discusses the considerations when dealing with the...
Machine learning has taken residence at our cities' cores and now we can finally have "smart cities." Cities are a collection of buildings made to provide the structure and safety necessary for people to function, create and survive. Buildings are a pool of ever-changing performance data from large automated systems such as heating and cooling to the people that live and work within them. Through machine learning, buildings can optimize performance, reduce costs, and improve occupant comfort by ...
Digital Transformation is much more than a buzzword. The radical shift to digital mechanisms for almost every process is evident across all industries and verticals. This is often especially true in financial services, where the legacy environment is many times unable to keep up with the rapidly shifting demands of the consumer. The constant pressure to provide complete, omnichannel delivery of customer-facing solutions to meet both regulatory and customer demands is putting enormous pressure on...
Bill Schmarzo, Tech Chair of "Big Data | Analytics" of upcoming CloudEXPO | DXWorldEXPO New York (November 12-13, 2018, New York City) today announced the outline and schedule of the track. "The track has been designed in experience/degree order," said Schmarzo. "So, that folks who attend the entire track can leave the conference with some of the skills necessary to get their work done when they get back to their offices. It actually ties back to some work that I'm doing at the University of San...