Showing posts with label Custom. Show all posts
Showing posts with label Custom. Show all posts

Saturday, August 31, 2013

A generic web part to display any List or Library from any site

I have seen this question asked so many times over and over again, that it makes me think why Microsoft doesn’t provide this web part out-of-the-box. My client needed an easy way to just display few List columns on a child-site (while all other columns remain hidden), from a List available on the parent site. That should have been easy, pretty much, having the proper security in-place. But wait !! Much to my disappointments, I was stuck with every available options/solutions that I found on the www, after progressing to some extent.

Well, I know there are few that are available to choose from, but with hell lot of limitations:

-You can use the OOB Content Query web-part (CQWP). This appears to be a “hot” favorite for most people out there, but seems like you have to mess around with the xslt files to add more columns and get the things working. Yikes! my client didn’t want to be doing that every time you need to change the display view.

-You may use these code-plex solutions (this & this ) that does say about extending this CQWP and getting the job done. But I just couldn’t get that working. My bad! may be you are lucky.

-You can use the third-party Lightning Conductor web part, which was not acceptable to my client either.

So here I am. Came-up with this idea of setting up a custom web-part with custom properties to cater to my client needs. This seems pretty much generic in nature in my environment, given the site-hierarchies and security/permissions in-effect. This may not be exact same in your case and would need some re-thinking in different scenarios.

My Scenario:

-Parent site accessible only to the Finance department (who are AD users).

-Parent Site contains a List “Timecards” containing 12 different columns.

-One of its Child site “Contractors” have the security inheritance broken, and is “read-only” accessible to all AD-Users.

Client Requirement:

-All users of Finance department can see and access all 12 columns of this List “Timecards” (which is in-fact, true by default).

-All users of all departments can see “ONLY” few columns of this List “Timecards” on the child site “Contractors” which is read-only access to all.

-Site owners should be able to easily-control the specific columns to be made available for viewing on the child site.

Solution:

So what I proposed was a custom web part, that pulls the columns made available to a specific “VIEW” of the List “Timecards” containing only the needed columns on the parent site. The view can be easily maintained and modified by the site owners. In essence, this web part can actually connect to any site and pull any list data for any specified view. The data would be displayed using the SPGridView with CSS classes attached to each column for further look-n-feel changes.

Input parameters:

[SiteURL] : A custom property to specify the url to the source site hosting the List.

[ListName] : A custom property to specify the name of the source List.

[ViewName] : A custom property to specify the name of the View made available in the source List.

Implementation:

Step 1: Define Variables and properties

// Set the default values
        private string c_SiteURLDefault = "";
        private string i_ListView = "AllItems";
        private string i_ListName = "Shared%20Documents";
        private SPGridView _gridView;
        private string ROW_CSSCLASS = "nch-row-style";

// Create custom category in the property sheet and the properties as well
        [Category("Custom Properties")]
        [Personalizable(PersonalizationScope.Shared)]
        [WebBrowsable(true)]
        [DisplayName("Site URL")]
        [WebDescription("Site URL containing the List.")]
        public string SiteURL
        {
            get { return c_SiteURLDefault; }
            set { c_SiteURLDefault = value; }
        }

        [Category("Custom Properties")]
        [Personalizable(PersonalizationScope.Shared)]
        [WebBrowsable(true)]
        [DisplayName("List Name")]
        [WebDescription("Name of the List.")]
        public string ListName
        {
            get { return i_ListName; }
            set { i_ListName = value; }
        }

        [Category("Custom Properties")]
        [Personalizable(PersonalizationScope.Shared)]
        [WebBrowsable(true)]
        [DisplayName("List Name")]
        [WebDescription("View Name of the List to display.")]
        public string ListView
        {
            get { return i_ListView; }
            set { i_ListView = value; }
        }

Step 2: Initialize Constructor

       public DisplayListsLibrariesWebPart()
           : base()
       {
           _gridView = null;
       }

Step 3: Define other methods

//Method to return a data table populated with all items from a list passed to it.

       private DataTable GetSource(SPList splist)
       {
           DataTable table = splist.Items.GetDataTable();

           return table;
       }

//Method to check if a List contains a specific View. Returns “True” if found else returns “False”.

       private bool HasView(SPList list, string viewName)
        {
            if (string.IsNullOrEmpty(viewName))
                return false;

            foreach (SPView view in list.Views)
                if (view.Title.ToLowerInvariant() == viewName.ToLowerInvariant())
                    return true;

            return false;
        }

