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.v24.2.Web.dll
Declaration
Event Data
The ValidateUnderlyingDataColumns event's data class is ValidateUnderlyingDataColumnsWebEventArgs. The following properties provide information specific to this event:
Property | Description |
---|---|
Columns | Gets the names of data columns that can be accessed from the client. |
DashboardId | Gets the dashboard’s unique name. |
ItemComponentName | Gets the component name of the dashboard item for which the event is raised. |
Valid | Gets 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.