Use SPBuiltInContentTypeId to reference builtin ContentType |
Use SPBuiltInContentTypeId to reference builtin ContentType.
CheckId | SPC050231 |
---|---|
TypeName | UseBuiltInContentTypesInsteadOfStrings |
Severity | Warning |
Type | Assembly |
Replace strings which contain the ID of a SharePoint default ContentType with the SPBuiltInContentTypeId.
Bad Practice
// retrieve Document ContentType by string
SPContentTypeId documentCTypeId = new SPContentTypeId("0x0101");
SPContentType documentContentType = web.AvailableContentTypes[documentCTypeId];
SPContentTypeId documentCTypeId = new SPContentTypeId("0x0101");
SPContentType documentContentType = web.AvailableContentTypes[documentCTypeId];
Good Practice
// retrieve Document ContentType by SPBuiltInContentTypeId class
SPContentType documentContentType = web.AvailableContentTypes[SPBuiltInContentTypeId.Document];
SPContentType documentContentType = web.AvailableContentTypes[SPBuiltInContentTypeId.Document];
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.BestPracticesGroup", "SPC050231:UseBuiltInContentTypesInsteadOfStrings", Justification = "Provide reason for suppression here")]
[SuppressMessage("SPCAF.Rules.BestPracticesGroup", "SPC050231:UseBuiltInContentTypesInsteadOfStrings", 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.