Sharepoint Server » Sharepoint

SharePoint Document Counter Counts The Document Downloads

G Vijai Kumar — Wed, 15 Dec 2010 19:26:36 +0000

In this post I’m going to show you how to count the document events of SharePoint site, after going through this post you will learn how to count the document downloads, views, updates, deletion, restoration etc.

I remember this solution has been asked by few people on this blog.

Before knowing the document events (add, delete, update, view etc) we have to configure the audit entry settings for the SharePoint site collection in site settings page under Site Collection Administration section (see figure 1)

Figure 1 - Configure Site Collection Audit Settings

On Audit Settings page check the required events to track, in this example I’m configuring for Opening or downloading documents, viewing items in lists, or viewing item properties, Editing items, Deleting or restoring items

Figure 2 - Configure Audit Events

You can also configure audit entry settings programmatically with few lines of code, here it is:

static void Main()
        {
            using (SPSite mySite = new SPSite("http://:port"))
            {
                using (SPWeb myWeb = mySite.OpenWeb())
                {
                    mySite.Audit.AuditFlags = SPAuditMaskType.All; //Configures all settings

                    //you can even configure specific settings using the below lines of code

                    //mySite.Audit.AuditFlags = SPAuditMaskType.CheckIn | SPAuditMaskType.CheckOut | SPAuditMaskType.ChildDelete |
                    //     SPAuditMaskType.Copy | SPAuditMaskType.Delete | SPAuditMaskType.Move | SPAuditMaskType.ProfileChange |
                    //     SPAuditMaskType.SchemaChange | SPAuditMaskType.Search | SPAuditMaskType.SecurityChange |
                    //     SPAuditMaskType.Undelete | SPAuditMaskType.Update | SPAuditMaskType.View | SPAuditMaskType.Workflow;

                    //mySite.Audit.AuditFlags = SPAuditMaskType.None; //Configures to none
                    mySite.Audit.Update();

                }
            }
            Console.WriteLine("Press any key to continue.....");
            Console.ReadLine();
        }

After configuring the settings, SharePoint audits the library events on item viewing, downloading, editing, deleting etc.,
SharePoint also generates audit log reports on this events in .CSV format. In this example we are reading the data from the configured audit entry logs to know event actions on documents.

Use the below code to know the event count on documents

using System;
using System.ComponentModel;
using System.Web;
using System.Text;
using System.Data;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using Microsoft.SharePoint;
using Microsoft.SharePoint.WebControls;

namespace DownloadCounter.VisualWebPart1
{
    [ToolboxItemAttribute(false)]
    public class VisualWebPart1 : WebPart
    {
        // Visual Studio might automatically update this path when you change the Visual Web Part project item.
        private const string _ascxPath = @"~/_CONTROLTEMPLATES/DownloadCounter/DownloadCounterWebPart/DownloadCounterUserControl.ascx";
        SPGridView myGridView;
        SPDataSource myDataSource = new SPDataSource();
        string errorMessage = string.Empty;

        protected override void CreateChildControls()
        {
            Control control = Page.LoadControl(_ascxPath);
            Controls.Add(control);

            base.CreateChildControls();

            myGridView = new SPGridView();
            myGridView.AutoGenerateColumns = false;
            myGridView.Enabled = true;
            myGridView.AllowSorting = true;
            myGridView.AllowGrouping = true;
            myGridView.AllowGroupCollapse = true;
            myGridView.GroupField = "Event";
            myGridView.DisplayGroupFieldName = false;
            myGridView.AllowPaging = true;
            myGridView.PageSize = 50;
            myGridView.PageIndexChanging += new GridViewPageEventHandler(myGridView_PageIndexChanging);

            BoundField colEvent = new BoundField();
            colEvent.DataField = "Event";
            colEvent.HeaderText = "Event";
            this.myGridView.Columns.Add(colEvent);

            BoundField colItemType = new BoundField();
            colItemType.DataField = "ItemType";
            colItemType.HeaderText = "ItemType";
            this.myGridView.Columns.Add(colItemType);

            BoundField colDocLocation = new BoundField();
            colDocLocation.DataField = "DocLocation";
            colDocLocation.HeaderText = "DocLocation";
            this.myGridView.Columns.Add(colDocLocation);

            BoundField colOccurred = new BoundField();
            colOccurred.DataField = "Occurred";
            colOccurred.HeaderText = "Occurred";
            this.myGridView.Columns.Add(colOccurred);

            BoundField colUserName = new BoundField();
            colUserName.DataField = "UserName";
            colUserName.HeaderText = "UserName";
            this.myGridView.Columns.Add(colUserName);

            Controls.Add(myGridView);
            myGridView.PagerTemplate = null;
            GetAudEntries();
            GroupByGridView();
        }
        private void GroupByGridView()
        {
            StringBuilder scriptFunction = new StringBuilder();
            scriptFunction.Append("");
            scriptFunction.Append("");
            Page.ClientScript.RegisterStartupScript(Page.GetType(), "GroupBy", scriptFunction.ToString());
        }

        private void GetAudEntries()
        {
            SPSecurity.RunWithElevatedPrivileges(delegate()
            {
                SPSite mySite = SPContext.Current.Site;
                SPWeb myWeb = SPContext.Current.Web;
                DataTable myDataTable = new DataTable();
                DataRow myRow;
                SPUser user;
                try
                {
                    SPAuditQuery wssQuery = new SPAuditQuery(mySite);
                    SPAuditEntryCollection auditCol = mySite.Audit.GetEntries(wssQuery);

                    myDataTable.Columns.Add("Event");
                    myDataTable.Columns.Add("ItemType");
                    myDataTable.Columns.Add("DocLocation");
                    myDataTable.Columns.Add("Occurred", typeof(DateTime));
                    myDataTable.Columns.Add("UserName");

                    foreach (SPAuditEntry entry in auditCol)
                    {
                        if (entry.DocLocation.EndsWith(".xls") || (entry.DocLocation.EndsWith(".doc")) || (entry.DocLocation.EndsWith(".ppt")))
                        {
                            user = myWeb.SiteUsers.GetByID(entry.UserId);
                            myRow = myDataTable.NewRow();
                            myRow["Event"] = entry.Event;
                            myRow["ItemType"] = entry.ItemType.ToString();
                            myRow["DocLocation"] = entry.DocLocation;
                            myRow["Occurred"] = entry.Occurred.ToLocalTime();
                            myRow["UserName"] = user.ToString();
                            myDataTable.Rows.Add(myRow);
                        }
                    }
                    myGridView.DataSource = myDataTable;
                    myGridView.DataBind();
                }
                catch (Exception ex)
                {
                    errorMessage = ex.ToString();
                }
            });

        }
        void myGridView_PageIndexChanging(object sender, GridViewPageEventArgs e)
        {
            myGridView.PageIndex = e.NewPageIndex;
            myGridView.DataBind();
        }

        protected override void RenderContents(HtmlTextWriter writer)
        {
            writer.Write(errorMessage);
            EnsureChildControls();
            RenderChildren(writer);
        }
    }
}

Use the above code or try to deploy the DownloadCounter.wsp
Note: In the above code we have used JQuery jquery-1.4.2.min.js files to show the count of the group by field, so please download the jquery-1.4.2.min.js file from http://code.jquery.com/jquery-1.4.2.min.js and place in some location of the SharePoint site and also refer the same source location in the above code, in this example I have placed the Jquery file in Site Assets library, you can even place in the same location if you don’t want to change the code.

After deploying the downloaded solution, please try to activate Download Counter Feature see figure 3

Figure 3 - Activate Download Counter Feature

Then add the webpart to the page see figure 4

Figure 4 - Adding Download Counter WebPart to SharePoint Site

Then you can view the webpart updating on every action of documents see figure 5

Figure 5 - Download counter webPart shows the count of events for the documents

Most Common Custom WebParts Part 4 – Flash Media WebPart

G Vijai Kumar — Sun, 28 Nov 2010 21:33:53 +0000

In my previous post you can view the most commonly used custom webparts, Tree View WebPart Shows Sites and Sub-Sites, Menu WebPart Shows Sites and Sub-Sites in Fly-Out Mode, Windows Media Player WebPart

In this continuation series of most commonly used custom webparts, I come up with a simple Flash Player webpart which plays flash files on Sharepoint sites, the webpart also supports to configure the properties as required.

Download the solution file FlashWebPart.wsp

Flash Media Player WebPart

Flash Media Player WebPart Configuration

using System;
using System.ComponentModel;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using Microsoft.SharePoint;
using Microsoft.SharePoint.WebControls;

namespace FlashWebPart.Flash
{
    [ToolboxItemAttribute(false)]
    public class Flash : WebPart
    {
        // Visual Studio might automatically update this path when you change the Visual Web Part project item.
        //private const string _ascxPath = @"~/_CONTROLTEMPLATES/FlashWebPart/Flash/FlashWebPartUserControl.ascx";

        private string flashFilePath = "http://www.adobe.com/content/dam/Adobe/en/devnet/flash/samples/time_1/1_timer.swf";
        private string flashWidth = "320";
        private string flashHeight = "240";
        private string bgColor = string.Empty;
        private bool loopPlayBack = true;

        [WebBrowsable(true),
        Personalizable(PersonalizationScope.User),
        WebDescription("Specifies the media file location"),
        Category("Flash Media Properties"),
        WebDisplayName("Media File Location")]
        public string FlashFilePath
        {
            get { return flashFilePath; }
            set { flashFilePath = value; }
        }

        [WebBrowsable(true),
        Personalizable(PersonalizationScope.User),
        WebDescription("Sets the width of the Media player"),
        Category("Flash Media Properties"),
        WebDisplayName("Width")]
        public string FlashWidth
        {
            get { return flashWidth; }
            set { flashWidth = value; }
        }

        [WebBrowsable(true),
        Personalizable(PersonalizationScope.User),
        WebDescription("Sets the height of the Media player"),
        Category("Flash Media Properties"),
        WebDisplayName("Height")]
        public string FlashHeight
        {
            get { return flashHeight; }
            set { flashHeight = value; }
        }

        [WebBrowsable(true),
        Personalizable(PersonalizationScope.User),
        WebDescription("Background Color: Specifies the back color"),
        Category("Flash Media Properties"),
        WebDisplayName("Background Color")]
        public string BGColor
        {
            get { return bgColor; }
            set { bgColor = value; }
        }

        [WebBrowsable(true),
        Personalizable(PersonalizationScope.User),
        WebDescription("Loop Play Back: (True/False) Repeats the video automatically"),
        Category("Flash Media Properties"),
        WebDisplayName("Loop Play Back")]
        public bool LoopPlayBack
        {
            get { return loopPlayBack; }
            set { loopPlayBack = value; }
        }

        //protected override void CreateChildControls()
        //{
        //    Control control = Page.LoadControl(_ascxPath);
        //    Controls.Add(control);
        //}

        protected override void Render(HtmlTextWriter writer)
        {
            SPSite site = null;
            SPWeb web = SPContext.Current.Web;
            if (!string.IsNullOrEmpty(FlashFilePath) && !string.IsNullOrEmpty(FlashWidth) && !string.IsNullOrEmpty(FlashHeight))
            {
                try
                {
                    SPSecurity.RunWithElevatedPrivileges(delegate()
                    {
                        site = new SPSite(web.Site.ID);

                        using (site)
                        {
                            #region Script
                            writer.Write("");
                            writer.Write("");
                            writer.Write("");
                            writer.Write("");
                            writer.Write("");
                            writer.Write("");
                            writer.Write("");
                            #endregion
                        }
                    });
                }
                catch (Exception ex)
                {
                    writer.Write(ex.Message);
                }
            }
            else
            {
                writer.Write("");
                writer.Write("Please configure the Media WebPart properties in webpart properties section");
                writer.Write("");
            }
        }
    }
}

Single Zone Split DNS

G Vijai Kumar — Wed, 03 Nov 2010 06:30:41 +0000

Single Zone Split DNS - This terminology is not correlated to SharePoint, but still I want to post in my blog, since I had stretch lot of my time to configure forward lookup zones on my Windows Server 2008 R2.

You may think why I want to configure forward lookup zones, that is not my job and it is related to Windows administrator (not SharePoint admin)

Let me illuminate the contextual background first

Just recently I bought a new laptop with Core i5 2.66 Ghz processor, installed memory of 6GB RAM, system type is 64 bit, I got the laptop with pre-installed OS Windows 7 however my idea is to create a server farm on single machine, so initially I have installed a fresh copy of Windows Server 2008 R2 Enterprise (still Windows 7 is there and has choice of selecting the operating system before booting, we can call it as dual boot machine)

After installing Windows Server 2008 R2 ENT, I have configured DNS (Domain Name System) then given FIVENUMBER.COM as domain name, my full computer name is SHAREPOINT.FIVENUMBER.COM (SHAREPOINT is my computer name, computer name + domain name = full computer name), then in Active Directory I have created two service accounts for SharePoint basically FIVENUMBER\SPAdmin and FIVENUMBER\SPService

At that moment I have restarted the system and logged in with the newly created account FIVENUMBER\SPAdmin

Then, I have installed SQL Server 2008 R2 Enterprise Edition, followed by SharePoint 2010 pre-requisites, we will get pre-requisite installer file within the SharePoint 2010 software, then last but not least I have installed my favorite SharePoint 2010 Enterprise Edition

Throughout the installation period the whole thing went smooth without a single problem, and then after I was on the go to configuring services and created the first web application on the new laptop, creation of web application was very fast and site accessing too, as it is recommended 4GB of RAM for developer or evaluation use for SharePoint 2010 (Please have a look at hardware and software requirements for SharePoint 2010) but my laptop has 6GB of RAM then apparently it will be fast.

Now we will get into the real article.

After finalizing the installations and configurations on my new laptop, I assumed to access my blog site www.fivenumber.com, as soon as I type the URL in the browser a windows authentication prompt appeared, look as if prompt for SharePoint sites, observing the prompt I stood shocked and I provided the user and password and then it navigated to the SharePoint site which is running on 80 port number, I have tried couple of times to access my blog site but continuously it prompts the box and takes me to SharePoint site, the blog site was working without any problem if I access from another PC, but I cannot access the blog site from my new laptop, then I become conscious that my domain name is also same as my blog site name

At that point I started Binging and came to identify that this is called as Single Zone Split DSN and can be fixed by configuring forward lookup zone, that means I have to create a new zone under forward lookup zone in the DNS manager, then I have to create a new host (A record), then followed by creating an Alias (CNAME)

Now we will see step by step how to add a forward lookup zone in Windows Server 2008 R2

Go to Start > Administrative Tools > DNS (see Figure 1)

Figure 1 - Configuring Forward Lookup Zone

In DNS Manager, right click on Forward Lookup Zones and click on New Zone (see Figure 2)

Figure 2 - Create New Zone

Then New Zone Wizard will start click Next (see Figure 3)

Figure 3 - New Zone Wizard

Under Zone Type ensure that Primary Zone is selected and Store the zone in Active Directory is checked, click Next (see Figure 4)

Figure 4 - Zone Type

Under Active Directory Zone Replication Scope ensure that To all DNS servers running on domain controllers in this domain <domainname.com> is selected, click Next (see Figure 5)

Figure 5 - Active Directory Zone Replication Scope

Under Zone Name, please provide the domain name (for example: fivenumber.com), click Next (see Figure 6)

Figure 6 - Zone Name

Under Dynamic Update ensure that Allow only secure dynamic updates is selected, click Next (see Figure 7)

Figure 7 - Dynamic Update

