Skip to main content

SharePoint 2013 and SharePoint 2010 Delegate Controls

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 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

Comments

Popular posts from this blog

How to Customize New Item Form to take parameters from Query String in the SharePoint 2010

In here I'm going to explain how to customize the SharePoint Item From to take parameters from Query String and set them as default values using SharePoint designer. Using this you can open a new Item From by providing parameters as query string. For an example you can customize one item Display form and taking query String Parameter from that and view New Item view for another list by providing default values using the Query String.     Steps Open the SharePoint designer and go to list and libraries and open the list that you want. Click the New and create a New Insert View by providing the name of the view.   Then created one will come to the list. then click and open the view. Then default New Item Screen will be loaded as follows. Then Delete the default list view and make that empty. You can delete the controls by selecting the area in the design view, If it fully cleared you can view the following message from the designer. Then go to SharePoint...

How to Link Two List and Create a combine view in the SharePoint 2010

In this way you can join multiple list together and can create a combine view. for an example assume that you are managing a list for some events. And also you are having a participants in separate list. Thus you want to join the two list and create a composite view. SharePoint 2010 allows you to create this kind of view using  Linked Data Source. in this approach you can create your own custom list in the SharePoint. How to Create a Linked Data source Go to SharePoint designer and  go to the link called data sources. And Click the Linked Data Source button in the ribbon. Then SharePoint designer will prompt following kind of a dialog. In there add two list, that you wan to linked together. I'm adding airline schedule and booking list. those are the two list that i wan to merge. then click next. And it will guide you another screen. it will ask you to select either Merge Merge use to combine list which are having same columns definition. for and example we can s...

Complete guide to Install SharePoint in a Three Server Farm using AutpSPInstaller

This article will be divided to three sections Setting up the Environment and Service Accounts Getting Ready with AutoSPInstaller Online Configuring the XML using Online Editor and Installation Setting up the Environment and Service Accounts AutoSPInstaller Online is one of a great project that facilitate Automated SharePoint installation including Sharepoint 2010, 2013 and 2016. Auto SP Installer provides a powerful way to deploy and configure a single-server development environment to multiple-server SharePoint farm. Reference: https://autospinstaller.com/ Before doing anything we will set up the environment for SharePoint three server Farm. Will name these servers as SPWFE - Share Point Front End Server SPAPP - Share Point App server SPDB - DB server Please find the reference for SharePoint minimum requirement and practices from https://docs.microsoft.com/en-us/SharePoint/install/install-sharepoint-server-2016-across-multiple-servers For the the medium segregation, we have to create...