ASPxGridDataSecuritySettings.AllowReadUnexposedColumnsFromClientApi Property

Specifies whether to disable client-side access to data source fields that are bound to columns and these columns are hidden in the control.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v21.2.dll

NuGet Package: DevExpress.Web

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
DefaultBoolean	Default	One of the DefaultBoolean enumeration 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

Use the AllowReadUnexposedColumnsFromClientApi property to restrict access to data source fields that are bound to columns and these columns are hidden in the ASPxGridView, ASPxCardView, and ASPxVerticalGrid controls.

C#

ASPxGridView.SettingsDataSecurity.AllowReadUnexposedColumnsFromClientApi = DefaultBoolean.True;
ASPxCardView.SettingsDataSecurity.AllowReadUnexposedColumnsFromClientApi = DefaultBoolean.True;
ASPxVerticalGrid.SettingsDataSecurity.AllowReadUnexposedColumnsFromClientApi = DefaultBoolean.True;

If the AllowReadUnexposedColumnsFromClientApi property is set to Default, the client-side access to the data source’s unexposed fields depends upon the BackwardCompatibilitySettings.DataControlAllowReadUnexposedColumnsFromClientApiDefaultValue 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 AllowReadUnexposedColumnsFromClientApi property has priority over the BackwardCompatibilitySettings.DataControlAllowReadUnexposedColumnsFromClientApiDefaultValue property.