Let's play around with our very own Sharepoint 2010 ribbon today!
So bascially, what we are trying to do is add a custom group to an OOTB ribbon tab, show values related to the selected web part in a label or a textbox.
The challenge here is, unlike simple requirements like button click on the ribbon where we get an event to work with, showing values on load of the ribbon is much more difficult
as there is no particular custom event we can work with easily, the only one available is the ribbon on load, and its OOTB!
Lets get started with it then...
1. First we create the ribbon group within a OOTB Ribbon Tab, lets work with the ribbon available on the Media part for this.
For this, we need to get the 'Location' value which will be specified in our 'CustomUIDefinition' absolutely right. Append '_children' to the 'location' in order to continue
adding the new group. Now, Add the group with required values like 'template' and 'id'. Then, add the required controls under the 'Controls' tab, here we will use a Label and a
text box. Along with this we also specify the 'command' and the 'querycommand' which actions any required event.
Next, very important!, to show the contents of the new group, we need to create a new element specifying the max size, this tells which group will have how much spacing in
order to show the contents with in. Again for this the exact location has to be specified
Code:
<CommandUIDefinition Location="Ribbon.ContextualTabs.Media.Options.Scaling._children">
<MaxSize Id="Ribbon.ContextualTabs.Media.Options.Scaling.Url" GroupId="Ribbon.ContextualTabs.Media.Options.Url" Size="MediumMedium" Sequence="50"/>
</CommandUIDefinition>
<CommandUIDefinition Location="Ribbon.ContextualTabs.Media.Options.Groups._children">
<Group
Id="Ribbon.ContextualTabs.Media.Options.Url"
Sequence="40"
Template="Ribbon.Templates.Flexible2"
Title="Url"
Description="">
<Controls Id="Ribbon.ContextualTabs.Media.Options.Url.Controls" >
<Label
Id="Ribbon.ContextualTabs.Media.Options.Url.UrlLabel"
Sequence="10"
LabelText="Url"
TemplateAlias="o1"
/>
<TextBox
Id="Ribbon.ContextualTabs.Media.Options.Url.UrlValue"
Sequence="20"
Command="Media.GetUrl"
QueryCommand="Media.GetUrl.Query"
TemplateAlias="o2"
ToolTipTitle="Url"
ToolTipDescription="To change the url of the video, go to 'Change Media' -> 'From Address'"
ShowAsLabel="true"
/>
</Controls>
</Group>
</CommandUIDefinition>
This is what you see when the above code is deployed
2. The next step is to create the javascript code required to show the values which we need on the ribbon.
The first step for this is to load the required javascript file through our CustomAction tab. This would be a loader file which would call all the required methods which in turn loads other javascript files which contains code for the actual work done behind.
One more challenge we might face here is how to load the .js files and when to load them, for us this file has to load only when the media web part is selected and not any where else as that can cause unnecessary memory blocks within the page load. The best way to do this is use _spBodyOnLoadFunctionNames.push() method. Then we need to register the .js file which contains the code for the init(), handlecommands(), etc. In the handlecommand we need to specify the 'command' and 'querycommand' used earlier, here the required code is added to get/set values in
our textbox.
Code:
<CustomAction ScriptSrc="/_layouts/myRibbon/js/.PageComponent.Loader.js"
Location="ScriptLink"
Sequence="1000" />
Code to be added in PageComponent.Loader.js
function myInit() {
RegisterSod("myRibbon.pagecomponent.js", "/_layouts/myRibbon/js/myRibbon.PageComponent.js");
SP.SOD.executeFunc("myRibbon.pagecomponent.js", null, null);
ExecuteOrDelayUntilScriptLoaded(initRibbon, 'myRibbon.PageComponent.js');
}
function initRibbon() {
myRibbon.PageComponent.initialize();
}
_spBodyOnLoadFunctionNames.push("myInit");
Code to be added in myRibbon.pagecomponent.js
Type.registerNamespace('myRibbon.PageComponent');
myRibbon.PageComponent = function () {
myRibbon.PageComponent.initializeBase(this);
};
myRibbon.PageComponent.initialize = function () {
ExecuteOrDelayUntilScriptLoaded(myRibbon.PageComponent.initializePageComponent, 'SP.Ribbon.js');
};
myRibbon.PageComponent.initializePageComponent = function () {
var ribbonPageManager = SP.Ribbon.PageManager.get_instance();
if (null !== ribbonPageManager) {
ribbonPageManager.addPageComponent(myRibbon.PageComponent.instance);
}
};
myRibbon.PageComponent.prototype = {
init: function () {
},
getFocusedCommands: function () {
return ['Media.GetUrl', 'Media.GetUrl.Query'];
},
getGlobalCommands: function () {
return ['Media.GetUrl', 'Media.GetUrl.Query'];
},
canHandleCommand: function (commandId) {
if (commandId === 'Media.GetUrl' ||
commandId === 'Media.GetUrl.Query') {
return true;
} else {
return false;
}
},
handleCommand: function (commandId, properties, sequence) {
if (commandId === 'Media.GetUrl.Query') {
alert('the textbox values will show!')
}
},
isFocusable: function () {
return true;
},
receiveFocus: function () {
return true;
},
yieldFocus: function () {
return true;
}
};
myRibbon.PageComponent.registerClass('myRibbon.PageComponent', CUI.Page.PageComponent);
myRibbon.PageComponent.instance = new myRibbon.PageComponent();
NotifyScriptLoadedAndExecuteWaitingJobs('myRibbon.pagecomponent.js');
This is the end result what you see...
Well, thats it for now with Ribbons in Sharepoint 2010.
