SPList’s Title Property & SPField’s DisplayName not Updating

November 14 2011 15 comments

We encountered a problem which seemed really strange while provisioning our site collection with PowerShell (New-SPSite). Our provisioning contains programmatic custom list creation to our publishing webs via feature receivers. The procedure is that the feature receiver creates the list with a URL friendly Title and then changes the Title to a UI friendly version. Say, a list “orderform” is created and then the name of the list is changed to “Order Form” would result that we have a list “Order Form” at URL http://sharepointsite/lists/orderform.

What would you say if I told you that you can’t change the Title of a list after it is created with PowerShell or custom console app, if you are working with sites any other language than English. Well it’s true. I’ve tested it with two Team Sites, one in English and another in Swedish and by creating a generic list “Temp” to both of them. Then I tried the following PowerShell commands on both of the sites.

  • $web = Get-SPWeb(“http://sharepointsite”)
  • $list = $web.Lists[“Temp”]
  • $list.Title = “Temp2”
  • $list.Update()

The commands above update the “Temp” List’s Title to “Temp2″ when my $web is the English team site but nothing happens if I run the same commands to my Swedish site. First I run the PowerShell commands to the sites

Then I wonder why the Swedish site’s list title has not been updated…

…while the English site’s list title is updated as expected.

The resolution to the problem lies in the API. While trying to figure out what was going on by narrowing our use case which was a pretty large scale provision to the fact that you can’t edit list’s title even with PowerShell consisted of the following steps and remarks:

  • The SPList SchemaXml property consists of a root element List, which has an attribute Title: the english site had Title=”Temp2″ while Swedish site had Title=”Temp” but the SchemaXmlInCurrentUiCulture property had a correct Title-attribute in the Swedish site’s case Title=”Temp2″
  • After running IISRESET, the first page load in Swedish site’s /_layouts/viewlsts.aspx showed the updated Title “Temp2″ of the list but after that page loads resulted the Title being the original “Temp”
  • While Googling, I came across this blog post by Vojtech Nadrovnik, which describes a similar problem but with SPField‘s DisplayName and the fact that Vojtech resolved the issue with reflection after first digging into the SharePoint code with a disassembler
  • Following Vojtech’s example, I tried some disassembling myself with ILSpy and found out that there is a very similar condition in SPList’s Title property’s setter (the last if) as seen in Vojtech’s SPField case

Some properties ARE NOT updated if the Thread’s UI Culture IS NOT the same as the web’s UI Culture.

If you have a feature and a receiver which might be activated by some other means than from the UI (_layouts/ManageFeatures.aspx) or any other piece of code that might be run outside SharePoint’s context, you could handle the problems described above by changing the thread’s UI Culture to the web’s UI Culture programmatically and it would work in any language as the following sample illustrates (different from Vojtech’s resolution):

public override void FeatureActivated(SPFeatureReceiverProperties properties)
{
    SPWeb web = properties.Feature.Parent as SPWeb;
    string title = "Temp";
    string displayName = "Temp2";
    CultureInfo originalUICulture = Thread.CurrentThread.CurrentUICulture;
    bool allowUnsafeUpdates = web.AllowUnsafeUpdates;
    try
    {
        if (SPContext.Current == null)
        {
            // IF CURRENT THREAD'S UI CULTURE
            // IS NOT THE SAME AS WEB'S UI CULTURE,
            // STRANGE THINGS CAN HAPPEN
            Thread.CurrentThread.CurrentUICulture =
                new CultureInfo((int)web.Language);
        }
        web.AllowUnsafeUpdates = true;
        // create list
        Guid listId = web.Lists.Add(title, "",
            SPListTemplateType.GenericList);
        // get newly created list by id
        SPList list = web.Lists[listId];
        // change list's title
        list.Title = displayName;
        list.Update();
    }
    finally
    {
        web.AllowUnsafeUpdates = allowUnsafeUpdates;
        if (SPContext.Current == null)
        {
            // TOGGLE THE UI CULTURE BACK
            Thread.CurrentThread.CurrentUICulture =
                originalUICulture;
        }
    }
}

Popularity: 3% [?]

15 comments to “SPList’s Title Property & SPField’s DisplayName not Updating”

  1. Juha Pitkänen says:

    This is actually documented on MSDN (http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.splist.title.aspx). TitleResource being the key word.

  2. Juha Pitkänen says:

    Here is a solution for changing Thread’s UI culture in PowerShell: http://blog.andersdissing.com/2011/07/change-powershell-ui-culture.html.

  3. Fredrik says:

    Thank you soooo much Juha! This fixed everything, even my missing field descriptions, which was unexpected!

  4. Carsten says:

    Thank you very very much! You just saved me some headaches :)

  5. Thank you soooo much for this. I don’t know what they were thinking when adding this validation.

  6. claes says:

    I don’t know how many days I’ve spent cursing over inconsistencies in how sharepoint deals with titles/displayname for fields and lists. The behavior I encountered made no sense, but having read this thread I’ll have to go through it again and see if I can make sense of it.

  7. Levi says:

    I see a lot of interesting content on your page. You
    have to spend a lot of time writing, i know how to save you a lot
    of work, there is a tool that creates unique, SEO friendly
    articles in couple of minutes, just type in google –
    k2 unlimited content

  8. Orval says:

    You post interesting content here. Your website deserves much more traffic.
    It can go viral if you give it initial boost, i know very useful service that can help you, simply
    type in google: svetsern traffic tips

  9. ChuckNorris says:

    Amazing ouyeah !

  10. Hello Dear, are you in fact visiting this website on a regular basis, if so then you will definitely get good
    knowledge.

  11. Viki.com says:

    Thanks for any other fantastic post. Where else may just anybody
    get that type of info in such a perfect way of writing? I have a presentation next week, and I’m at the search for such information.

  12. It’s awesome designed for me to have a web page, which is useful
    in support of my know-how. thanks admin

  13. [...] set the environment’s culture to the culture of the web as per this article but it seemed to have no effect. I tried setting an xml with updated displayname [...]

  14. Akın says:

    Problem solved. Thanks!

Leave a Reply