Step 4: Define CreateChildControls

            LiteralControl errmsg = new LiteralControl();
            //Variable to store a list of accessible sites.
            System.Text.StringBuilder sb = new System.Text.StringBuilder();

            //Define your CSS styles. These classes can be over-written from within CEWP codes on the page where this web-part would be deployed.
            sb.Append(@"<style type='text/css'>");
            sb.Append(@".ms-vh2-gridview{text-align:left;}");
            sb.Append(@"</style>");

            try
            {
                if (SiteURL.ToString() != "") //if Site URL is provided in the web part property.
                {
                    SPSecurity.RunWithElevatedPrivileges(delegate()
                    {
                        //Access the Site URL from the web part properties.
                        using (SPSite site = new SPSite(SiteURL.ToString()))
                        {
                            #region Open an instance of the web.

                            //Open an instance of the web.
                            using (SPWeb targetWeb = site.OpenWeb())
                            {
                                // targetWeb provided using an absolute url is now available through OpenWeb() call directly.
                                //Next, retrieve all the user-accessible sites-subsites of the "Site URL" site-collection.

                                //Check if the List exists
                                SPList myList = targetWeb.Lists.TryGetList(ListName);
                                if (myList != null) //If List exists
                                {
                                    #region Check View exists - If-Else.

                                    //List exists, now check if the List View exists.
                                    if (HasView(myList, ListView))
                                    {
                                        //View exists, get the view.
                                        SPView listView = myList.Views[ListView];

                                        //Get the columns of the view
                                        SPViewFieldCollection viewfieldCollection = listView.ViewFields;

                                        DataTable table = GetSource(myList); //Get the List Items in a datatable.

                                        //if data-table returns rows.
                                        if (table != null)
                                        {
                                            _gridView = new SPGridView(); //Instantiate grid
                                            _gridView.ID = "_gridView";
                                            _gridView.AutoGenerateColumns = false;
                                            _gridView.Width = new Unit(100, UnitType.Pixel);
                                            _gridView.DataSource = table.DefaultView;

                                            //Set Row Alternating back color style
                                            _gridView.CssClass = ROW_CSSCLASS;

                                            string sColor = "#eeeeee";
                                            Int32 iColorInt = Convert.ToInt32(sColor.Substring(1), 16);
                                            Color alternatingRowStyleColor = System.Drawing.Color.FromArgb(iColorInt);
                                            _gridView.AlternatingRowStyle.BackColor = alternatingRowStyleColor;
                                            _gridView.EnableViewState = false;


                                            #region Get data from the list view.

                                            // Get data from the list view.
                                            SPListItemCollection items = myList.GetItems(listView);

                                            //Display each column values for each rows
                                            foreach (string viewFieldName in viewfieldCollection)
                                            {
                                                SPField columnDet = myList.Fields.GetFieldByInternalName(viewFieldName);

                                                _gridView.Columns.Add(new SPBoundField { DataField = viewFieldName.ToString(), HeaderText = columnDet.ToString() });

                                            }

                                            _gridView.DataBind();
                                        }
                                        else
                                        {
                                            //Data in the list doesnot exist.
                                            errmsg.Text = "No data found in the Source List.";
                                            throw new Exception(errmsg.Text.ToString());
                                        }

                                        #endregion
                                    }
                                    else
                                    {
                                        //View doesnot exist.
                                        errmsg.Text = "List View parameter invalid or cannot be empty. Please provide the correct value by editing the web part custom properties.";
                                        throw new Exception(errmsg.Text.ToString());
                                    }

                                    #endregion
                                }
                                else
                                {
                                    //Invalid List name. Throw exception.
                                    errmsg.Text = "Site URL or List Name parameter(s) invalid or cannot be empty. Please provide the correct value by editing the web part custom properties.";
                                    throw new Exception(errmsg.Text.ToString());
                                }
                            }

                            #endregion
                        }
                    });
                }
                else
                {
                    errmsg.Text = "Site URL parameter invalid or cannot be empty. Please provide the correct value by editing the web part custom properties.";
                    throw new Exception(errmsg.Text.ToString());
                }
            }
            catch (Exception ex)
            {
                //Display the error message.
                errmsg.Text = ex.Message.ToString();
                this.Controls.Add(errmsg);
                return;
            }

            //Add the styles for the gridview.
            LiteralControl mystyles = new LiteralControl();
            mystyles.Text = sb.ToString();
            this.Controls.Add(mystyles);

            //Display the list gridview.
            this.Controls.Add(_gridView);
            this.Controls.Add(new Literal { Text = "<hr/>" });

Step 5: Compile, Build & Deploy !!! If needed activate the feature, add the web part to the page and set the custom properties. You get a clean sharepoint like UI displaying the list rows.

Thanks for going through this entire long post !

Saturday, July 6, 2013

Remove the Group Label from the “Group By” List Views

