Back to Devexpress

DashboardConfigurator.ValidateUnderlyingDataColumns Event

dashboard-devexpress-dot-dashboardweb-dot-dashboardconfigurator-3956b8a6.md

latest3.1 KB
Original Source

DashboardConfigurator.ValidateUnderlyingDataColumns Event

Raises when a user requests underlying data from the client and allows you to validate which columns should be returned.

Namespace : DevExpress.DashboardWeb

Assembly : DevExpress.Dashboard.v25.2.Web.dll

NuGet Package : DevExpress.Web.Dashboard.Common

Declaration

csharp
public event ValidateUnderlyingDataColumnsWebEventHandler ValidateUnderlyingDataColumns
vb
Public Event ValidateUnderlyingDataColumns As ValidateUnderlyingDataColumnsWebEventHandler

Event Data

The ValidateUnderlyingDataColumns event's data class is ValidateUnderlyingDataColumnsWebEventArgs. The following properties provide information specific to this event:

PropertyDescription
ColumnsGets the names of data columns that can be accessed from the client.
DashboardIdGets the dashboard’s unique name.
ItemComponentNameGets the component name of the dashboard item for which the event is raised.
ValidGets or sets whether to provide a user with client-side access to the underlying columns.

Remarks

The ValidateUnderlyingDataColumns event is raised when a user requests underlying data from the client. The event provides access to a list of columns (the Columns property). If you allow the user to get access to these columns, set the Valid event argument to true. Otherwise, the user is prohibited from obtaining underlying columns from the client.

Note

If the DashboardConfigurator.AllowReadUnlistedColumnsFromClientApi is set to true, the ValidateUnderlyingDataColumnsWebEventArgs.Valid property value is always true.

See Also

ValidateUnderlyingDataColumns

DashboardConfigurator Class

DashboardConfigurator Members

DevExpress.DashboardWeb Namespace