We reached the final step in the wizard and can view Completing the New Zone Wizard, click Finish (see Figure

Figure 8 - Completing the New Zone Wizard

Now we have to create a new host under the new zone, to do that select the newly created created zone, in the DNS manager, then right click and click on New Host (A or AAA) to create the A record (see Figure 9)

For your information: A record is an entrance in the DNS zone, that maps each domain to an IP address.

Figure 9 - Creating New Host (A record)

In the New Host dialog box provide the name as www and IP address in the appropriate boxes and click Add Host (see Figure 10)

Note: You will come to know the IP address of the site when you ping the site in command prompt

Figure 10 - Creating New Host

You can view the host record successfully created message (see Figure 11)

Figure 11 - Host Record Successfully Created

Now we have to create a new alias under the new zone, to do that select the newly created created zone, in the DNS manager, then right click and click on New Alias (CNAME) to create the alias name (see Figure 12)

For your information: Canonical Name in short called as CNAME that indicates the true host name of a computer that it’s aliases are linked with

Figure 12 - Creating New Alias Name (CNAME)

In the New Resource Record dialog box provide Alias name as www2, then click on Browse and select the newly created host file www located under Forward Lookup Zones > > (see Figure 13)

Figure 13 - Creating Alias Name (CNAME)

After selecting the fully qualified name, click OK (see Figure 14)

Figure 14 - Creating New Alias Name (CNAME)

We are done almost, now try to execute the NSLOOKUP command to verify the IP address of the site and ping the site to view the reply ping back (see Figure 15 and 16)

Figure 15 - Executing NSLOOKUP command to verify the IP address of the site

Figure 16 - Pinging the Site to view the reply ping back

Connecting an Excel SpreadSheet to SharePoint 2010 list

G Vijai Kumar — Tue, 02 Nov 2010 06:55:24 +0000

Sharepoint 2010 has a feature of connecting an Excel workbook
Whenever an item is added/updated/deleted in SharPoint list the record is also added/updated/deleted in the connected Excel workbook
In this example we will see how to connect an Excel workbook to SharePoint list

Initially I have created a simple SharePoint custom list with few records in that, the list contains four columns Title (default column), Employee Name (single line text), Designation (choice filed), Department (choice field)
(See in Figure 1)

Figure 1 - Simple SharePoint Custom List

Now, we are ready to connect, click on List then click Export to Excel option (see Figure 2)

Figure 2 - Click on Export to Excel

A file download window pops, click on Save (see Figure 3)

Figure 3 - File Download Window, Click Save

Save the file in some location (in this example I have saved in E:\Employee location) (see Figure 4)

Figure 4 - Saving Excel Web Query File

Then open the saved Excel Web Query file from the location where you saved or click on the Open button in download dialog window (see Figure 5)

Figure 5 - Open the downloaded file

While the Excel Web Query File is opening you can view the Microsoft Excel Security Notice (the dialog window says warning about the data connection) click on Enable (see Figure 6)

Figure 6 - Enable Data Connections

As soon as you click on Enable button you can view the SharePoint list data in the Excel Web Query File (see Figure 7)

Figure 7 - Excel Web Query File, Shows SharePoint List Data

Now we have to set the data connection to this workbook, to do that select Data menu and click on Connections (see Figure 8 )

Figure 8 - Data Connections for the workbook

A Workbook Connections window opens, select the workbook name and click on Properties (see Figure 9)

Figure 9 - Workbook Connections

Then in Connection Properties dialog box select Enable background refresh and Refresh data when opening the file, then click OK (see Figure 10)

Figure 10 - Settings the Connection Properties

Now we have to save the Excel file in a trusted location, so before saving the Excel file first we have to specify a trusted location, to do that Select File menu and click on Options (see Figure 11)

Figure 11 - Specifying Trusted Location

In Excel Options window select Trust Center and click on Trust Center Settings (see Figure 12)

Figure 12 - Specifying Trusted Location

In Trust Center dialog window select Trusted Locations and click on Add new locations, specify a path for trusted source, then click OK (see Figure 13)

Figure 13 - Specifying Trusted Location

Click OK on Trust Center window, click OK on Excel Options window, then save the Excel workbook in some location, in this example I’m saving the Excel file in the same location (E:\Employees) where Excel Web Query File was saved

Now I will try to add the new Item in the SharePoint list, so we will see whether item is added in the Excel spread sheet (see Figure 14)

Figure 14 - Adding Item in Sharepoint List

Now I can see the newly item added SharePoint list is also updated in the Excel workbook (see Figure 14)

Figure 15 - Item Updated in the Connected Excel Workbook

Configure SharePoint 2010 Metadata Navigation and Filter

G Vijai Kumar — Mon, 01 Nov 2010 03:58:03 +0000

We have to discuss about the most thrilling and useful feature for the document library today.

Yes I’m talking about Metadata Navigation Settings in SharePoint 2010 document library.

SharePoint 2010 Metadata Navigation is the new piece of feature that supports to navigate and filter the documents in a library by means of metadata.

It is one of the most significant feature to navigate through the documents.

If we wants to navigate through the documents by metadata, first we have to configure the Metadata Navigation Settings

In this article I would like to show how to navigate and filter the documents by content types and columns

First of all I have enabled the document library to support the content types, please follow the article Document templates by using site content types in MOSS

However enabling site content types in SharePoint 2010 is similar to MOSS

So now I’m ready with the document library which contains few documents and content types like Word/Excel/Power Point documents etc.

I can create/upload documents using the above content types, so I have uploaded few documents (Word, Excel, PowerPoint etc) to my library can view in Figure 1

Figure 1 -SharePoint 2010 Document Library With Different Types of Document

Then, go to SharePoint 2010 document library > library settings

Under General Settings section click on Metadata navigation settings

Select fields from avaliable hirerarchy fields and add for configuring navigation

Then, select available key filter fields and add for configuring filters

Then, click on OK button (please follow Figure 2)

Figure 2 - Configuring Metadata Navigation and Filter Settings

Now, you are also most done, navigate the document library you can view the newly added section which shows the navigation hirerarchy and filtering options (see Figure 3)

Figure 3 - Navigation and Filtering Through Metadata

It allows filtering the document library documents by means of content types, columns.

After configure Metadata navigation, I can navigate through the document very easily by selecting the appropriate content type.
I can also filter the document library to show only one group of document types like word/excel/powerpoint/publisher/infopath document type.
It is possible to filter through column like….If I want to show only documents which belongs to HR/IT/Admin/Finance/Security department.

Most Common Custom WebParts Part 2 – Menu WebPart Shows Sites and Sub-Sites in Fly-Out Mode

G Vijai Kumar — Fri, 29 Oct 2010 05:12:49 +0000

In my previous post can view the most common custom webparts part 1

From last post I want to continue the series of most commonly used custom webparts, so once again I come up with a simple and small custom menu webpart shows all the sites and sub-sites of a SharePoint site in fly-out style

SharePoint Menu WebPart in fly-Out Style

using System; using System.ComponentModel; using System.Web; using System.Drawing; using System.Web.UI; using System.Web.UI.WebControls; using System.Web.UI.WebControls.WebParts; using Microsoft.SharePoint; using Microsoft.SharePoint.WebControls; namespace CustomWebParts.VisualWebPart1 { [ToolboxItemAttribute(false)] public class VisualWebPart1 : WebPart { // Visual Studio might automatically update this path when you change the Visual Web Part project item. // private const string _ascxPath = @"~/_CONTROLTEMPLATES/CustomWebParts/TreeView/TreeViewUserControl.ascx"; System.Web.UI.WebControls.Menu menu = null; protected override void CreateChildControls() { //Control control = Page.LoadControl(_ascxPath); //Controls.Add(control); menu = new System.Web.UI.WebControls.Menu(); SPSite site = SPContext.Current.Site; SPWeb web = SPContext.Current.Web; menu.StaticDisplayLevels = 1; menu.MaximumDynamicDisplayLevels = 200; menu.Orientation = System.Web.UI.WebControls.Orientation.Horizontal; menu.StaticEnableDefaultPopOutImage = false; menu.StaticPopOutImageUrl = "/_layouts/images/menudark.gif"; menu.SkipLinkText = ""; menu.DynamicHoverStyle.BackColor = System.Drawing.Color.FromName("#CBE3F0"); menu.CssClass = "ms-topNavContainer"; menu.StaticMenuItemStyle.ItemSpacing = Unit.Pixel(0); menu.StaticSelectedStyle.CssClass = "ms-topnavselected"; menu.StaticHoverStyle.CssClass = "ms-topNavHover"; menu.DynamicMenuStyle.BackColor = System.Drawing.Color.FromName("#F2F3F4"); menu.DynamicMenuStyle.BorderColor = System.Drawing.Color.FromName("#A7B4CE"); menu.DynamicMenuStyle.BorderWidth = Unit.Pixel(1); menu.DynamicMenuItemStyle.CssClass = "ms-topNavFlyOuts"; menu.DynamicHoverStyle.CssClass = "ms-topNavFlyOutsHover"; menu.DynamicSelectedStyle.CssClass = "ms-topNavFlyOutsSelected"; MenuItemStyle stMenuStyle = menu.StaticMenuItemStyle; stMenuStyle.CssClass = "ms-topnav"; stMenuStyle.HorizontalPadding = 0; stMenuStyle.VerticalPadding = 0; stMenuStyle.ItemSpacing = Unit.Pixel(0); MenuItemStyle dyMenuStyle = menu.DynamicMenuItemStyle; dyMenuStyle.CssClass = "ms-topNavFlyOuts"; dyMenuStyle.HorizontalPadding = 0; dyMenuStyle.VerticalPadding = 0; System.Web.UI.WebControls.MenuItem mItem = new System.Web.UI.WebControls.MenuItem(web.Title); mItem.NavigateUrl = web.Site.Url; menu.Items.Add(mItem); GenerateMenu(menu, Context); menu.DataBind(); this.Controls.Add(menu); } public static void GenerateMenu(System.Web.UI.WebControls.Menu menu, HttpContext context) { SPSite site = SPContext.Current.Site; SPWeb web = SPContext.Current.Web; foreach (SPWeb subsite in web.Webs) { System.Web.UI.WebControls.MenuItem mItem = new System.Web.UI.WebControls.MenuItem(); mItem.NavigateUrl = subsite.Url; mItem.Text = subsite.Title; mItem.ToolTip = subsite.Title; menu.Items.Add(mItem); BuildMenu(subsite, mItem, context); } } private static void BuildMenu(SPWeb subweb, System.Web.UI.WebControls.MenuItem mItem, HttpContext context) { SPSite site = SPContext.Current.Site; SPWeb web = SPContext.Current.Web; foreach (SPWeb subsite in subweb.Webs) { System.Web.UI.WebControls.MenuItem mSubItem = new System.Web.UI.WebControls.MenuItem(); mSubItem.NavigateUrl = subsite.Url; mSubItem.Text = subsite.Title; mSubItem.ToolTip = subsite.Title; mItem.ChildItems.Add(mSubItem); } } } }

Most Common Custom WebParts Part 1 – Tree View WebPart Shows Sites and Sub-Sites

G Vijai Kumar — Fri, 29 Oct 2010 04:26:07 +0000

I desired to support most common custom webparts used by the SharePoint professional, so that these can be helpful for them.
A custom tree view webpart shows all the sites and sub-sites of a SharePoint site

SharePoint Custom Tree View WebPart

Please use the below code and to get the exact look as show in the aboave image, the tree view webpart can expand/collapse

using System; using System.ComponentModel; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using System.Web.UI.WebControls.WebParts; using Microsoft.SharePoint; using Microsoft.SharePoint.WebControls; namespace CustomWebParts.CustomTreeView { [ToolboxItemAttribute(false)] public class CustomTreeView : WebPart { // Visual Studio might automatically update this path when you change the Visual Web Part project item. //private const string _ascxPath = @"~/_CONTROLTEMPLATES/CustomWebParts/CustomTreeView/CustomTreeViewUserControl.ascx"; TreeView myTree; LinkButton lnkBtnExpand; LinkButton lnkBtnCollapse; Label lblPipeDivider; Label lbl_ErrorMsg; private string errorMessage = string.Empty; private int level = 0; protected override void CreateChildControls() { //Control control = Page.LoadControl(_ascxPath); //Controls.Add(control); this.Controls.Clear(); myTree = new TreeView(); myTree.ExpandImageUrl = "/_layouts/images/tvplus.gif"; myTree.RootNodeStyle.ImageUrl = "/_layouts/images/stsicon.gif"; myTree.ParentNodeStyle.ImageUrl = "/_layouts/images/stsicon.gif"; myTree.LeafNodeStyle.ImageUrl = "/_layouts/images/stsicon.gif"; myTree.CollapseImageUrl = "/_layouts/images/tvminus.gif"; myTree.NoExpandImageUrl = "/_layouts/images/stsicon.gif"; myTree.NodeWrap = true; myTree.ShowLines = true; myTree.ShowExpandCollapse = true; myTree.EnableClientScript = true; GenerateTreeView(); myTree.CollapseAll(); myTree.CssClass = "ms-navitem a"; this.Controls.Add(myTree); lnkBtnExpand = new LinkButton(); lnkBtnExpand.Click += new EventHandler(expandAll_Click); lnkBtnExpand.Text = "Expand all"; lnkBtnExpand.CssClass = "ms-navitem a"; this.Controls.Add(lnkBtnExpand); lblPipeDivider = new Label(); lblPipeDivider.Text = " | "; this.Controls.Add(lblPipeDivider); lnkBtnCollapse = new LinkButton(); lnkBtnCollapse.Click += new EventHandler(collapseAll_Click); lnkBtnCollapse.Text = "Collapse all"; lnkBtnCollapse.CssClass = "ms-navitem a"; this.Controls.Add(lnkBtnCollapse); lbl_ErrorMsg = new Label(); this.Controls.Add(lbl_ErrorMsg); base.CreateChildControls(); } private void GenerateTreeView() { SPSite mySite = null; SPWeb myWeb = SPContext.Current.Web; SPSecurity.RunWithElevatedPrivileges(delegate() { try { mySite = new SPSite(myWeb.Site.ID); using (mySite) { level = 1; foreach (SPWeb subWeb in myWeb.Webs) { TreeNode myTreeNode = new TreeNode(subWeb.Title); myTreeNode.NavigateUrl = subWeb.Url; ReadSubSites(subWeb, ref myTreeNode); myTree.Nodes.Add(myTreeNode); } } } catch (Exception ex) { errorMessage = ex.ToString(); } }); } private void ReadSubSites(SPWeb subWeb, ref TreeNode myTreeNode) { try { foreach (SPWeb myChildSubWeb in subWeb.Webs) { TreeNode subnode = new TreeNode(myChildSubWeb.Title); subnode.NavigateUrl = myChildSubWeb.Url; myTreeNode.ChildNodes.Add(subnode); if (myChildSubWeb.Webs.Count > 0) { if (myTreeNode.ChildNodes.Count > 0) { level = level + 1; TreeNode myChildNode = myTreeNode.ChildNodes[myTreeNode.ChildNodes.Count - 1]; ReadSubSites(myChildSubWeb, ref myChildNode); level = level - 1; } } } } catch (Exception ex) { errorMessage = ex.ToString(); } } void expandAll_Click(object sender, EventArgs e) { myTree.ExpandAll(); } void collapseAll_Click(object sender, EventArgs e) { myTree.CollapseAll(); } protected override void RenderContents(HtmlTextWriter writer) { EnsureChildControls(); lnkBtnExpand.RenderControl(writer); lblPipeDivider.RenderControl(writer); lnkBtnCollapse.RenderControl(writer); RenderChildren(writer); } } }

Seminar – Getting Started with SharePoint in Hyderabad

G Vijai Kumar — Wed, 15 Sep 2010 12:54:07 +0000

We will be happy to announce that we are starting introductory session on SharePoint in Hyderabad, India on Sunday September 19th 2010 at 11:00 a.m. If you or your friends interested to join please let us know through the contact form
The seminar will be on topics of why SharePoint, where SharePoint and how SharePoint
Please forward this in the community, thank you.

Venu:

# 17, IInd Floor,
Above Cafe Coffee Day,
Beside ICICI Bank,
Vanasthali Puram,
Hyderabad.500070

Mobile: +91-9987491026 (or) 91-9030043050

Understanding SharePoint Property Bag Settings

G Vijai Kumar — Mon, 30 Aug 2010 16:14:23 +0000

Today my ex-coworker and friend ask me regarding SharePoint property bag, therefore I got an opportunity of posting this article on understanding SharePoint property bag settings.

SharePoint property bag is a good place where we are able to accumulate key and value like a couple, It’s a hash table.

There is no such user interface to view/add/edit/delete the property bag key-value, but there is an option to perform the actions on property bag via SharePoint designer.

After you open a site in SharePoint Designer, go to Site menu click on Settings option, a Site Settings dialog box opens, click on Parameters tab where you can see the list of existing properties, from the same place you can even perform add/modify/remove actions.

View SharePoint property bag properties using SharePoint Designer

Subsequently, prior to start on deep into property bag, we will discuss going on additional area some where we can store up value other than SharePoint property bag.

web.config file is too a place where we be able to accumulate the settings such as file location, URLs, etc.
Example:

In view of the fact that we have single global web.config file meant for complete site. If we would like to accumulate additional settings correlated to several sites we have to make multiple entries in web.config file.

One more method of storing the settings by creating table in database, this approach is not recommend all the time in SharePoint.

Even we can store values in SharePoint list by creating two columns like Keys and Values using OOTB functionality and still can access the key-value pair using object model.

But, if you have several settings related to different sites with some unique permissions for individuals sites then we have to decide where the list is to be created.

On the way to over come this situation SharePoint provided property bag to store the properties in several levels like SPFarm, SPWebApplication, SPSite, SPWeb and SPList.

Storing key-value in SPFarm include more danger that require farm administrator privileges.

Below are few examples on SPFarm, SPWebApplication, SPSite, SPWeb add/view/edit/delete property bag values.

Add property in SPFarm level

static void Main(string[] args) { SPFarm myFarm = SPFarm.Local; myFarm.Properties.Add("SPFarmKey", "SPFarmValue"); myFarm.Update(); Console.WriteLine("Press any key to continue....."); Console.ReadLine(); }

View SPFarm property

static void Main(string[] args) { SSPFarm myFarm = SPFarm.Local; if (myFarm.Properties != null && myFarm.Properties.Count > 0) { if (myFarm.Properties.ContainsKey("SPFarmKey")) { Console.WriteLine(myWebApplication.Properties["SPFarmKey"]); } } Console.WriteLine("Press any key to continue....."); Console.ReadLine(); }

Modify property in SPFarm level

static void Main(string[] args) { SPFarm myFarm = SPFarm.Local; myFarm.Properties["SPFarmKey"] = "NewSPFarmValue"; myFarm.Update(); Console.WriteLine("Press any key to continue....."); Console.ReadLine(); }

Delete property in SPFarm level

static void Main(string[] args) { SPFarm myFarm = SPFarm.Local; myFarm.Properties["SPFarmKey"] = null; myFarm.Properties.Remove("SPFarmKey"); myFarm.Update(); Console.WriteLine("Press any key to continue....."); Console.ReadLine(); }

Add property in SPWebApplication level

static void Main(string[] args) { SPWebApplication myWebApplication = SPWebApplication.Lookup(new Uri("http://WebApplicationURL")); myWebApplication.Properties.Add("SPWebAppKey", "SPWebAppValue"); myWebApplication.Update(); Console.WriteLine("Press any key to continue....."); Console.ReadLine(); }

View SPWebApplication property

static void Main(string[] args) { SPWebApplication myWebApplication = SPWebApplication.Lookup(new Uri("http://WebApplicationURL")); if (myWebApplication.Properties != null && myWebApplication.Properties.Count > 0) { if (myWebApplication.Properties.ContainsKey("SPWebAppKey")) { Console.WriteLine(myWebApplication.Properties["SPWebAppKey"]); } } Console.WriteLine("Press any key to continue....."); Console.ReadLine(); }

Modify property in SPWebApplication level

static void Main(string[] args) { SPWebApplication myWebApplication = SPWebApplication.Lookup(new Uri("http://WebApplicationURL")); myWebApplication.Properties["SPWebAppKey"] = "NewSPWebAppValue"; myWebApplication.Update(); Console.WriteLine("Press any key to continue....."); Console.ReadLine(); }

Delete property in SPWebApplication level

static void Main(string[] args) { SPWebApplication myWebApplication = SPWebApplication.Lookup(new Uri("http://WebApplicationURL")); myWebApplication.Properties["WebAppKey"] = null; myWebApplication.Properties.Remove("WebAppKey"); myWebApplication.Update(); Console.WriteLine("Press any key to continue....."); Console.ReadLine(); }

There is no facility to store properties in SPSite object similar to SPWeb object, if you want to store the settings in site collection level we have to use SPSite.RootWeb

Add/retrieve SPSite property

static void Main(string[] args) { SPSite siteCollection = new SPSite("http://servername:port"); SPWeb site = siteCollection.RootWeb; //Addning SPSite Property site.Properties.Add("SPSiteKey", "SPSiteValue"); site.Properties.Update(); //Reading SPSite Property Console.WriteLine(site.Properties["SPSiteKey"]); Console.WriteLine("Press any key to continue....."); Console.ReadLine(); }

Add/retrieve SPWeb property

static void Main(string[] args) { SPSite mySite = new SPSite("http://servername:port"); SPWeb myWeb = mySite.OpenWeb("Your Web Name....."); //Adding SPWeb Property myWeb.Properties.Add("SPWebKey", "SPWebValue"); myWeb.Properties.Update(); //Reading SPWeb Property Console.WriteLine(myWeb.Properties["SPWebKey"]); Console.WriteLine("Press any key to continue....."); Console.ReadLine(); }

A quick look on Sharepoint object model programs – Part 3

G Vijai Kumar — Sat, 28 Aug 2010 13:55:02 +0000

I have got the chance to post useful Sharepoint object model programs (part 3) with bare minimum lines of code and really handy even.
Please follow the link for a quick look on Sharepoint object model programs Part 1 and Part 2

Creating a Folder in a Document Library:

static void Main(string[] args) { try { SPSite mySite = new SPSite("http://servername:port"); SPWeb myWeb = mySite.OpenWeb(); SPList MyLibrary = myWeb.Lists["Your Document Library Name....."]; SPFolder myFolder = MyLibrary.RootFolder; SPFolder myChildFolder = myFolder.SubFolders.Add("Your Folder Name....."); myFolder.Update(); } catch(Exception ex) { Console.WriteLine(ex); } Console.WriteLine("Press any key to continue....."); Console.ReadLine(); }

Add fields to list:

static void Main(string[] args) { try { SPSite mySite = new SPSite("http://servername:port"); SPWeb myWeb = mySite.OpenWeb(); SPList myList = myWeb.Lists["Your List Name....."]; Guid listId = myList.ID; myList.Fields.Add("Employee ID", SPFieldType.Number, true); myList.Fields.Add("Employee Name", SPFieldType.Text, false); myList.Fields.Add("Designation", SPFieldType.Text, false); myList.Update(); } catch(Exception ex) { Console.WriteLine(ex); } Console.WriteLine("Press any key to continue....."); Console.ReadLine(); }

Creating a new view in a list:

static void Main(string[] args) { try { SPSite mySite = new SPSite("http://servername:port"); SPWeb myWeb = mySite.OpenWeb(); SPList mylist = myWeb.Lists["Your List Name....."]; StringCollection myFields = new StringCollection(); myFields.Add("Employee Name"); myFields.Add("Designation"); SPView myView= mylist.Views.Add("Your View Name.....", myFields, null, 100, false, false, SPViewCollection.SPViewType.Html, false); } catch(Exception ex) { Console.WriteLine(ex); } Console.WriteLine("Press any key to continue....."); Console.ReadLine(); }

Creating a new Content Type:

static void Main(string[] args) { try { SPSite mySite = new SPSite("http://servername:port"); SPWeb myWeb = mySite.OpenWeb(); SPContentTypeCollection myContentTypeCollection = myWeb.ContentTypes; SPContentType myContentType= new SPContentType(myContentTypeCollection[SPBuiltInContentTypeId.Item], myContentTypeCollection, "Content Type Name....."); myContentTypeCollection.Add(myContentType); } catch(Exception ex) { Console.WriteLine(ex); } Console.WriteLine("Press any key to continue....."); Console.ReadLine(); }

Adding the existing Site Columns to existing Content Type:

static void Main(string[] args) { try { SPSite mySite = new SPSite("http://servername:port"); SPWeb myWeb = mySite.OpenWeb(); SPFieldCollection myFieldCollection = myWeb.Fields; SPContentType myContentType=myWeb.ContentTypes["Content Type Name"]; myContentType.FieldLinks.Add(new SPFieldLink(myFieldCollection["Employee Name"])); myContentType.FieldLinks.Add(new SPFieldLink(myFieldCollection["Designation"])); myContentType.Update(); } catch(Exception ex) { Console.WriteLine(ex); } Console.WriteLine("Press any key to continue....."); Console.ReadLine(); }

Save site as template:

static void Main(string[] args) { try { SPSite mySite = new SPSite("http://servername:port"); SPWeb myWeb = mySite.OpenWeb(); myWeb.SaveAsTemplate("FiveNumber.stp", "FiveNumber", "Its All About SharePoint", true); } catch(Exception ex) { Console.WriteLine(ex); } Console.WriteLine("Press any key to continue....."); Console.ReadLine(); }

Delete Recycle Bin Items:

static void Main(string[] args) { SPSite mySite = new SPSite("http://servername:port"); SPWeb myWeb = mySite.OpenWeb(); SPRecycleBinItemCollection myRecycleBinCollection = mySite.RecycleBin; for (int i = 0; i < myRecycleBinCollection.Count; i++) { myRecycleBinCollection[i].Delete(); i--; } Console.WriteLine("Press any key to continue....."); Console.ReadLine(); }