ASPxGridDataSecuritySettings.AllowReadUnlistedFieldsFromClientApi Property

Specifies whether to allow client access to data source fields that are not associated with any grid columns.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v21.2.dll

NuGet Package: DevExpress.Web

Declaration

C#

[DefaultValue(DefaultBoolean.Default)]
public virtual DefaultBoolean AllowReadUnlistedFieldsFromClientApi { get; set; }

VB.NET

<DefaultValue(DefaultBoolean.Default)>
Public Overridable Property AllowReadUnlistedFieldsFromClientApi As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	Default	True to enable access to the unlisted data source fields; False to prohibit access to the unlisted data source fields; Default depends upon the DataControlAllowReadUnlistedFieldsFromClientApiDefaultValue property value.

Available values:

Name	Description
True	true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
False	false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
Default	The default behavior determined by the control’s logic.

Remarks

The client API of the grid control cannot access values of data source fields that are not listed in the grid column collection.

Set the AllowReadUnlistedFieldsFromClientApi property to true to enable client access to unlisted data source fields.

ASP.NET Web Forms

ASPxGridView1.SettingsDataSecurity.AllowReadUnlistedFieldsFromClientApi = DefaultBoolean.True;
ASPxCardView1.SettingsDataSecurity.AllowReadUnlistedFieldsFromClientApi = DefaultBoolean.True;
ASPxVerticalGrid1.SettingsDataSecurity.AllowReadUnlistedFieldsFromClientApi = DefaultBoolean.True;

ASP.NET MVC

Html.DevExpress.GridView(settings => {  
    ...  
    settings.SettingsDataSecurity.AllowReadUnlistedFieldsFromClientApi = DefaultBoolean.True;
})

Html.DevExpress.CardView(settings => {  
    ...  
    settings.SettingsDataSecurity.AllowReadUnlistedFieldsFromClientApi = DefaultBoolean.True;
})

Html.DevExpress.VerticalGrid(settings => {  
    ...  
    settings.SettingsDataSecurity.AllowReadUnlistedFieldsFromClientApi = DefaultBoolean.True;
})

ASP.NET Bootstrap

BootstrapGridView1.SettingsDataSecurity.AllowReadUnlistedFieldsFromClientApi = DefaultBoolean.True;
BootstrapCardView1.SettingsDataSecurity.AllowReadUnlistedFieldsFromClientApi = DefaultBoolean.True;
BootstrapVerticalGrid1.SettingsDataSecurity.AllowReadUnlistedFieldsFromClientApi = DefaultBoolean.True;

If the AllowReadUnlistedFieldsFromClientApi property is set to Default, client access to the data source’s unlisted fields depends upon the BackwardCompatibilitySettings.DataControlAllowReadUnlistedFieldsFromClientApiDefaultValue property.