SharePoint Development & Administration + InfoPath

• 1.1 Add a link to the New Menu for a Document Library in SharePoint 2010
• 1.2 Add a control to the “New” Group on the Ribbon for a Document Library in SharePoint 2010

• 2.1 Add a link to the Actions menu for a Document Library in SharePoint 2010
• 2.2 Add a Control to the View Format Group on the Ribbon for a Document Library
• 2.3 Add a Control to the “Connect & Export” group on the Ribbon for a Document Library (Document Library Actions)
• 2.4 Customise the Share & Track Group

• 3.1 Add a link to the Settings Menu for a Document Library in SharePoint 2010
• 3.2 Add A Control to the Customise Library Group on the Ribbon for a Document Library
• 3.3 Add A Control to the Settings Group on the Ribbon for a Document Library

• 4.1 Add a link to the Edit Control Block (item drop-down) menu for a Document
• 4.2 Add a Control to the “Manage” group on the Ribbon for Documents
• 4.3 Add a Control to the “Share & Track” (Share) Group on the Ribbon for a Document Library
• 4.4 Add a Control to the “Workflows” Group on the Ribbon for a Document Library

• 5.1 Add a link to the Settings Page for a Document Library in SharePoint 2010

1.2 Add a control to the “New” Group on the Ribbon for a Document Library in SharePoint 2010















CustomAction Registration ID: 101
CustomAction Location: CommandUI.Ribbon
CommandUIDefinition Location: Ribbon.Documents.New.Controls._children




2. Customise the Interface for the Actions Menu and Library Action Groups on the Ribbon
2.1 Add a link to the Actions menu for a Document Library in SharePoint 2010
The CustomAction below is added to the Actions dropdown menu on the toolbar.  Similar to in example 1.1 the Actions menu for Document Libraries is often not displayed by default, so I would recommend adding a control to the relevant group on the Ribbon instead using one of the examples below.  











CustomAction Registration ID: 101
CustomAction Location: Microsoft.SharePoint.StandardMenu
CustomAction Group ID: ActionsMenu




2.2 Add a Control to the View Format Group on the Ribbon for a Document Library
This will add a new control to the View Format group under the Library tab on the Ribbon when viewing a document library in SharePoint 2010.










CustomAction Registration ID: 101
CustomAction Location: CommandUI.Ribbon
CommandUIDefinition Location: Ribbon.Library.ViewFormat.Controls._children




2.3 Add a Control to the “Connect & Export” group on the Ribbon for a Document Library (Document Library Actions)
This adds a new action to the Connect & Export group in the Library Tab for Document Libraries.











CustomAction Registration ID: 101
CustomAction Location: CommandUI.Ribbon
CommandUIDefinition Location: Ribbon.Library.Actions.Controls._children



2.4 Customise the Share & Track Group
See example 4.3 for information about the Share & Track Group on the Library tab.  To add or replace a control on this group on the Library Tab the Location attribute of the CommandUIDefinition would be Ribbon.Library.Share.Controls._children.
 

To maintain consistency with the built in commands on the Ribbon, actions in this group should be executed at the Library level and not the item level.  Share & Track Actions for specific items should be included in the Documents -> Share & Track group instead (example 4.3).


CustomAction Registration ID: 101
CustomAction Location: CommandUI.Ribbon

CommandUIDefinition Location: Ribbon.Library.Share.Controls._children

 

3. Customise the Settings Menu and Library Management / Settings Groups on the Ribbon
3.1 Add a link to the Settings Menu for a Document Library in SharePoint 2010
This CustomAction is added to the Settings dropdown menu for Document Libraries.  As explained in examples 1.1 and 2.1, the Settings menu is not always displayed for libraries in SharePoint 2010 as the equivelant functionality (and more) is included in the Ribbon.  The examples below (3.2 and 3.3) can be used to include a custom action as a new control on the Ribbon instead if required.








CustomAction Registration ID: 101
CustomAction Location: Microsoft.SharePoint.StandardMenu
CustomAction Group ID: SettingsMenu




3.2 Add A Control to the Customise Library Group on the Ribbon for a Document Library
The example below will include a new control in the existing “Customize Library” group under the Library tab on the Ribbon.





 



CustomAction Registration ID: 101
CustomAction Location: CommandUI.Ribbon
CommandUIDefinition Location: Ribbon.Library.CustomizeLibrary.Controls._children




3.3 Add A Control to the Settings Group on the Ribbon for a Document Library
This will add a new control to the Settings group on the Library tab for Document Libraries in SharePoint.





 



CustomAction Registration ID: 101
CustomAction Location: CommandUI.Ribbon
CommandUIDefinition Location: Ribbon.Library.Settings.Controls._children



