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.
| CheckId | SPC046401 |
|---|---|
| TypeName | DeclareTitleAndDescriptionInWebPart |
| Severity | CriticalWarning |
| Type | WebPart |
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>
<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>
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.