SharePoint – Page 18 – Nishant Rana's Weblog

Using SPGridView to bound to list data in SharePoint

These are the few points we need to remember while using SPGridView

With SPGridView we would inherit the same look and feel as the rest of SharePoint site because it makes use of the same CSS classes that the other grids in SharePoint use.

We need to set AutoGenerateColumns=false and explicitly bind the columns.

Create a new asp.net page

Put the following directive to use SPGridView

<%@ Register TagPrefix=”SharePoint” Namespace=”Microsoft.SharePoint.WebControls”

Assembly=”Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c” %

Declare the control

<SharePoint:SPGridView runat=”server” ID=”grdView”

AutoGenerateColumns=”false” />

Declaring class level variable

public partial class _Default : System.Web.UI.Page

{

// refer to your site collection

SPSite mySite = new SPSite(@”http://d-1246:100″);

// create class level spweb and splist object

SPWeb myWeb;

SPList myList;

Code for Page_Load EventHandler

protected void Page_Load(object sender, EventArgs e)

{

myWeb = mySite.OpenWeb();

myList = myWeb.Lists[“ListName”];

if (!Page.IsPostBack)

{

BindToGrid(myList, grdPropertyValues);

}

Code for BindToGrid method

private void BindToGrid(SPList myList, SPGridView gridView)

{

//grdView.Columns.Clear();

// get all the listitem

SPListItemCollection results = myList.Items;

// create the datatable object

DataTable table;

table = new DataTable();

table.Columns.Add(“Type”, typeof(string));

table.Columns.Add(“Name”, typeof(string));

table.Columns.Add(“Created”, typeof(string));

// Create rows for each splistitem

DataRow row;

foreach (SPListItem result in results)

{

row = table.Rows.Add();

row[“Type”] = result[“Type”].ToString();

row[“Name”] = result[“Name”].ToString();

row[“Created”] = result[“Created”].ToString();

}

// create the bound fields

SPBoundField boundField;

boundField = new SPBoundField();

boundField.HeaderText = “Type”;

boundField.DataField = “Type”;

boundField.ItemStyle.HorizontalAlign = HorizontalAlign.Center;

boundField.ItemStyle.Wrap = false;

gridView.Columns.Add(boundField);

boundField = new SPBoundField();

boundField.HeaderText = “Name”;

boundField.DataField = “Name”;

gridView.Columns.Add(boundField);

boundField = new SPBoundField();

boundField.HeaderText = “Created”;

boundField.DataField = “Created”;

gridView.Columns.Add(boundField);

gridView.AutoGenerateColumns = false;

gridView.DataSource = table.DefaultView;

gridView.DataBind();

}

That’s it …

Adding a Read Only Field or Read Only Column to a SharePoint List

We had a requirement to add a read only column to one of our document library. Using Create column it isn’t possible to add a read only column. One option could be to create the new column and then using SharePoint designer we can make use of JavaScript and modify the NewForm.aspx and EditForm.aspx to display that field as read only.

We thought of adding it as a Site Column making use of ReadOnly property of field.

<?xml version=“1.0“ encoding=“utf-8“?>

<Field ID=“{0B8A5574-80BF-4d5e-99B9-9A25D8E8D21E}“

Name=“_IsApproved“

DisplayName=“Is Document Approved?“

Group=“Custom Columns“

Type=“Text“

Required=“FALSE“

ReadOnly=“TRUE“

“

</Field>

</Elements>

However if we set ReadOnly as True the field doesn’t appear on Site Settings pages for managaing site columns and content types. However we can add it to the view using the below code

SPSite oSiteCollection = new SPSite(@”http://servername:port”);

using (SPWeb oWebsite = oSiteCollection.OpenWeb())

{

SPList oList = oWebsite.Lists[“ListName”];

oList.Fields.Add(“Is Document Approved?”, SPFieldType.Text, false);

oList.Update();

SPView oView = oList.DefaultView;

oView.ViewFields.Add(“Is Document Approved?”);

oView.Update();

}

However the field was still appearing in editform.aspx and newform.aspx in editable mode.

So finally tried this

Modified the definition for the custom site column as following

<?xml version=“1.0“ encoding=“utf-8“?>

<Field ID=“{0B8A5574-80BF-4d5e-99B9-9A25D8E8D21E}“

Name=“_IsApproved“

DisplayName=“Is Document Approved?“

Group=“Custom Columns“

Type=“Text“

Required=“FALSE“

ReadOnly=“FALSE“

ShowInDisplayForm=“TRUE“

ShowInEditForm=“FALSE“

ShowInNewForm=“FALSE“

</Field>

</Elements>

Setting ShowInDisplayForm and ShowInEditForm as False and keeping ReadOnly as False so that the field could appear within Site Settings pages for managing site columns.

This last solution worked ..

The feature file for installing the above site column

<?xml version=“1.0“ encoding=“utf-8“?>

<Feature Id=“D829F71B-7FCC-4f0d-950D-6B562AFF400E“

Title=“MyCustom Feature“

Description=“This is my custom column feature“

Version=“12.0.0.0“

Scope=“Site“

xmlns=“http://schemas.microsoft.com/sharepoint/“>

</ElementManifests>

</Feature>

Now the only way to edit the column was through SharePoint Object Model

SPSite oSiteCollection = new SPSite(@”http://servername:port”);

using (SPWeb oWebsite = oSiteCollection.OpenWeb())

{

SPList oList = oWebsite.Lists[“ListName”];

SPListItem item = oList.Items[0];

item[“Is Document Approved?”] = “These are my changes”;

item.Update();

}

That’s it..

Customizing Custom Web Part Menu in SharePoint

Any standard web part within SharePoint would have menu options like Minimize, Close, and Modify Shared Web Part. We can even add our own custom menu options over there. They are referred to as verbs in web part’s context. We could add three types of web part menu verbs.

Client Side –We could specify JavaScript over here.

Server Side – We can attach event handler over here.

Both – We could have both JavaScript and event handler specified.

Let’s take a simple example where we would be adding all the above three kind of verbs.

Create a web part project within Visual Studio.

Put the following code for web part,

It would have a text box that would show the text set using the event handler specified in the server side verb.

[Guid(“172bc4c1-1c5d-49cd-93bc-1874acbbb9c8”)]

public class WebPartMenuVerbWebPart : System.Web.UI.WebControls.WebParts.WebPart

{

public WebPartMenuVerbWebPart()

{

}

protected TextBox txtInfo;

protected override void CreateChildControls()

{

txtInfo = new TextBox();

this.Controls.Add(txtInfo);

}

public override WebPartVerbCollection Verbs

{

get

{

// Client side verb

WebPartVerb clientSideVerb = new WebPartVerb(“clientID”, “javascript:alert(‘Hello World from Java Script Verb!’);”);

clientSideVerb.Text = “Client Side Verb”;

// Server side verb

WebPartVerb serverSideVerb = new WebPartVerb(“serverID”, new WebPartEventHandler(ServerVerbEventHandler));

serverSideVerb.Text = “Server Side Verb”;

// Verb for both client side and server side

WebPartVerb bothSideVerb = new WebPartVerb(“bothID”, new WebPartEventHandler(ServerVerbEventHandler), “javascript:alert(‘Hello World from Java Script Verb!’);”);

bothSideVerb.Text = “Both Side Verb”;

WebPartVerbCollection wbVerbCollection = new WebPartVerbCollection(base.Verbs, new WebPartVerb[] { clientSideVerb, serverSideVerb, bothSideVerb });

return wbVerbCollection;

}

protected void ServerVerbEventHandler(object sender, WebPartEventArgs args)

{

txtInfo.Text=“Hello world from Server Side Verb”;

}

That’s it …

Creating a custom Hello World web service in SharePoint

We need to do the following five steps

1) Create the web service.

2) Run disco.exe to get static disco and wsdl file for the web service.

3) Put asmx, disco and wsdl file to ISAPI folder.

4) Rename disco and wsdl file to aspx. Replace static url’s in them.

5) Add an entry to spdisco.aspx

Let’s proceed

· Create a new ASP.NET web service project.

· Rename Service.asmx to HWService.asmx.

· Right click it – select View Mark Up.

· And put the following mark up. Here we will be creating the web service with inline code.

<%@ WebService Language=”C#” Class=”MyInlineService.HelloWorldService” %>

using System.Web.Services;

namespace MyInlineService

{

public class HelloWorldService: WebService

{

[WebMethod]

public string HelloWorld()

{

return “Hello World”;

}

· Now Run Disco.exe for our HWService.asmx to create static disco and wsdl file.

· Open visual studio command prompt and run the following command

disco http://localhost:1814/HelloWorldSPService/HWService.asmx

· This will create HWService.wsdl and HWService.disco files at the current directory.

· Now copy all the three files HWService.asmx,HWService.wsdl and HWService.disco to ISAPI folder.

· Rename HWService.disco to HWServicedisco.aspx and HWService.wsdl to HWServicewsdl.aspx.

· Now we will open these new renamed wsdl and disco files to make the following modifications.

Open HWServicewsdl.aspx.

Replace

<?xml version=”1.0″ encoding=”utf-8″?>

with

<%@ Page Language=”C#” Inherits=”System.Web.UI.Page” %>

<%@ Assembly Name=”Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c” %>

<%@ Import Namespace=”Microsoft.SharePoint.Utilities” %>

<%@ Import Namespace=”Microsoft.SharePoint” %>

<% Response.ContentType = “text/xml”; %>

And

<soap:address location=”http://localhost:1814/HelloWorldSPService/HWService.asmx” />

<soap:address location=<% SPHttpUtility.AddQuote(SPHttpUtility.HtmlEncode(SPWeb.OriginalBaseUrl(Request)),Response.Output); %> />

Open HWServicedisco.aspx

Replace

<?xml version=”1.0″ encoding=”utf-8″?>

with

<%@ Page Language=”C#” Inherits=”System.Web.UI.Page” %>

<%@ Assembly Name=”Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c” %>

<%@ Import Namespace=”Microsoft.SharePoint.Utilities” %>

<%@ Import Namespace=”Microsoft.SharePoint” %>

<% Response.ContentType = “text/xml”; %>

And

with

docRef=<% SPHttpUtility.AddQuote(SPHttpUtility.HtmlEncode(SPWeb.OriginalBaseUrl(Request)),Response.Output); %>

xmlns=”http://schemas.xmlsoap.org/disco/scl/” />

xmlns:q1=”http://tempuri.org/” binding=”q1:HelloWorld” xmlns=”http://schemas.xmlsoap.org/disco/soap/” />

xmlns:q2=”http://tempuri.org/” binding=”q2:ServiceSoap12″ xmlns=”http://schemas.xmlsoap.org/disco/soap/” />

· Adding it’s entry in spdisco.aspx

Open the spdisco.aspx and add the following entry

docRef=<% SPHttpUtility.AddQuote(SPHttpUtility.HtmlEncode(spWeb.Url + “/_vti_bin/HWService.asmx”), Response.Output); %>

xmlns=” http://schemas.xmlsoap.org/disco/scl/ “ />

xmlns=”http://schemas.xmlsoap.org/disco/” />

Now your web service should be availabe to be used within sharepoint context

http://servername:port/_vti_bin/HWService.asmx.

That’s it!!

Create a simple hello world custom Application Page in SharePoint.

There are two approaches we can follow while creating an Application Page in SharePoint.

One is Inline Approach

· Create a new default.aspx page rename it to HelloWorldAppPage.aspx

· Put the following markup in it

<%@ Page Language=”C#” MasterPageFile=”~/_layouts/application.master” Inherits=”Microsoft.SharePoint.WebControls.LayoutsPageBase” %>

<asp:Content ID=”Main” ContentPlaceHolderID=”PlaceHolderMain” runat=”server”>

<asp:Label Text=”Hello World” runat=”server” ></asp:Label>

</asp:Content>

· Every application page is an content page in SharePoint. And here to have same look and feel as the other application pages we have specified the application.master as the masterpagefile.

· Inherits attribute of the Page directive refers to LayoutsPageBase class from which the application pages inherit.

· We have than used a content server control that would be referring to the PlaceHolderMain content place holder inside the application.master page.

· Than we have simple added a label control that would be displaying hello world.

· Now go to your 12 hive i.e. C:Program FilesCommon FilesMicrosoft Sharedweb server extensions12TEMPLATELAYOUTS and create a folder (MyHelloWorld) over there and put the HelloWorldAppPage.aspx over there.

· We could have directly placed the aspx page to layouts folder but than from better organization perspective we have created a folder and kept the aspx page inside it.

· Now the page is available to all the SharePoint sites.

http://servername:port/_layouts/MyHelloWorld/HelloWorldAppPage.aspx

Another is code behind approach.

· The easiest way is to first create a Asp.NET Web site project.

· Add a class library project to the solution (GCL)

· Delete class1.cs and copy the default.aspx.cs page from asp.net web site project to the class library project.

· Delete the default.aspx.cs from the website.

· Add reference to System.Web and Microsoft.SharePoint.dll in your class library project

· Put the following code in the _Default

public partial class _Default : LayoutsPageBase

{

protected Label Label1;

protected void Page_Load(object sender, EventArgs e)

{

Label1.Text = “Hello World Code Behind”;

}

· Sign the assembly and put it in GAC.

· Get the public key token.

· In the default.aspx page replace and put the following markup to use the assembly.

<%@ Page Language=”C#” MasterPageFile=”~/_layouts/application.master”

Inherits=”_Default,GCL, Version=1.0.0.0,Culture=neutral,PublicKeyToken=16391a8a7c882343″ %>

<asp:Content ID=”Main” ContentPlaceHolderID=”PlaceHolderMain” runat=”server”>

<asp:Label ID=”Label1″ Text=”Hello World” runat=”server” ></asp:Label>

</asp:Content>

· Put default.aspx to the layouts folder or your custom folder inside it.

That’ s it !!

Creating a Custom Web Service in SharePoint for Uploading Document

We had a requirement to upload the document to SharePoint document library whenever a file has been attached to our entities in Microsoft Dynamics CRM. So the obvious way of doing that was to use web service within the CRM. We had already written a utility using SharePoint Object Model that would be doing so. So we thought of reusing the existing logic defined over there and wrap it inside one our custom web service’s method. We created the web service and we deployed it in our SharePoint Server but outside the context of the SharePoint i.e. as a separate web site. However when trying to use that web service from other machines we ran into security issues, it was always giving Unauthorized Access error. We tried running the web service app pool with identity of administrator and also tried out impersonation defined through web.config again passing the account of administrator. But it didn’t work

Then finally tried out this article within MSDN which guides us on creating a web service that operates within the context of WSS 3.0.

http://msdn.microsoft.com/en-us/library/ms464040.aspx

Basic steps for creating a custom web service are following

1) Create a new asp.net web service project.

2) Add a new class library project in that solution.

3) Move Service1.cs file from web service project to class library project

4) Delete the Service1.cs file in web service project and class1.cs file in the class library project.

5) Put your custom logic in service.cs file that is now in the class library project.

