Updates from April, 2010 Toggle Comment Threads | Keyboard Shortcuts

  • Ali BaderEddin 9:18 pm on April 1, 2010 Permalink | Reply  

    Xml Editor Control 

    If you have a Windows Forms application that involves Xml editing or viewing, you can use this control to save yourself the effort of formatting the Xml content. For now, only syntax highlighting is implemented. I expect to add more features in the future like spacing, grouping, intellisense, etc…


    Simply add the files (XmlToken.cs, XmlTokenizer.cs, XmlEditor.cs, XmlEditor.designer.cs) to your project then drag and drop the XmlEditor control from the Toolbox into your Windows Form.

    The XmlEditor control currently has three public properties. Use AllowXmlFormatting to enable or disable formatting on the Xml content in the editor. The ReadOnly property tells whether or not to allow the user to change the text. The Text property sets or gets the text of the Xml editor.

    Here is how the control looks like when AllowXmlFormatting = true and ReadOnly = false (default values):


    To color the Xml string, we have to split it into multiple tokens, then color each token based on its type. I have identified the following token types (based on syntax highlighting behavior in Visual Studio 2008):

    • A “Value” is anything between double quotes
    • A “Comment” is anything that starts with <!– and ends with –> (or starts with <!– and is never closed with –>)
    • An “Element” is any letter or digit that falls between < and a space or >
    • An “Attribute” is any letter or digit that falls after a < followed by space and not closed by >
    • An “Escape” is anything that starts with & and ends with ; (For example &quote;)
    • A “SpecialChar” is any character that is not a letter or a digit
    • A “None” is anything else

    The Tokenize() public static method of the XmlTokenizer class does the job of splitting a string into Xml tokens.

    An XmlToken object is a representation of an Xml token with details about the exact text of that token, its location in the string and its type.

    Here is the code in the XmlEditor control that does the syntax highlighting:

    List<XmlToken> tokens = XmlTokenizer.Tokenize(xmlEditor.Text);
    foreach (XmlToken token in tokens)
        xmlEditor.Select(token.Index, token.Text.Length);
        switch (token.Type)
            case XmlTokenType.Attribute:
                xmlEditor.SelectionColor = Color.Red;
            case XmlTokenType.Comment:
                xmlEditor.SelectionColor = Color.DarkGreen;
            //  and so on for the other token types

    Download source and exe.

    • maria judi 5:37 pm on November 15, 2010 Permalink | Reply

      thak u_______

      ths is very useful for my project

    • Ali BaderEddin 8:55 pm on November 15, 2010 Permalink | Reply

      Glad it is..

    • Marco van Tintelen 5:58 am on January 10, 2011 Permalink | Reply

      Very nice!

    • rishi 10:02 am on February 9, 2011 Permalink | Reply

      intellisense: do you have support for that ? If not can you tell me how can I implement it. thanks in advance.

    • Colby Africa 8:32 am on March 4, 2011 Permalink | Reply

      Nice work! Are you okay if I start with this and extend it or is this “as-is” only?

      Thank you!


    • Ali BaderEddin 12:38 am on March 5, 2011 Permalink | Reply

      Sure… Please share the final version that you come up with.

      If you are planning to distribute it, it’s OK as long as you keep reference that it was originally created by me and link to this post in the source code…

    • Joseph Gordon 7:07 am on August 17, 2011 Permalink | Reply

      Great work here. Small performance tip: you have a re-entry issue in your FormatXml method, where changing the selectionColor fires the textbox_changed event, causing another call to FormatXml.

    • W 1:16 pm on February 17, 2012 Permalink | Reply

      Thanks. This is really helpful.

  • Ali BaderEddin 5:02 pm on March 18, 2010 Permalink | Reply  

    SPList Image and SPFile Icon 

    If you ever wanted to create a WinForms app for SharePoint that displays or interacts with lists, document libraries and files, then taking advantage of the SPList.ImageUrl and SPFile.IconUrl would help improve the user experience for your app.

    Below is an app that displays all the webs, lists, document libraries and files in a selected site collection.

    We can improve this a little bit by adding icons (taken from TEMPLATE\IMAGES frolder on a SharePiont installation) for some of the nodes, as follows:

    However, this is not good enough since we’ll have all lists with the same icon, all doc libs with the same icon and so on… Here is the same app taking advantage of the list image url and file icon url.

    For the list or document library, this is done by using the SPList.ImageUrl attribute. Here is howthe tree node was added:

    TreeNode listNode = parentNode.Nodes.Add(list.Title);
    listNode.SelectedImageIndex = listNode.ImageIndex = GetImage(GetImageFullPath(list.ImageUrl));

    For the file, this is done by using the SPFile.IconUrl attribute. Here is howthe tree node was added:

    TreeNode fileNode = parentNode.Nodes.Add(file.Name);
    fileNode.SelectedImageIndex = fileNode.ImageIndex = GetImage(GetImageFullPath(file.IconUrl));

    The GetImageFullPath method simply gets the full path of the image:

    /// <summary>
    /// Gets the SharePoint full path from the relative path
    /// </summary>
    /// <param name="relativePath"></param>
    /// <returns></returns>
    private static string GetImageFullPath(string relativePath)
        //  Get image name
        string imageName = Path.GetFileName(relativePath);
        //  Get SharePoint IMAGES folder path
        string fullPath = SPUtility.GetGenericSetupPath(@"TEMPLATE\IMAGES");
        return Path.Combine(fullPath, imageName);

    Given that now we have the full file system path to the image, all we have to do now is create an image from the file path then add it to the ImageList of the TreeView. The GetImage() method below does the job.

    /// <summary>
    /// Gets the image of the sp element from specified url
    /// </summary>
    /// <param name="url"></param>
    /// <returns></returns>
    private int GetImage(string url)
        //  Get image index from the Image List
        int imageIndex = spImageList.Images.IndexOfKey(url);
        //  Image is not in the list, so add it
        if (imageIndex == -1)
            //  Get the image from specified path
            Image image = Image.FromFile(url);
            //  Add the image to the image list
            spImageList.Images.Add(url, image);
            //  Get its index
            imageIndex = spImageList.Images.Count - 1;
        return imageIndex;

    Here is how the final app looks like. Click on the image below to download the src and exe.

  • Ali BaderEddin 6:18 pm on March 3, 2010 Permalink | Reply  

    How To Get All Site Urls Without Creating an SPSite object? 

    Let’s say you are trying to create a SharePoint admin tool that shows all site collections in the farm, then allows the user to interact with only the site collections of interest to him.

    To get all the site collection Urls in the farm, you’d usually go with the following approach:

    foreach (SPWebApplication webApp in SPWebService.ContentService.WebApplications)
        foreach (SPSite site in webApp.Sites)
            string fullSiteUrl = site.Url;

    The disadvantage in using such an approach is that we have to create an SPSite object for every site collection in the farm, then close it. That’ll mean a lot of work allocating and deallocating memory. Luckily, there is a better approach to do this, shown below:

    foreach (SPWebApplication webApp in SPWebService.ContentService.WebApplications)
        string webAppUrl = webApp.GetResponseUri(SPUrlZone.Default).AbsoluteUri; 
        foreach (string siteUrl in webApp.Sites.Names)
            string fullSiteUrl = webAppUrl + siteUrl;

    This way, we don’t have to create any of the expensive SPSite objects then close them. On a small farm, that’ll help your application load faster, but on a large farm with hundreds of site collections, this approach is necessary.

    You can find the full source for the SPSite ListView here. This was created as a Visual Studio 2008 project on top of SharePoint 2010 Beta, but you can easily remove the reference and add a reference to the 2007 Microsoft.SharePoint.dll.

  • Ali BaderEddin 4:50 am on February 11, 2010 Permalink | Reply  

    C# Windows Form is Busy 

    There are two very common ways of telling the user that your application is busy. One is to show a progress bar that gets updated based on the progress getting done, and another is to show the “Waiting” cursor while the application is doing work.

    Waiting Cursor

    To show the user the Waiting cursor while your program is busy, all you have to do is to set the current cursor to the Waiting cursor before your code runs, then set it back to an arrow after your code completes.

    Cursor.Current = Cursors.WaitCursor;
    //  Your Code
    Cursor.Current = Cursors.Default;

    Progress Bar

    The progress bar is a more user-friendly solution, but in most cases showing the waiting cursor does the job. Here is the simplest way to use a progress bar:

    int totalSteps = 10;
    for (int i = 1; i <= totalSteps; i++)
        //  One chunk of your code
        int progress = i * 100 / totalSteps;
        blocksProgressBar.Value = progress;
    blocksProgressBar.Value = 0;

    Yes, it’s that easy to implement a progress bar that gets updated based on the work done by your app. However, while progress is shown, the user can’t interact with the UI or do any other operation (the UI thread is the single thread doing the work here). To get the multi-threaded behavior, the easiest way is to use a background worker process, as shown below:

    So instead of putting your code in the event handler method, you will replace it with a call to start the worker process then move the code to the worker process events.

    private void doButton_Click(object sender, EventArgs e)

    The worker process will do its work in the DoWork event. To show progress, the code needs to be split into segments and the background worker ReportProgress method needs to be called whenever a segment of code is executed.

    private void backgroundWorker_DoWork(object sender, DoWorkEventArgs e)
        int totalSteps = 10;
        for (int i = 1; i <= totalSteps; i++)
            //  One chunk of your code
            int progress = i * 100 / totalSteps;

    Whenever progress changes, we need to update the value of the progress bar.

    private void backgroundWorker_ProgressChanged(object sender, ProgressChangedEventArgs e)
        blocksProgressBar.Value = e.ProgressPercentage;

    When the worker process is done (progress = 100%), we reset the progress bar.

    private void backgroundWorker_Completed(object sender, RunWorkerCompletedEventArgs e)
        blocksProgressBar.Value = 0;

    Below is a Windows Form application that lets you try the concepts explained above, and also shows you how the Marquee progress bar works, which is shockingly harder than the more realistic single-threaded progress bar we’ve discussed above.

    Download source and exe from here.

    • Paul 9:09 am on May 11, 2011 Permalink | Reply

      Thank You! That is exactly what I was looking for.

    • Mike 10:45 am on October 4, 2011 Permalink | Reply

      How do you tie a progress bar to sql query, returning data into a datagridview? It doesn’t have to be totally accurate, just doing something while the data is loading, then stopping once it has loaded…

    • Rudi Larno 8:49 am on December 8, 2011 Permalink | Reply

      Seems like the Marquee style does its work using the UI thread. So then it is logical that your options using System.Threading.Thread.Sleep(milliSecondsToWait); do not work, as you are blocking the UI Thread, not allowing your UI to get updated.

      Nice write up however.

    • yogesh makwana 8:58 pm on January 18, 2012 Permalink | Reply

      i want to know how to use marque in c#.net windowform…??????

    • Ankit Baria 5:31 am on September 14, 2012 Permalink | Reply

      Really helpful post. Thanks

    • http://tinyurl.com/guileasy48296 3:31 am on January 9, 2013 Permalink | Reply

      “C# Windows Form is Busy The Code Log” was
      in fact a truly awesome post, . Keep publishing and I’ll try to continue to keep reading through! Thanks for your time ,Louie

    • Khursheed Fateh 10:17 pm on May 12, 2014 Permalink | Reply

      See the modifivations I made to ylour program. Now Timer base progressbar is working.

      private Stopwatch s = new Stopwatch(); // Stopwatch
      private void progressButton2_Click(object sender, EventArgs e)
      showProgress = true;
      timer.Enabled = true;

      s.Start(); // start stopwatch in this method

      marqueeProgressBar.Style = ProgressBarStyle.Marquee; // set progressbar style in this method

      private void timer_Tick(object sender, EventArgs e)
      if ( s.Elapsed < TimeSpan.FromSeconds((double)secondsToWaitSpinner2.Value))
      // as long as elapsed time is less then the delay time
      // keep going
      toolStripStatusLabel1.Text = s.Elapsed.ToString(); // show elapsed time
      marqueeProgressBar.Style = ProgressBarStyle.Blocks;
      s.Stop(); // stop stop-watch here
      s.Reset(); // reset stop watch so that when you click again
      // it starts from begining and
      // not from where it stoped last time
      timer.Enabled = false;
      toolStripStatusLabel1.Text = "";

    • Khursheed Fateh 10:32 pm on May 12, 2014 Permalink | Reply

      “Before and after” part of your code is not working because it is freezing/stoping UI/Form for specified time. Because for the duration marquee is set Form remain froozen/unresponsive progressbar fails to show. You can see this by commenting last statement of method like this. Now you will see progressbar marquee was started but was unable to update itself because form was not responding during that time.

      private void progressButton_Click(object sender, EventArgs e)
      marqueeProgressBar.Style = ProgressBarStyle.Marquee;

      int milliSecondsToWait = (int)secondsToWaitSpinner.Value * 1000;

      // marqueeProgressBar.Style = ProgressBarStyle.Blocks;

  • Ali BaderEddin 11:41 pm on January 16, 2010 Permalink | Reply  

    Sortable ListView 

    The Windows Forms ListView control doesn’t provide column sorting functionality. So if you click on a column in a ListView Details view, don’t expect the items to be sorted by the clicked column. To get this functionality, we’ll need to sort the items by the clicked column in the ListView ColumnClick event. I searched online for “Sortable ListView” and I found three MSDN articles talking about this: Sort ListView Column in Visual C#, Sorting ListView Items by Column Using Windows Forms, and How to: Sort ListView Items. None of those implementations takes into consideration the type of the column being sorted. That is, they all do string sorting. If you have dates and numbers in your list, then they’ll not be sorted properly. For example, number 2 will be considered greater than 11. Date time 9/9/1400 will be considered greater than 11/11/2020. Below is an implementation that takes into consideration string, DateTime, int and double types. It can be easily extended to handle more types.

    • Add the SortableListView control to your Windows Form
    • When adding columns to the SortableListView, set the Tag attribute to the type of the column.
    sortableListView.Columns.Add("String Field").Tag = typeof(string);
    sortableListView.Columns.Add("DateTime Field").Tag = typeof(DateTime);
    sortableListView.Columns.Add("Int Field").Tag = typeof(int);
    sortableListView.Columns.Add("Double Field").Tag = typeof(double);
    • Now, you can add the items as usual.

    For example, the below list is sorted by the DateTime field.

    Sortable ListView

    Sortable ListView

     Click on the above image to download the SortableListView control.

    • Mayank Raichura 9:21 am on October 6, 2011 Permalink | Reply

      Great article and a really nice control. Just one question…. why didn’t you add a new Property of, say, ColumnType? I mean this could let the tag property to be used for other purposes….

      Anyways….thank you very much for the control….its really really awesome…

Compose new post
Next post/Next comment
Previous post/Previous comment
Show/Hide comments
Go to top
Go to login
Show/Hide help
shift + esc

Get every new post delivered to your Inbox.

Join 25 other followers

%d bloggers like this: