SPC046401: Declare property 'Title' and 'Description' in WebPart

A WebPart should contain the attribute title and description to provide meaningfull information to the end user which would add the web part to a page.

TypeName: DeclareTitleAndDescriptionInWebPart
CheckId: SPC046401
Severity: CriticalWarning
Type: WebPartFile
Resolution

The Webpart should have property title and description in the .webpart file. See sample below:

<webParts>
   <webPart xmlns="http://schemas.microsoft.com/WebPart/v3">
      <metaData>
         <type name="TypeName, Version=VersionNumber, Culture=neutral, PublicKeyToken=PublicKeyToken" />  
         <importErrorMessage>Cannot import this Web Part.</importErrorMessage>  
      </metaData>
      <data>
         <properties>
            <property name="Title" type="string">WebPartTitle</property>
            <property name="Description" type="string">WebPartDescription</property>
            ...
         </properties>
      </data>
   </webPart>
</webParts>

Links

comments powered by Disqus

Copyright © 2013 RENCORE AB. All Rights Reserved

Disclaimer: The views and opinions expressed in this documentation and in SPCAF are those of the creators and do not necessarily reflect the opinions and recommendations of Microsoft or any member of Microsoft. All trademarks, service marks, collective marks, copyrights, registered names, and marks used or cited by this documentation are the property of their respective owners.

SharePoint Code Analysis Framework, Version 4.5.2.7855, see www.spcaf.com for more information