Wednesday, June 3, 2009

Sample MOSS webpart & deployment

Hi Folks...

Seems people search for Sample MOSS webpart and land into my previous blog where i have written how to develop a webpart from your XP machine. So let us provide what people came looking for....

Following is a sample web part i created some time back which fetches data from database and displays in a table. The web part class should always inherit Webpart(System.Web.UI.WebControls.WebParts) as base class. For webparts we usually write the code to override any events like Render, RenderWebPart or RenderContent.
In the sample code i have overrided Render event which takes the parameter System.Web.UI.HtmlTextWriter object.

The Database operations i have used Application blocks from Enterprise Library

Namespace:

System.Web.UI.WebControls
;
System.Web.UI.WebControls.WebParts;

Code: There are appropriate comments give to explain its operation

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Web;

using System.Data;

using System.Data.Sql;

using System.Data.SqlClient;

using System.Web.UI.WebControls;

using System.Web.UI.WebControls.WebParts;

using Microsoft.ApplicationBlocks.Data;

namespace Newwebpart1

{

public class Newwebpart1 : WebPart

{

protected override void CreateChildControls()

{

base.CreateChildControls();

//Control can be created here...

}

protected override void Render(System.Web.UI.HtmlTextWriter writer)

{

//We Create a SQL connection

SqlConnection objSqlConnection = new SqlConnection("Data Source=44.44.44.44;Initial Catalog=<YOUDB>;Persist Security Info=True;User ID=<USERNAME>;Password=<PASSWORD>");

//We execute a SQL Query & get a Dataset in return

DataSet objDataSet = SqlHelper.ExecuteDataset(objSqlConnection, System.Data.CommandType.Text, "SELECT [COL1],[COL2] FROM [DB].[dbo].[TABLENAME]");

//We are creating a Table in runtime

Table objTable = new Table();

objTable.BorderStyle = BorderStyle.Solid;

objTable.BorderWidth = 1;

objTable.GridLines = GridLines.Both;

objTable.CellPadding = 1;

objTable.CellSpacing = 1;

objTable.BorderColor = System.Drawing.Color.Blue;

//Creating Header here:

TableRow objTableRow_Header = new TableRow();

TableCell objTableCell_Title1 = new TableCell();

objTableCell_Title1.Text = objDataSet.Tables[0].Columns[0].Caption;

TableCell objTableCell_Title2 = new TableCell();

objTableCell_Title2.Text = objDataSet.Tables[0].Columns[1].Caption;

objTableRow_Header.Cells.Add(objTableCell_Title1);

objTableRow_Header.Cells.Add(objTableCell_Title2);

objTable.Rows.Add(objTableRow_Header);

//Rows are added based on the number of records

for (int i = 0; i < objDataSet.Tables[0].Rows.Count; i++)

{

TableRow objTableRow_Content = new TableRow();

TableCell objTableCell_Column1 = new TableCell();

objTableCell_Column1.Text = objDataSet.Tables[0].Rows[i][0].ToString();

TableCell objTableCell_Column2 = new TableCell();

objTableCell_Column2.Text = objDataSet.Tables[0].Rows[i][1].ToString();

objTableRow_Content.Cells.Add(objTableCell_Column1);

objTableRow_Content.Cells.Add(objTableCell_Column2);

objTable.Rows.Add(objTableRow_Content);

}

//Writing content inside webpart with the help of object created for

//HtmlTextWriter

writer.Write("<div style='overflow:auto'>");

//Add the table which was created in runtime from the above code.

objTable.RenderControl(writer);

writer.Write("</div>");

}

}

}


Reference

Download Project: http://www.checkthiz.com/publicfiles/Download webpart.zip

Steps to deploy a webpart:

1. Right click on project file and select properties and strong name key for the Project.


2. Build the solution (Ctrl+ Shit +B)

3. The Assembly (dll) will be created in the bin folder.

4. Move the assembly to the GAC ( just drag & drop in C:\WINDOWS\assembly)

5. In the web.config of the Web application (Sharepoint Website) place the code in SafeControls tag with the PublicKeyToken found in the Assembly.

Sample:
SafeControl Assembly=", Version=1.0.0.0, Culture=neutral, PublicKeyToken=ASDFASDRTERFSDF" Namespace="" TypeName="*" Safe="True"

6. Reset IIS

7. Go to Site Action -> Settings -> Webparts -> New

8. You will find your webpart in the URL: http://YOURMOSSSERVER/_layouts/NewDwp.aspx .Select the checkbox for the respective webpart & click Populate Gallery Button.

9. Now go to any page in the site and in Edit mode you will be able to find the webpart to add it in your page.... Thats it...

Note: With the help of Web Part templates in visual studio the above steps are made much more easier! you can just click on RUN button. The studio it-self will deploy & reset the IIS, you can directly go to the page and add the Web part! Love you Templates :)

Hope it helps... try and have fun :)

Regards
Fauzi ~4Z

No comments: