Click here to Skip to main content
Click here to Skip to main content
Technical Blog

Tagged as

SharePoint 2013 and SharePoint 2010 Delegate Controls

, 4 Mar 2013 CPOL
Rate this:
Please Sign up or sign in to vote.
A mechanism to inject a code or control to the SharePoint Master page with out touching any any code in the SharePoint Master page.

SharePoint Delegate control is a mechanism that we can inject a code or control to the SharePoint Master page with out touching any any code in the SharePoint Master page.

is a container type control which can holds child controls on it

This is the simplest explanation for the SharePoint delegate controls but this also may confuse to you. So let me further simplify.

SharePoint Master Page design in a way that leaving place holders (Not a place holder really but for get an idea) to some controls (Delegate Controls) that has a machinist to inject.

Assume this is our SharePoint Master page.

image

The Red Rectangle (SmallSearchInputBox) is a delegate control. It means the textbox and other functionalities in that search box not written in the  master page. Master page just have a place holder with id SmallSearchInputBox and which is going to dynamically replace by search box in the run time.

Master Page code is just look like this.

image

There are few delegate controls defined in the SharePoint Master page.

Why We need Delegate Controls

  1. We can inject controls to master page with out changing any code. For an example you need a custom control to put in the place of small search box. So you can create a control and activate the control using a feature. Then control will display in the place of search box but good thing is you didn’t touch any master page code.
  2. You can customize the master page delegate controls dynamically  by user permissions, URLs, or any other custom rule.
  3. Recently we have a problem that we need to include some custom user validation for each and every SharePoint page. So we finally decided to  put that code in AdditionalPageHead so it will get apply to all pages and we need to simply create a control to inject to the delegate control.

SharePoint 2010 and SharePoint 2013

AdditionalPageHead

  • This is top most delegate control in the master page. this delegate allows multiple controls. You can use this delegate to inject JavaScript to SharePoint master , inject custom logic and etc. page. The good thing about the AdditionalPageHead control is it is lie between the HTML head tag. therefore it is not a control with interface. You can specify a control which only have a code to do what ever you need in onLoad event.

GlobalNavigation

  • Global navigation is top most visible control collection. You can add your delegate controls to this location as well.

image
GlobalSiteLink3

  • this delegate control handles social icons in the site. you can change this two icons by creating delegate control


image 

GlobalDelegate2

  • SharePoint dashboard control handles using this  delegate.

image

GlobalDelegate0

  • you can change this menu (may be add more items to it) using this delegate control.

image

PublishingConsole

  • This delegate control holds the server ribbon. normally we didn't use it for customize the server ribbon. of cause if you want you can..

TopNavigationDataSource

  • This delegate use for default top navigation. You can override the data source by adding a custom data source.

SmallSearchInputBox

  • This control handles small search control in the master page.

image

QuickLaunchDataSource

  • This delegate control provides mechanism to override left side panel. So you can  create your own data source and set it as a Quick launch data source with out changing the master page.

TreeViewAndDataSource

  • Tree view is the other navigation apart from quick launch and top link. So you can change tree view’s default data source by providing custom data source to this delegate.

New Delegate controls in SharePoint 2013

SuiteLinksDelegate

  • This delegate handles these links in SharePoint 2013. so if you want to add a another link or some other component this is the delegate you need to use.

image

SuiteBarBrandingDelegate

  • This delegate care about top left site logo and text. If you are interested in any other you can put it in here.

image

PromotedActions

  • You can add controls in between Share and Follow. This holds empty controllers by default.

image

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Melick

Sri Lanka Sri Lanka
No Biography provided

Comments and Discussions

 
Question[My vote of 1] I hate finding someone ripped off a page from somewhere else and took credit PinmemberMember 438746217-Oct-13 13:59 
GeneralMy vote of 4 PinmemberPaga Cession26-Jul-13 8:47 
QuestionCan you include code for doing something with the SuiteLinksDelegate? PinmemberPaga Cession26-Jul-13 8:47 
QuestionNeed code sample PinmemberD I Petersen3-Jul-13 6:28 
GeneralMy vote of 4 PinmemberShabbazz13-Apr-13 1:45 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web01 | 2.8.141216.1 | Last Updated 4 Mar 2013
Article Copyright 2013 by Melick
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid