Sharepoint Faqs

As promised, here are the answers to the SharePoint Developer Interview Questions that I posted last week. Some of the answers are long, some are really short, for the longer ones there might be too much content. The reason that there is a lot of content is because the answer can vary heavily from person to person. There is a concrete answer to all of these questions, and I have done my best to give you a general, albiet short, idea of what that is. There might be several answers, so don’t take anything that I have written here to heart, and be sure to make your own decisions. I wrote these answers in under an hour. If there are discrepancies, or spelling errors, just post the problem in the comments of the page and I will adjust the answers accordingly. If you would like to contribute to the list, do the same, and I will move your comment with credit to the post. Note: A LOT of these questions are specific to SharePoint 2007, and won't have applicability for SharePoint 2003! 1) What are the two base classes a WebPart you are going to use within SharePoint 2007 can inherit from? There are two base classes that a WebPart which is going to be consumed by SharePoint can inherit from, either the SharePoint WebPart Base class or the ASP.NET 2.0 WebPart base class. When inheriting from the SharePoint WebPart Base class your derived WebPart class will inherit from Microsoft.SharePoint.WebPartPages.WebPart. When inheriting from the ASP.NET 2.0 WebPart base class your derived WebPart class will inherit from System.Web.UI.WebControls.WebParts.WebPart. It is considered good practice to use the ASP.NET WebPart base class since the old base class is meant for backwards compatibility with previous version of SharePoint; however there are four exceptions when it is better to leverage functionality from the SharePoint WebPart base class: Cross page connections Connections between Web Parts that are outside of a Web Part zone Client-side connections (Web Part Page Services Component) Data caching infrastructure 2) What are the differences between the two base classes and what are the inherit benefits of using one over another? The difference is the Microsoft.SharePoint.WebPartPages.WebPart base class is meant for backward compatibility with previous versions of SharePoint. The benefit of using the SharePoint WebPart base class is it supported: Cross page connections

Connections between Web Parts that are outside of a Web Part zone Client-side connections (Web Part Page Services Component) Data caching infrastructure ASP.NET 2.0 Web Parts are generally considered better to use because SharePoint is built upon the ASP.NET 2.0 web architecture. Inheriting from the ASP.NET 2.0 base class offers you features that inherit to ASP.NET 2.0, such as embedding resources as opposed to use Class Resources for deployment of said types. 3) What is the GAC? The GAC stands for the global assembly cache. It is the machine wide code cache which will give custom binaries place into the full trust code group for SharePoint. Certain SharePoint assets, such as Feature Receivers need full trust to run correctly, and therefore are put into the GAC. You should always try to avoid deployment to the GAC as much as possible since it will possibly allow development code to do more than it was intended to do. 4) What is strong naming (signing) a WebPart assembly files mean? Signing an assembly with a strong name (a.k.a strong naming) uses a cryptographic key pair that gives a unique identity to a component that is being built. This identity can then be referred throughout the rest of the environment. In order to install assemblies into the GAC, they must be strongly named. After signing, the binary will have a public key token identifier which can be use to register the component in various other places on the server. 5) What are safe controls, and what type of information, is placed in that element in a SharePoint web.config file? When you deploy a WebPart to SharePoint, you must first make it as a safe control to use within SharePoint in the web.config file. Entries made in the safe controls element of SharePoint are encountered by the SharePointHandler object and will be loaded in the SharePoint environment properly; those not will not be loaded and will throw an error. In the generic safe control entry (this is general, there could be more), there is generally the Assembly name, the namespace, the public key token numeric, the typename, and the safe declaration (whether it is safe or not). There are other optional elements. 6) What is the CreateChildControls () method? How can you use it to do something simple like displaying a Label control? The CreateChildControls method in Web Parts is used to notify the WebPart that there are children controls that should be output for rendering. Basically, it will add any child

ASP.NET controls that are called instantiating each control with its relevant properties set, wire any relevant event handlers to the control, etc. Then the add method of the control class will add the control to the controls collection. In the relevant WebPart render method, the EnsureChildControls method can be called (or set to false if no child controls should be called) to ensure that the CreateChildControls method is run. When using CreateChildControls it implies that your WebPart contains a composition of child controls. In order to create something like a label control in Create, you would create a new label control using the new keyword, set the various properties of the control like Visible=True and Fore Color = Color. Red, and then use Controls. Add (myLabelControl) to add the control to the controls collection. Then you can declare EnsureChildControls in the Render method of the WebPart. 7) What does the Render Contents method do in an ASP.NET 2.0 WebPart? The render contents method will render the WebPart content to the writer, usually an HtmlTextWriter since Web Parts will output to an HTML stream. Render Contents is used to tell how the controls that are going to be displayed in the WebPart should be rendered on the page. *** Side Question: I got asked what the difference between CreateChildControls and the Render Contents method. The CreateChildControls method is used to add controls to the WebPart, and the Render Contents method is used to tell the page framework how to render the control into HTML to display on a page. 8) What is the WebPartManager sealed class? What is its purpose? The WebPartManager sealed class is responsible for managing everything occurring on a WebPart page, such as the Web Parts (controls), events, and misc. functionality that will occur in WebPartZones. For example, the WebPartManager is responsible for the functionality that is provided when you are working with moving a WebPart from WebPartZone to WebPartZone. It is known as the “the central class of the Web Part Control Set.” *** Side Question: I got asked how many WebPartManager controls should be on a page. In order to have Web Parts on a page there has to be just one WebPartManager control to manage all the Web Parts on the page. 9) What is a SPSite and SPWeb object, and what is the difference between each of the objects? The SPSite object represents a collection of sites (site collection [a top level site and all its sub sites]). The SPWeb object represents an instance SharePoint Web, and SPWeb object contains things like the actual content. A SPSite object contains the various sub sites and the information regarding them.

10) How would you go about getting a reference to a site? Select For Unformatted Code C#:

1.

oSPSite = new

3.

oSPWeb = oSPSite.OpenWeb();

SPSite("http:/server");

2.

11) What does a SPWebApplication object represent? The SPWebApplication objects represents a SharePoint Web Application, which essentially is an IIS virtual server. Using the class you can instigate high level operations, such as getting all the features of an entire Web Application instance, or doing high level creation operations like creating new Web Applications through code. 12) Would you use SPWebApplication to get information like the SMTP address of the SharePoint site? Yes, since this is a Web Application level setting. You would iterate through each SPWebApplication in the SPWebApplication collection, and then use the appropriate property calls (OutboundMailServiceInstance) in order to return settings regarding the mail service such as the SMTP address. Side Question: I got asked if there are other ways to send emails from SharePoint. The answer is yes, there is. You can use the Send Mail method from the SPutility class to send simple emails, however it is not as robust as using the System.Net.Mail functionality since it doesn’t allow things like setting priorities on the email. 13) How do you connect (reference) to a SharePoint list, and how do you insert a new List Item? Select For Unformatted Code C#:

1. 2.

3. 4.

5. 6.

using(SPSite mySite = new SPSite("yourserver")) { using(SPWeb myWeb = mySite.OpenWeb()) { SPList interviewList = myWeb.Lists["listtoinsert"]; SPListItem newItem = interviewList.Items.Add();

7.

8. 9.

newItem["interview"] = "interview";

newItem.Update(); 10. }

11. }

14) How would you loop using SPList through all Share Pont List items, assuming you know the name (in a string value) of the list you want to iterate through, and already have all the site code written? Select For Unformatted Code C#:

1. 2.

SPList interviewList = myWeb.Lists["listtoiterate"];

3. 4.

foreach (SPListItem interview { // Do Something

5.

}

in interviewList)

15) How do you return SharePoint List items using SharePoint web services? In order to retrieve list items from a SharePoint list through Web Services, you should use the lists.asmx web service by establishing a web reference in Visual Studio. The lists.asmx exposes the GetListItems method, which will allow the return of the full content of the list in an XML node. It will take parameters like the GUID of the name of the list you are querying against, the GUID of the view you are going to query, etc. Side Question: I got asked how I built queries with the lists.asmx web service. In order to build queries with this service, one of the parameters that the GetListItems method exposes is the option to build a CAML query. There are other ways to do this as well, but that was how I answered it. 16) When retrieving List items using SharePoint Web Services, how do you specify explicit credentials to be passed to access the list items? In order to specify explicit credentials with a Web Service, you generally instantiate the web service, and then using the credentials properties of the Web Service object you use the System.Net.NetworkCredential class to specify the username, password, and domain that you wish to pass when making the web service call and operations. *** Side Question: I got asked when you should state the credentials in code. You must state the credentials you are going to pass to the web service before you call any of the methods of the web service, otherwise the call will fail. 17) What is CAML, and why would you use it? CAML stands for Collaborative Application Markup Language. CAML is an XML based language which provides data constructs that build up the SharePoint fields, view, and is used for table definition during site provisioning. CAML is responsible for rending data and the resulting HTML that is output to the user in SharePoint. CAML can be used for a variety of circumstances, overall is used to query, build and customize SharePoint based sites. A general use would be building a CAML query in a SharePoint WebPart in order to retrieve values from a SharePoint list. 18) What is impersonation, and when would you use impersonation?

Impersonation can basically provide the functionality of executing something in the context of a different identity, for example assigning an account to users with anonymous access. You would use impersonation in order to access resources on behalf of the user with a different account, that normally, that wouldn’t be able to access or execute something. 19) What is the IDesignTimeHtmlProvider interface, and when can you use it in WebParts? The IDesignTimeHtmlProvider interface uses the function GetDesignTimeHtml() which can contain your relevant render methods. It was helpful to use in 2003 since it allowed your WebPart to have a preview while a page was edited in FrontPage with the Webpart on it, because the GetDesignTimeHtml() method contains the HTML for the designer to render. 20) What are WebPart properties, and what are some of the attributes you see when declaring WebPart properties in code? WebPart properties are just like ASP.NET control properties, they are used to interact with and specify attributes that should be applied to a WebPart by a user. Some of the attributes you see with ASP.NET 2.0 properties are WebDescription, WebDisplayName, Category, Personalizable, and WebBrowsable. Although most of these properties come from the System.Web.UI.WebControls.WebParts class, ones like Category come out of System.ComponentModel namespace. 21) Why are properties important in WebPart development, and how have you exploited them in past development projects? What must each custom property have? Properties are important because WebParts allow levels of personalization for each user. WebPart properties make it possible for a user to interact, adjust, and increase overall experience value with the programmatic assets that you develop without having the need to use an external editor or right any code. A very simple example of exploiting a property would be something like allowing the user to change the text on the WebPart design interface so that they can display whatever string of text they desire. Each custom property that you have must have the appropriate get and set accessor methods. 22) What are ClassResources? How do you reference and deploy resources with an ASP.NET 2.0 WebPart? ClassResources are used when inheriting from the SharePoint.WebPart.WebPartPages.WebPart base class, and are defined in the SharePoint solution file as things that should be stored in the wpresources directory on the server. It is a helpful directory to use in order to deploy custom images. In ASP.NET 2.0, typically

things such as images are referenced by embedding them as resources within an assembly. The good part about ClassResources is they can help to eliminate recompiles to change small interface adjustments or alterations to external JavaScript files. 23) What is a SharePoint Solution File? How does it differ from WebPart .cab files in legacy development? What does it contain? A SharePoint solution file is essentially a .cabinet file with all a developers ustom componets suffixed with a .wsp extension that aids in deployment. The big difference with SharePoint solution files is is that a solution: allows deployment to all WFE’s in a farm is highly manageable from the interface allowing deployment, retraction, and versioning Can package all types of assets like site definitions, feature definitions (and associated components), Webparts, etc. Can provide Code Access Security provisioning to avoid GAC deployments Just to name a few things… 24) What is a .ddf file and what does it have to do with SharePoint Solution creation? A .ddf file is a data directive file and is used when building the SharePoint solution bundle specifying the source files and their destination locations. The important thing for someone to understand is that the .ddf file will be passed as a parameter to the MAKECAB utility to orchestrate construction of the SharePoint solution fiel. 25) What file does a SharePoint solution package use to orchestrate (describe) its packaged contents? The solution Manifest.XML file. 26) What deployment mechanism can you use to instigate Code Access Security attributes for your WebParts? SharePoint solution files can add in order to handle code access security deployment issues. This is done in the element in the SharePoint solution manifest.XML, which makes it easier to get assemblies the appropriate permissions in order to operate in the bin directory of the web application. 27) What is a SharePoint Feature? What files are used to define a feature?

A SharePoint Feature is a functional component that can be activated and deactivate at various scopes throughout a SharePoint instances, such as at the farm, site collection, web, etc. Features have their own receiver architecture, which allow you to trap events such as when a feature is installing, uninstalling, activated, or deactivated. They are helpful because they allow ease of upgrades and versioning. The two files that are used to define a feature are the feature.xml and manifest file. The feature XML file defines the actual feature and will make SharePoint aware of the installed feature. The manifest file contains details about the feature such as functionality. Side Question: I got asked how the introduction of features has changed the concept of site definitions. SharePoint features are important when understanding the architecture of site definitions, since the ONET.XML file has been vastly truncated since it has several feature stapled on it. 28) What types of SharePoint assets can be deployed with a SharePoint feature? Features can do a lot. For example, you could deploy Simple site customizations Custom site navigation WebParts pages list types list instances event handlers workflows custom actions just to name a few…. 29) What are event receivers? Event receivers are classes that inherit from the SpItemEventReciever or SPListEventReciever base class (both of which derive out of the abstract base class SPEventRecieverBase), and provide the option of responding to events as they occur within SharePoint, such as adding an item or deleting an item.

