Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

updateFieldValue(propName, value, options)

Updated on July 20, 2021

Dispatches the SET_PROPERTY event on a specified control to store a specified value in the Redux Store.

This API also deletes the error messages of the control by calling the clearMessages(config) API in the MessageManager module.


Not applicable.


propNamestringThe name of the control whose value must be stored in the Redux Store.
valueanyThe value of the control to be stored in the Redux Store.
optionsobjectThe JavaScript object containing the properties to enhance the functionality of this API.

The following table contains the properties of the options object:

removePropertyFromChangedListbooleanThe flag that removes the entry of the property from the changedPropertyList.
Note: The default value is false. Set this property to true to remove the entry of the property from the changedPropertyList.
isArrayDeepMergebooleanThe flag that decides if the values within an array or object must be deep merged to the Redux Store.
Note: The default value is true. Set this property to true to deep merge the values to the Redux Store.

Usage example

In this example, the API stores the value passed in the Redux Store as triggered by the control.

getPConnect().getActionsApi().updateFieldValue(propName, value);

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us