ASPxGridDataSecuritySettings.AllowReadUnlistedFieldsFromClientApi Property
Specifies whether to disable client-side access to data source fields which are not associated with any grid columns.
Namespace: DevExpress.Web
Assembly: DevExpress.Web.v20.2.dll
NuGet Package: DevExpress.Web
Declaration
[DefaultValue(DefaultBoolean.Default)]
public virtual DefaultBoolean AllowReadUnlistedFieldsFromClientApi { get; set; }Property Value
| Type | Default | Description |
|---|---|---|
| DefaultBoolean | **Default** | One of the DefaultBoolean enumeration values. |
Available values:
| Name | Description |
|---|---|
| True | Corresponds to a Boolean value of true. |
| False | Corresponds to a Boolean value of false. |
| Default | The value is determined by the current object’s parent object setting (e.g., a control setting). |
Property Paths
You can access this nested property as listed below:
| Library | Object Type | Path to AllowReadUnlistedFieldsFromClientApi |
|---|---|---|
| ASP.NET Controls and MVC Extensions | ASPxCardView |
|
| ASPxGridView |
|
|
| ASPxVerticalGrid |
|
|
| GridViewProperties |
|
|
| ASP.NET Bootstrap Controls | BootstrapCardView |
|
| BootstrapGridView |
|
|
| ASP.NET MVC Extensions | CardViewSettings |
|
| CardViewSettings<CardType> |
|
|
| GridViewSettings |
|
|
| GridViewSettings<RowType> |
|
|
| MVCxCardView |
|
|
| MVCxGridView |
|
|
| MVCxGridViewProperties |
|
|
| MVCxVerticalGrid |
|
|
| VerticalGridSettings |
|
|
| VerticalGridSettings<ColumnType> |
|
Remarks
Use the AllowReadUnlistedFieldsFromClientApi property to restrict access from a client API to data source fields which do not have the corresponding bound columns in the ASPxGridView, ASPxCardView, and ASPxVerticalGrid controls.
ASPxGridView1.SettingsDataSecurity.AllowReadUnlistedFieldsFromClientApi = DefaultBoolean.True;
ASPxCardView1.SettingsDataSecurity.AllowReadUnlistedFieldsFromClientApi = DefaultBoolean.True;
ASPxVerticalGrid1.SettingsDataSecurity.AllowReadUnlistedFieldsFromClientApi = DefaultBoolean.True;
If the AllowReadUnlistedFieldsFromClientApi property is set to Default, the client-side access to the data source’s unlisted fields depends upon the BackwardCompatibilitySettings.DataControlAllowReadUnlistedFieldsFromClientApiDefaultValue property setting.
Note
In version 18.1, we’ve changed this API behavior to improve data security of grid-like DevExpress web controls.
Breaking Change: The Specificity of accessing data field values from a client API of grid-like web controls topic illustrates details and describes how to revert to the previous behavior (degrading data security).
The AllowReadUnlistedFieldsFromClientApi property has priority over the BackwardCompatibilitySettings.DataControlAllowReadUnlistedFieldsFromClientApiDefaultValue property.