Expand Minimize

Declare element 'DefaultDescription' in schema of ListTemplate

The element 'DefaultDescription' must be declared in the schema.xml of a ListTemplate.

CheckId SPC017510
TypeName DeclareDefaultDescriptionInListDefinition
Severity CriticalWarning
Type List

Add element 'DefaultDescription' to the element 'MetaData' in the schema.xml of the ListTemplate.
MSDN:
A DefaultDescription element specifies the description that is displayed for the list definition in the UI.
This element is overridden by the Description attribute of the List element that corresponds to the current list definition that is specified within a configuration in Onet.xml.
Important: A value for this element must be specified in custom list definitions.
See sample below:

<List xmlns:ows="Microsoft SharePoint" Title="Tasks" >
   <MetaData>
      <ContentTypes>
      ...
      </ContentTypes>
      <Fields>
      ...
      </Fields>
      <Views>
      ...
      </Views>
      <DefaultDescription>$Resources:core,camlidT13;</DefaultDescription>
   </MetaData>
</List>

To suppress this violation in XML SharePoint code add the following comment right before the XML tag which causes the rule violation. Learn more about SuppressMessage here.

<!-- "SuppressMessage":{"rule":"SPC017510:DeclareDefaultDescriptionInListDefinition","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.