6) Give strong name to the class library i.e. Sign the assembly.

7) Put the assembly in GAC. Get its public key token.

8) Now make modification to the service.asmx to use the assembly.

9) Replace code behind attribute with the class attribute to refer to the assembly

<%@ WebService Language=“C#” Class=“Service, MyServiceAssembly, Version=1.0.0.0, Culture=neutral, PublicKeyToken=8f2dca3c0f2d0131” %>

10) Generate static discovery and wsdl file.

11) Copy the .asmx file of the Web service to \Program FilesCommon FilesMicrosoft Sharedweb server extensions12TEMPLATELAYOUTS

12) From visual studio command prompt run the following command

disco http://MyServer:port/_layouts/MyCustomWebService.asmx

13) open both the .disco and .wsdl files and replace the opening XML processing instruction — <?xml version="1.0" encoding="utf-8"?> — with instructions such as the following

<%@ Page Language=“C#” Inherits=“System.Web.UI.Page” %>

<%@ Assembly Name=“Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c” %>

<%@ Import Namespace=“Microsoft.SharePoint.Utilities” %>

<%@ Import Namespace=“Microsoft.SharePoint” %>

<% Response.ContentType = “text/xml”; %>

14) In the .disco file, modify the contract reference and SOAP address tags

docRef=<% SPHttpUtility.AddQuote(SPHttpUtility.HtmlEncode(SPWeb.OriginalBaseUrl(Request)),Response.Output); %>

