Thursday, February 28, 2013

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

Monday, February 11, 2013

How to use SharePoint Emulator to test SharePoint list creation,Update

Open the visual studio 2012 and add empty SharePoint project.

image 

Then create the project as farm solution by giving the testing SharePoint server URL (you can give sandbox solution as per your requirement)

image

Then I'm going to add a feature ; which is going to create a SharePoint list in feature activation.

image

(adding a feature receiver to the feature)

image

Now I'm going to add a class (SPController.cs) which is used in Feature Activation event for creating the list in the SharePoint. SPController class having a method called AddListSample() that is use for create a list in the SharePoint.

public class SPController
{
public void AddListSample(String siteURL, String listName, String description)
{
using (SPSite site = new SPSite(siteURL))
{
using (SPWeb web = site.OpenWeb())
{
Guid listguide = web.Lists.Add(listName, description, SPListTemplateType.GenericList);
SPList list = web.Lists[listguide];

list.Fields.Add("CustomerName", SPFieldType.Text, true);
list.Fields.Add("DOB", SPFieldType.DateTime, false);

list.Update();
}
}
}
}


Now we are adding the code to Feature to create the list.


public override void FeatureInstalled(SPFeatureReceiverProperties properties)
{
SPController spcontroller = new SPController();
spcontroller.AddListSample(SPContext.Current.Site.Url, "SampleList", "List Description");
}


Now we are going to test our code using SharePoint simulator.


For that we need to create a Test Project First (Framework 3.5)


image


Then we need to create a test class for test SPContollerClass. So im adding SPControllerTest Class to the test Project.


image


image


Before coding we need to install SharePoint Simulator uisng NuGet Manager. (This will download fake dlls for the  emulation purpose)


image


image


Now you are going to test the AddListSample Method.


image


Note: By using Emulation.Mode.Enabled this code will test in the Emulated SharePoint environment.


You can go to Test Menu and can Run or Debug the code.


image


image


Test result will display on left side of the screen. It will show failed test as well as Passed ones.


image

Sunday, February 10, 2013

Could not load file or assembly 'System.Web.2.0.0.0.Fakes

 

Test method VisualWebPartProject1Test.SPControllerTest.CreateListTest threw exception:
System.IO.FileNotFoundException: Could not load file or assembly 'System.Web.2.0.0.0.Fakes, Version=2.0.0.0, Culture=neutral, PublicKeyToken=0ae41878053f6703' or one of its dependencies. The system cannot find the file specified.WRN: Assembly binding logging is turned OFF.
To enable assembly bind failure logging, set the registry value [HKLM\Software\Microsoft\Fusion!EnableLog] (DWORD) to 1.
Note: There is some performance penalty associated with assembly bind failure logging.
To turn this feature off, remove the registry value [HKLM\Software\Microsoft\Fusion!EnableLog].
Result StackTrace

This error occurred to me when i try to test a SharePoint emulator with a test project.I tried in many ways and it is a simple code; but i wonder why it is  giving this error. i but the dlls to bin and did various things but nothing worked for me. then what i did was

1. First Uninstall the existing emulator from the project (By navigating to NuGet Manger).

1 

2. Then change the Test Project Framework to 3.5 and reinstall the Sharepoint.Emulator using NuGet manager.

Then it worked.

Note: after installing Sharepoint.Emulator in 3.5 i again change the framework to 4.0. and the project still works.