4. Item Level Customisations to the Interface and Ribbon
The examples in this section relate to item level actions executed from the Edit Control Block (item dropdown menu) or from the Ribbon.  The controls added to the Ribbon in the examples below are configured to be enabled only when one or more documents are selected.


4.1 Add a link to the Edit Control Block (item drop-down) menu for a Document
This will add a new link/action to the Edit Control Block (document edit dropdown menu) for documents in a Library.











CustomAction Registration ID: 101
CustomAction Location: EditControlBlock



4.2 Add a Control to the “Manage” group on the Ribbon for Documents
This control is included in the Manage group from the Documents tag on the Ribbon, and is enabled when one document is selected from the library on the page.  This is achieved by including an EnabledScript attribute in the CommandUIHandler element, which includes JavaScript that determines if and how many documents have been selected from the list on the page.  The JavaScript returns true to enable the control in the Ribbon, or false to disable the control.  In this case, one document must be selected for the control to be enabled.  If no documents are selected, or more than one document, the control will be disabled.









CustomAction Registration ID: 101
CustomAction Location: CommandUI.Ribbon
CommandUIDefinition Location: Ribbon.Documents.Manage.Controls._children




4.3 Add a Control to the “Share & Track” (Share) Group on the Ribbon for a Document Library
This will add a new control to the Share & Track group on the Document tab.  The “Share & Track” group is also available from the Library tab on the Ribbon, but has different functionality.  From the Documents tab, one or more Documents generally need be selected before the built in commands are available, which will run on the selected document(s) only.  Controls in the “Share & Track” group on the Library Tab are run on the Library and not specific items/documents.


Similar to example 4.2, the EnabledScript attribute in the CommandUIHandler element that corresponds to this action is used to disable the control if there are no documents selected, or more than one.









CustomAction Registration ID: 101
CustomAction Location: CommandUI.Ribbon
CommandUIDefinition Location: Ribbon.Documents.Share.Controls._children



4.4 Add a Control to the “Workflows” Group on the Ribbon for a Document Library
This includes a new control in the Workflows group on the Documents tab.  The EnabledScript attribute similar to Examples 4.2 and 4.3 in the CommandUIHandler element is used to disable the control if there are no documents selected.  In this example, the Control will be enabled if one or more documents are selected on the page.  The control will only be disabled when there are no documents selected on the page.







 


CustomAction Registration ID: 101
CustomAction Location: CommandUI.Ribbon
CommandUIDefinition Location: Ribbon.Documents.Workflow.Controls._children



5. Customise the Document Library Settings Page
5.1 Add a link to the Settings Page for a Document Library in SharePoint 2010
This example includes a new link on the Document Library Settings page.  The Location and Group ID used in this example will add a new custom link under the General Settings heading on the page. 










CustomAction RegistrationId: 101
CustomAction Location: Microsoft.SharePoint.ListEdit.DocumentLibrary
CustomAction Group ID: GeneralSettings


The Group IDs that correspond to other headings on the settings page are below.  The location should be set to Microsoft.SharePoint.ListEdit in each case, but the GroupId attribute is change to one of the following values that correspond to each of the available headings.  Adding a new group/heading and links to the settings page is also possible, but not covered in this tutorial.






Next Post in the series: Customise the menu and settings page User Interface for built-in List types in SharePoint 2010
In the next post, I will be covering how to customise the interface and Server Ribbon for standard Lists in SharePoint 2010, such as Task lists, Links Lists, Calendars, etc.  The examples will include custom actions for a range of different list types, and will cover adding new controls to groups that differ from the examples in this tutorial.  




References and Related Resources:

Apply Permissions to Custom UI Links / Actions in SharePoint Menus and Settings Pages
This tutorial demonstrates how to restrict custom actions based on user permissions from the SPBasePermissions enumeration in the Rights attribute as well as other properties from the CustomAction class.


Add Custom Links to the SharePoint 2010 UI as a Feature with or without using Visual Studio
This article demonstrates how to implement Custom Actions in SharePoint as a feature:

• Using Visual Studio (incorporating into a SharePoint project), or
• Without Visual Studio(manually creating feature XML files and installing using PowerShell or STSADM).

Tutorial: Add Custom List actions using SharePoint Designer 2010
This article demonstrates how to add Custom Actions to lists and libraries using OOB functionality in SharePoint Designer 2010.


List of RegistrationId’s for List Template Types (WSS 3.0, MOSS 2007 and SharePoint 2010)
This article by Mike Smith provides an extensive list of the built-in list templates and corresponding RegistrationIds. Sample code is also included to list the values from the SPListTemplateType enum.


Customizing and Extending the SharePoint 2010 Server Ribbon
This article by Andrew Connell provides a very detailed step by step tutorial for extending the SharePoint 2010 Ribbon using examples.  A download of code for the sample Ribbon customisations is also provided.