30) When would you use an event receiver? Since event receivers respond to events, you could use a receiver for something as simple as canceling an action, such as deleting a document library by using the Cancel property. This would essentially prevent users from deleting any documents if you wanted to maintain retention of stored data. 31) What base class do event receivers inherit from? Event receivers either inherit from the SPListEventReciever base class or the SPItemEventReciever base class, both which derive from the abstract base class SPEventReceiverBase. 32) If I wanted to not allow people to delete documents from a document library, how would I go about it? You would on the ItemDeleting event set: properties.Cancel= true. 33) What is the difference between an asynchronous and synchronous event receivers? An asynchronous event occurs after an action has taken place, and a synchronous event occurs before an action has take place. For example, an asynchronous event is ItemAdded, and its sister synchronous event is ItemAdding. 34) How could you append a string to the title of a site when it is provisioned? In the OnActivated event: Select For Unformatted Code C#:

1. 2. 3.

SPWeb site = siteCollection.RootWeb; site.Title += "interview"; site.Update();

35) Can an event receiver be deployed through a SharePoint feature? Yes. 36) What is a content type? A content type is an information blueprint basically that can be re-used throughout a SharePoint environment for defining things like metadata and associated behaviors. It is basically an extension of a SharePoint list, however makes it portable for use throughout an instance regardless of where the instantiation occurs, ergo has location independence. Multiple content types can exist in one document library assuming that the appropriate

document library settings are enabled. The content type will contain things like the metadata, listform pages, workflows, templates (if a document content type), and associated custom written functionality. 37) Can a content type have receivers associated with it? Yes, a content type can have an event receiver associated with it, either inheriting from the SPListEventReciever base class for list level events, or inheriting from the SPItemEventReciever base class. Whenever the content type is instantiated, it will be subject to the event receivers that are associated with it. 38) What two files are typically (this is kept generally) included when developing a content type, and what is the purpose of each? There is generally the main content type file that holds things like the content type ID, name, group, description, and version. There is also the ContentType.Fields file which contains the fields to include in the content type that has the ID, Type, Name, DisplayName, StaticName, Hidden, Required, and Sealed elements. They are related by the FieldRefs element in the main content type file. 39) What is an ancestral type and what does it have to do with content types? An ancestral type is the base type that the content type is deriving from, such as Document (0x0101). The ancestral type will define the metadata fields that are included with the custom content type. 40) Can a list definition be derived from a custom content type? Yes, a list definition can derive from a content type which can be seen in the schema.XML of the list definition in the element. 41) When creating a list definition, how can you create an instance of the list? You can create a new instance of a list by creating an instance.XML file. 42) What is a Field Control? Field controls are simple ASP.NET 2.0 server controls that provide the basic field functionality of SharePoint. They provide basic general functionality such as displaying or editing list data as it appears on SharePoint list pages. 43) What base class do custom Field Controls inherit from? This varies. Generally, custom field controls inherit from the Microsoft.SharePoint.WebControls.BaseFieldControl namespace, but you can inherit from the default field controls.

44) What is a SharePoint site definition? What is ghosted (uncustomized) and unghosted (customized)? SharePoint site definitions are the core set of functionality from which SharePoint site are built from, building from the SiteTemplates directory in the SharePoint 12 hive. Site definitions allow several sites to inherit from a core set of files on the file system, although appear to have unique pages, thereby increasing performance and allowing changes that happen to a site propagate to all sites that inherit from a site definition. Ghosted means that when SharePoint creates a new site it will reference the files in the related site definition upon site provisioning. Unghosted means that the site has been edited with an external editor, and therefore the customizations are instead stored in the database, breaking the inheritance of those files from the file system. 45) How does one deploy new SharePoint site definitions so that they are made aware to the SharePoint system? The best way to deploy site definitions in the SharePoint 2007 framework is to use a SharePoint solution file, so that the new site definition is automatically populated to all WFE’s in the SharePoint farm.