xmlns=“http://schemas.xmlsoap.org/disco/scl/” />

xmlns:q1=“http://tempuri.org/” binding=“q1:HelloWorld” xmlns=“http://schemas.xmlsoap.org/disco/soap/” />

xmlns:q2=“http://tempuri.org/” binding=“q2:ServiceSoap12” xmlns=“http://schemas.xmlsoap.org/disco/soap/” />

15) In the .wsdl file, make the following changes for the SOAP address

<soap:address location=<% SPHttpUtility.AddQuote(SPHttpUtility.HtmlEncode(SPWeb.OriginalBaseUrl(Request)),Response.Output); %> />

16) Rename both files in the respective formats MyCustomWebServicedisco.aspx and MyCustomWebServicewsdl.aspx so that your service is discoverable through Windows SharePoint Services.

17) Copy the new MyCustomWebServicewsdl.aspx and MyCustomWebServicedisco.aspx files, and also the MyCustomWebService.asmx fil to _Drive:Program FilesCommon FilesMicrosoft SharedWeb Server Extensions12ISAPI directory

18) Open the spdisco.aspx files located in Program FilesCommon FilesMicrosoft SharedWeb Server Extensions12ISAPI and add the following code, specifying the .asmx file for your Web service.

docRef=<% SPHttpUtility.AddQuote(SPHttpUtility.HtmlEncode(spWeb.Url + “/_vti_bin/MyCustomWebService.asmx“), Response.Output); %>

xmlns=” http://schemas.xmlsoap.org/disco/scl/ “ />

xmlns=“http://schemas.xmlsoap.org/disco/” />

Any modification done to the custom logic would require putting the new assembly in GAC followed by generating the static disco and wsdl file and making all the necessary modification in disco and wsdl file as mentioned in the above steps.

Now in our case finally putting the custom logic of uploading the document within the class library for the web service helped us to solve the issues that we were facing.

[WebMethod]

public string UploadDocumentToSharePoint(string fileName, byte[] fileContents, string folderName)

{

if (fileContents == null)

{

return “Null Attachment”;

}

try

{

SPWeb web = SPContext.Current.Web;

web.AllowUnsafeUpdates = true;

SPFolder folder = web.GetFolder(folderName);