Iterating Through All WebParts On Page

Posted in SharePoint 2007 Development |
Posted by Adam Buenz

One of my friends instant messaged me this morning and asked if it was feasible to use a method that would take an SPWeb object, and a URL as a parameter in order to return a collection of all the WebParts that coordinated with the URL. I haven't tested this method, but this is what I put together for him:

Select For Unformatted Code
C#:
  1. private static List<WebPart> GenerateWebPartCollection(SPWeb web, string url)
  2. {
  3. // Create A New SPLiimitedWebPartManager object to perform some WebPart operations on the page
  4. SPLimitedWebPartManager splwManager = web.GetLimitedWebPartManager(url, PersonalizationScope.Shared);
  5.  
  6. // Create a new generic collection that represents all the WebParts we found
  7. List<WebPart> wpCollection = new List<WebPart>();
  8.  
  9. // Loop through all the WebParts that are available
  10. foreach (WebPart webpart in splwManager.WebParts)
  11. {
  12. // if the generic collection does not contains that WebPart, add it
  13. if (wpCollection.Contains(webpart))
  14. {
  15. wpCollection.Add(webpart);
  16. }
  17. }
  18.  
  19. // return the generic collection of WebParts to get consumed later
  20. return wpCollection;
  21. }

Its a pretty simple method, the return should just be a colleciton of the WebPart objects that can be used later for whatever his application was attempting to do.

Share This

Leave a Reply