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.v20.2.AspNetCore.dll

NuGet Package: DevExpress.AspNetCore.Dashboard

Declaration

C#

public DashboardUrlStateOptionBuilder IncludeDashboardStateToUrl(
    bool includeDashboardStateToUrl
)

VB.NET

Public Function IncludeDashboardStateToUrl(
    includeDashboardStateToUrl As Boolean
) As DashboardUrlStateOptionBuilder

Parameters

Name	Type	Description
includeDashboardStateToUrl	Boolean	true, to include the dashboard state in the Web Dashboard’s URL; otherwise, false.

Returns

Type	Description
DashboardUrlStateOptionBuilder	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.