| This documentation is part of the BETA release and subject to change. |
Use GetWebParts to get webparts. |
PnP has an implementation to get webparts.
| CheckId | SPC029009 |
|---|---|
| TypeName | UseGetWebParts |
| Severity | Warning |
| Type | Assembly |
Standard SharePoint CSOM
var file = web.GetFileByServerRelativeUrl(serverRelativePageUrl);
var limitedWebPartManager = file.GetLimitedWebPartManager(PersonalizationScope.Shared);
IEnumerable<WebPartDefinition> wps;
if (web.Context.HasMinimalServerLibraryVersion(Constants.MINIMUMZONEIDREQUIREDSERVERVERSION))
{
wps = web.Context.LoadQuery(limitedWebPartManager.WebParts.IncludeWithDefaultProperties(wp => wp.Id, wp => wp.ZoneId, wp => wp.WebPart, wp => wp.WebPart.Title, wp => wp.WebPart.Properties, wp => wp.WebPart.Hidden));
}
else
{
wps = web.Context.LoadQuery(limitedWebPartManager.WebParts.IncludeWithDefaultProperties(wp => wp.Id, wp => wp.WebPart, wp => wp.WebPart.Title, wp => wp.WebPart.Properties, wp => wp.WebPart.Hidden));
}
web.Context.ExecuteQueryRetry();
var limitedWebPartManager = file.GetLimitedWebPartManager(PersonalizationScope.Shared);
IEnumerable<WebPartDefinition> wps;
if (web.Context.HasMinimalServerLibraryVersion(Constants.MINIMUMZONEIDREQUIREDSERVERVERSION))
{
wps = web.Context.LoadQuery(limitedWebPartManager.WebParts.IncludeWithDefaultProperties(wp => wp.Id, wp => wp.ZoneId, wp => wp.WebPart, wp => wp.WebPart.Title, wp => wp.WebPart.Properties, wp => wp.WebPart.Hidden));
}
else
{
wps = web.Context.LoadQuery(limitedWebPartManager.WebParts.IncludeWithDefaultProperties(wp => wp.Id, wp => wp.WebPart, wp => wp.WebPart.Title, wp => wp.WebPart.Properties, wp => wp.WebPart.Hidden));
}
web.Context.ExecuteQueryRetry();
Using PnP
var wps = web.GetWebParts(serverRelativePageUrl);
To suppress this violation in managed code add the following attribute to the method which contains the instruction (available since SPCAF version v5.2). Learn more about SuppressMessage here.
// Important: Ensure to have #define CODE_ANALYSIS at the beginning of your .cs file
[SuppressMessage("Rencore.Analyzers.Assemblies.Rules.PnP.PnPBestPracticesGroup", "SPC029009:UseGetWebParts", Justification = "Provide reason for suppression here")]
[SuppressMessage("Rencore.Analyzers.Assemblies.Rules.PnP.PnPBestPracticesGroup", "SPC029009:UseGetWebParts", Justification = "Provide reason for suppression here")]
Disclaimer: The views and opinions expressed in this documentation and in SPCAF do not necessarily reflect the opinions and recommendations of Microsoft or any member of Microsoft. SPCAF and RENCORE are registered trademarks of Rencore. All other trademarks, service marks, collective marks, copyrights, registered names, and marks used or cited by this documentation are the property of their respective owners.