TreeListSettingsDataSecurity.AllowReadUnlistedFieldsFromClientApi Property

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

Namespace: DevExpress.Web.ASPxTreeList

Assembly: DevExpress.Web.ASPxTreeList.v23.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	Return Value
True	The value is true.	0
False	The value is false.	1
Default	The value is specified by a global option or a higher-level object.	2

Property Paths

You can access this nested property as listed below:

Object Type	Path to AllowReadUnlistedFieldsFromClientApi
ASPxTreeList	.SettingsDataSecurity .AllowReadUnlistedFieldsFromClientApi

Remarks

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

Set the AllowReadUnlistedFieldsFromClientApi property to true to enable client access to data source fields that do not have the corresponding bound columns in ASPxTreeList.

ASP.NET Web Forms

ASPxTreeList.SettingsDataSecurity.AllowReadUnlistedFieldsFromClientApi = DefaultBoolean.True;

ASP.NET MVC

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

ASP.NET Bootstrap

BootstrapTreeList1.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.