Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

SPLimitedWebPartManager Class

SharePoint 2010

Provides a limited set of Web Part operations that can be performed in object model scenarios when there is no HttpContext and no instantiated Page object.

System.Object
  Microsoft.SharePoint.WebPartPages.SPLimitedWebPartManager

Namespace:  Microsoft.SharePoint.WebPartPages
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No
C#
VB
Copy 
[ClientCallableTypeAttribute(Name = "LimitedWebPartManager", ServerTypeId = "{ac641ade-62df-49c9-af8e-abda6278e920}")]
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public sealed class SPLimitedWebPartManager : IDisposable

SPLimitedWebPartManager provides a subset of the operations available on the SPWebPartManager. It is primarily used for object model scenarios in which there is no HttpContext and no instantiated Page object."

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
GetLimitedWebPartManager() method returns a SPWeb object which needs to be disposed.
GetLimitedWebPartManager() method returns a SPWeb object which needs to be disposed.



void SPLimitedWebPartManagerNoLeak()

{

    using (SPSite siteCollection = new SPSite(http://moss))

    {

        using (SPWeb web = siteCollection.OpenWeb())

        {

            SPFile page = web.GetFile("Source_Folder_Name/Source_Page");



            using (SPLimitedWebPartManager webPartManager = page.GetLimitedWebPartManager(PersonalizationScope.Shared))

            {

               try

               {

                 // ...

               }

               finally

               {

                   webPartManager.Web.Dispose();

               }

            }

        } // SPWeb object web.Dispose() automatically called







History
This is how you can find particular webpart type from the page
//Here i have to find all ContentByQuery webparts from the page
Microsoft.SharePoint.WebPartPages.SPLimitedWebPartManager manager = web.GetLimitedWebPartManager("Pages/default.aspx", PersonalizationScope.Shared);
 
            foreach (Microsoft.SharePoint.WebPartPages.WebPart webPart in manager.WebParts)
            {
                //<type name="Microsoft.SharePoint.Publishing.WebControls.ContentByQueryWebPart, Microsoft.SharePoint.Publishing, Version=14.0.0.0,   Culture=neutral, PublicKeyToken=71e9bce111e9429c" />
                Type type = webPart.GetType();
                if (type.FullName.Contains("ContentByQueryWebPart")
                {
                    //then it is ContentByQueryWebPart
                }
            }
History
Using SPLimitedWebPartManager To Find Web Parts By Title

You can use LINQ and SPLimitedWebPartManager in order to find a WebPart object by title in the following fashion:

protected static WebPart FindWebPartByTitle(SPLimitedWebPartManager webPartManager, string title)
{
return webPartManager.WebParts.Cast<WebPart>().FirstOrDefault(webPart => Equals(webPart.Title, title));
}

Adam Buenz
SharePoint Foundation MVP - http://www.sharepointsecurity.com

History