Monday, December 24, 2012

Define the List View for XsltListViewWebPart

When you add XsltListViewWebPart to your page, you will have needs to define the proper list view for the XsltListViewWebPart.

There are two ways you can define the list view for a XsltListViewWebPart programmatically.

First, you can reference to an existing list view of the list from the XsltListViewWebPart. Second, you can use a reflection to change the SPView object currently associated with the XsltListViewWebPart. This is more or less a hack since SharePoint doesn't expose the list view object as public property.

The first step is to get the XsltListViewWebPart from the page using SPLimitedWebPartManager

SPLimitedWebPartManager webPartManager = file.GetLimitedWebPartManager(PersonalizationScope.Shared);
if (webPartManager == null)
foreach (System.Web.UI.WebControls.WebParts.WebPart wp in webPartManager.WebParts)
    // Only handle xslt web part
    XsltListViewWebPart xsltwp = wp as XsltListViewWebPart;
    if (xsltwp == null)

The second step is to get the list and list view of the list.

 // Get list by listUrl
 // catch invalid list url exception
   list = web.GetList(webServerRelativeUrl + "/" + listUrl);
   view = list.Views[viewName];
 catch (Exception expt)
   EventLogger.LogError("SetXsltWebPartView:" + expt.Message + expt.StackTrace);

The third step is to set and save the list view of the XsltListViewWebPart

// Must set ViewId and ViewGuid at the same time
xsltwp.ViewId = Int32.Parse(view.BaseViewID);
xsltwp.ViewGuid = view.ID.ToString("B");

This approach may not work for some XsltListViewWebPart, for example I found if the list is External List, this won't work. Another approach is to use reflection to get the "ContextView" property as SPView object and change the SPView object.

PropertyInfo pi = xsltwp.GetType().GetProperty("ContextView"BindingFlags.NonPublic | BindingFlags.Public | BindingFlags.Instance);
SPView view = (SPView)(pi.GetValue(xsltwp, null));
SetXsltListViewCustodianView(web, view);        

public static void SetXsltListViewCustomerView(SPWeb web, SPView view)
    //Create view
    string viewQuery = "<OrderBy><FieldRef Name=\"FirstName\" /></OrderBy>";
    view.Query = viewQuery;
    view.Paged = true;
    view.RowLimit = 3;
    view.DefaultView = true;

Happy SharePointing!

1 comment:

  1. Hi,
    Is it possible to edit the webpart view during the creation of the webpart. Or is it only possible to edit the webpart view when it is already existing on the page( i.e after the webpart is created)?
    I tried the above concept of editing webpart view using reflection in powershell during the time of creation of webpart.

    $webpart = New-Object Microsoft.SharePoint.WebPartPages.XsltListViewWebPart
    $webpart.ListId = $list.ID;
    $webpart.ViewGuid = $list.DefaultView.ID.ToString();
    $webpartmanager.AddWebPart($webpart, “Zone 1″, 0);

    $wptype = $webpart.GetType()
    $viewProperty = $wptype.GetProperty('ContextView',[Reflection.BindingFlags]'NonPublic,Instance')
    $view = $viewProperty.GetValue($webpart,$null)

    I am getting error at $view = $viewProperty.GetValue($webpart,$null). I am getting valid values in $wptype & $viewProperty. the error is related to GetValue(). Can you tell me what is wrong with the code.....