DashboardUrlStateOptionBuilder.IncludeDashboardStateToUrl(Boolean) Method
Specifies whether the dashboard state (such as the master filtering state) is included in the Web Dashboard’s URL.
Namespace: DevExpress.DashboardAspNetCore
Assembly: DevExpress.Dashboard.v24.2.AspNetCore.dll
NuGet Package: DevExpress.AspNetCore.Dashboard
#Declaration
public DashboardUrlStateOptionBuilder IncludeDashboardStateToUrl(
bool includeDashboardStateToUrl
)
#Parameters
Name | Type | Description |
---|---|---|
include |
Boolean | true to include the dashboard state in the Web Dashboard’s URL; otherwise, false. |
#Returns
Type | Description |
---|---|
Dashboard |
A reference to this instance after the operation has completed. |
#Remarks
Note that the IncludeDashboardStateToUrl property is in effect when the DashboardBuilder.WorkingMode is set to WorkingMode.Viewer or WorkingMode.ViewerOnly.
Note
The Web Dashboard automatically removes the dashboard state from a long URL string to avoid cases when the URL is truncated by a web browser.