Expand Minimize

SPC019025: Ensure you are calling Field.Update() before ClientContext.ExecuteQuery() when modifying a Field object.

When modifying a Field object, ensure you are calling Field.Update() before ClientContext.ExecuteQuery() in order to persist the changes to the object.

CheckId SPC019025
TypeName EnsureFieldUpdateBeforeExecuteQuery
Severity Warning
Type Assembly

Bad Practice

    using (var context = new ClientContext("http://yoursite"))
    {
        List list = context.Web.Lists.GetByTitle("Announcements");

        // Assume we're creating a new field.
        Field field = list.Fields.AddFieldAsXml("<Field DisplayName='MyNewField' Type='Number' />",
                                                    true,
                                                    AddFieldOptions.DefaultValue);
                

        FieldNumber fldNumber = context.CastTo<FieldNumber>(field);
        fldNumber.MaximumValue = 100;
        fldNumber.MinimumValue = 35;
        context.ExecuteQuery();
    }


Good Practice
    using (var context = new ClientContext("http://yoursite"))
    {
        List list = context.Web.Lists.GetByTitle("Announcements");

        // Assume we're creating a new field.
        Field field = list.Fields.AddFieldAsXml("<Field DisplayName='MyNewField' Type='Number' />",
                                                    true,
                                                    AddFieldOptions.DefaultValue);
        FieldNumber fldNumber = context.CastTo<FieldNumber>(field);
        fldNumber.MaximumValue = 100;
        fldNumber.MinimumValue = 35;
                
        // Don't forget to run field.Update() to persist any changes to the field!
        fldNumber.Update();
        context.ExecuteQuery();  
    }

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.ManagedCSOM.CSOMCorrectnessGroup", "SPC019025:EnsureFieldUpdateBeforeExecuteQuery", 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.