Avoid use of SPMonitoredScope in Render and OnInit methods |
To get all of the customcode included in the developer dashboard output, wrap it in a monitored scope, but avoid it using in OnInit and Render event handlers.
| CheckId | SPC220201 |
|---|---|
| TypeName | AvoidMonitoredScopeInOnInitAndRender |
| Severity | Warning |
| Type | Assembly |
Use SPMonitoredScope to wrap the code so that the performance measures for the webpart can be tracked in Developer Dashboard in SharePoint 2010/2013. But avoid using SPMonitoredScope in OnInit and Render event handlers.
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("SPCAF.Rules.PerformanceGroup", "SPC220201:AvoidMonitoredScopeInOnInitAndRender", Justification = "Provide reason for suppression here")]
[SuppressMessage("SPCAF.Rules.PerformanceGroup", "SPC220201:AvoidMonitoredScopeInOnInitAndRender", 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.