This had to be simple java-script, so a quick search on the internet returned me a 2011 Blog post by “Alexander Bautx” which works “AS-IS”. I had to just replace the single-quotes (‘) by deleting and inserting it back again for all of it’s existence, and that’s it. Probably it was due to the copy-paste formatting issue. I have highlighted the change below, which appears at 4 places in his code.

But this was awesome!! Kudos to Alexander.

Note: You may not need the first line reference for the jquery, if you already have it in your master page.

$(this).find("a:last")[0].nextSibling.nodeValue = '';

Saturday, April 20, 2013

Formatting Texts in a SharePoint List Item columns

This could be an old-school  thought of wanting to apply different formats to the values stored in list columns.

Well, one can definitely go a number of ways to achieve that, but here’s an approach when an end-user can drop some code in a calculated field to achieve this very easily and more precisely, getting to a number of different formatting styles.

Format 1: Displaying a Hyperlink Text in a calculated column

Create three columns in a list as below:

Column1: [ActualURL] of type “Single line of text”. (We will store values like “http://neerajch.blogspot.com” in this column)

Column2: [URLTitle] of type “Single line of text”. (We will store values like “NeerajCh” in this column)

Column3: [HyperlinkHTML] of type “Calculated”.

Type the below in the Formula box:

=CONCATENATE("<DIV><a href='",ActualURL,"'>",URLTitle,"</a></DIV>")

Select “Number (1, 1.0, 100)” in the [Data Type returned from this formula] section.

Leave the “Automatic” in [Number of Decimal Places].

That’s it. Hit OK and create one new list entry with values mentioned above. [Title] can be anything.

You should see something like this. Hurray !!!

image

Now that “Concatenated” formula piece can be a real handy and fruitful, if used wisely. Let’s see another small example.

Format 2: Displaying a Hyperlink Text in a calculated column as BOLD

With the same configurations for the list columns as above, we modify the formula to include <b> & </b> tags within the <DIV>.

=CONCATENATE("<DIV><b><a href='",ActualURL,"'>",URLTitle,"</a></b></DIV>")

And now you see something like this:

image

Wow, I know, you must be smiling. Smile Nothing great here!! Just plain HTML. And that is my intent.

Let the things be as simple as they can be, for this has to be done by an end user not a developer/designer.

So the end users now have a great handy tool and can make it even powerful, if they can extract more complex HTMLs from their peer developers and embed here.

Saturday, January 19, 2013

Display “Upload Document” button on any web part page

So my client got a little too fancy about having a way to upload documents from anywhere on “a site”, to a particular document library available within that site.

Referring to the SharePoint way of uploading documents as below, I was made to run for a solution that would allow them to add this functionality to any web part page.

image

This wasn’t that bad of a thought. Well, at the end it got out to be quite straight forward, if you are happy and comfortable with java-script.

This is what was done, to allow them quickly add a script in a content editor and display a huge button like this:

image

Now the code:

<div class="ms-uploadbtnlink">
  <button onclick="javascript:OpenNewFormUrl(&#39;Documents/Forms/upload.aspx&#39;);return false;" type="submit">
    <nobr>
     <img alt="Upload Document" src="/_layouts/Images/uploaddoc.png"/>&#160;<span>Upload Document</span>
    </nobr>
  </button>
</div>

Thanks for reading!

Sunday, November 25, 2012

Displaying custom User Name in the Welcome Menu

I have seen so much content about approaching this problem in several ways, which to me are kind of solutions that they either:

-Force you to spend un-necessary long man-hours,

-Write too much of custom codes (writing user controls, etc.),

-Makes you try to understand the Welcome.ascx user control (really?? why? Microsoft has already done that).

So eventually, I ended up writing this post for the benefit of all.

SharePoint is an awesome “PLATFORM”, yes, I call it a platform. Not a Tool, or Application or a CRM or a portal, or a …. and the list goes on. By calling it a platform, I am encapsulating all of them together.

So, with so many stuff already provided out-of-box, we only need to know how to leverage them in a best possible manner to our benefits.

By leveraging, I also mean utilizing the excellent work that is being done by one of the Microsoft’s biggest community, the SharePoint community. You’ll find tons & tons.

The one such work that I am referring to is the SharePoint Services Library on CodePlex. Please find it here.

By using this, I have gotten to get this working in the most minimal way that I could find. Below are the pieces of the code that you would need to get your Welcome menu read aloud “Welcome Tango Charlie”. Pre-requisites being that you have a properly configured User Profile (and of course, if your name is Tango Charlie).

Okay, so we are going to modify our SP 2010 Master Page and place some lines of code in the <head> section.

Step 1: You may download the .js file and insert a script reference to the SPServices library within your <head>…</head> tags:

<script type="text/javascript" src="/_layouts/scripts/jquery-1.4.2.js"></script>
<script type="text/javascript" src="/_layouts/scripts/jquery.SPServices-0.7.2.min.js"></script>

Pre-requisites:

a) You should make sure that you have a JQuery script references before referring to SPServices.

b) Refer the SPServices on CodePlex as the JQuery version requirements are strict for what version of SPServices you are using.

Step 2: Place the below script anywhere within your <head>…</head> tags as long as they follow the tags mentioned in Step 1.

<!-- Format the Welcome Menu -->
<script language="javascript" type="text/javascript">
        $(function() {
            var userFirstName = $().SPServices.SPGetCurrentUser({
                fieldName: "FirstName",
                debug: true
            });

            var userLastName = $().SPServices.SPGetCurrentUser({
                fieldName: "LastName",
                debug: true
            });
           
            var displaySection = $('span.ms-welcomeMenu').children('a.ms-menu-a').children('span');
            var textToShow = 'Welcome ' + userFirstName + ' ' + userLastName;
            // Set the text back to the Welcome Menu
            displaySection.text(textToShow);

          });

</script>

And that’s it. You have your name displayed with the “Welcome” prefix.

Try playing with the combinations/permutations of [fieldName: "FirstName"] and [fieldName: "LastName"] to get different text to display. Good Luck.

Saturday, October 13, 2012

Creating a Countdown Feature based on List definition and Timer Job

In this post, I’ll be elaborating on some of the interesting aspects of SharePoint 2010 programming while trying to work on a project to create a countdown timer job for a visual web part packaged as a SharePoint feature. Some of these would include:

Part 1 - How to include the GUID generator in Visual Studio 2010. (This post)

Part 2 - How to create a Visual web part utilizing custom List Definition and List Instance without using Content Types.

Part 3 - How to include sample data with the List instance deployment.

Part 4 - How to create, deploy and utilize a Timer Job.

Before we jump into the List Definition, let’s first do a prep-work, much needed for the most of the Content development in SP 2010. Even though the GUID Generator can be accessed online here, I prefer to use it in my VS 2010 IDE.

- Start VS 2010. Go to [Tools] –> [External Tools].

- Provide the “Title” = “Create GUID”

- In the “Command”, click the “…” button next to it, and browse to the location “C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\Bin\guidgen.exe”.

- Click [Add] and then click [OK].

image

You should be now able to see an option to create GUID right from this Tools menu in VS 2010:

image

That’s it in Part 1 for our prep-work. I’ll start with the List definition in Part 2.

Saturday, September 8, 2012

Custom 404 Page Not found in SharePoint 2010

 

Well, now that we have successfully upgraded the MOSS 2007 sites to SharePoint 2010, there was a slight change in the URL structure in the new environment. In 2010, the site collection was moved to the top root level, more details on how to do this can be found here, as described below:

MOSS 2007: http://www.domianname.com/sitename/Pages/Home.aspx

SP 2010: http://www.domianname.com/Pages/Home.aspx

The issues that were identified:

#1. Bookmarked URLs might break for current users.

#2. The embedded deep-links in various email notifications already sent, may not work anymore.

#3. The various links to many pages, made available on other sites may start breaking with a page not found error.

The quick resolution that was agreed upon:

To implement a generic, custom page that should be displayed each time a user hits a 404 page not found error. This page would have a generic message and a link to take the user back to the home page.

How we did this:

Step 1: Create a meaningful 404CustomPage in the Site-Collection

a. Open-up the site and create a new Web-Part page in the Pages Library. Call it :”MyCustom404.aspx”.

b. Note the page URL; it should be “/Pages/MyCustom404.aspx”.

c. Design the page as per the business requirements by inserting Content Editors and Image web parts.

d. Place a generic but meaningful text on a content editor along with a link pointing back to, say, Home page.

Step 2: Create the Web Config Entries for the Web Application

a. Open-up the web-config file for the web application.

b. Create an entry for <httpErrors> section within the <system.webServer> as below:

<httpErrors errorMode="Custom" existingResponse="Auto">

<remove statusCode="404" subStatusCode="-1" />

<error statusCode="404" prefixLanguageFilePath="" path="/Pages/MyCustom404.aspx" responseMode="ExecuteURL" />

</httpErrors>

c. Save the config file and do an IISRESET.

Now go back and try to browse to a non-existing page on the site and you should see the custom 404 page being displayed.

Improvements that I can think of:

1. We can have a redirect logic on our custom 404 page to programmatically fix the url and redirect the user to the new page url.

2. We can also create a SP 2010 Solution package to automate the process of updating the web config file. This really helps in a multi-environment deployments by the admins.

I hope to get this improvements in-place in the next couple of weeks. I’ll update this post with the link to my new post so till then, have a nice time.