Attribute 'Name' and 'StaticName' should have the same value in Field |
The value of attribute 'Name' and 'StaticName' should be the same in a Field. Otherwise it might lead to confusion when requesting the field via REST, in managed code etc.
CheckId | SPC055101 |
---|---|
TypeName | DefineSameStaticAndInternalNameInField |
Severity | CriticalWarning |
Type | Field |
Define the same value in attribute 'Name' and 'StaticName'.
Bad Practice
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
<Field
Id="{060E50AC-E9C1-4D3C-B1F9-DE0BCAC300F6}"
Name="Amount"
StaticName="AmountField"
... />
</Elements>
Good Practice <Field
Id="{060E50AC-E9C1-4D3C-B1F9-DE0BCAC300F6}"
Name="Amount"
StaticName="AmountField"
... />
</Elements>
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
<Field
Id="{060E50AC-E9C1-4D3C-B1F9-DE0BCAC300F6}"
Name="Amount"
StaticName="Amount"
... />
</Elements>
<Field
Id="{060E50AC-E9C1-4D3C-B1F9-DE0BCAC300F6}"
Name="Amount"
StaticName="Amount"
... />
</Elements>
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":"SPC055101:DefineSameStaticAndInternalNameInField","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.