Back to Devexpress

DashboardExtensionSettings.IncludeDashboardStateToUrl Property

dashboard-devexpress-dot-dashboardweb-dot-mvc-dot-dashboardextensionsettings-57fee116.md

latest2.2 KB
Original Source

DashboardExtensionSettings.IncludeDashboardStateToUrl Property

Gets or sets whether the dashboard state (such as the master filtering state) will be included in the Web Dashboard’s URL.

Namespace : DevExpress.DashboardWeb.Mvc

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

NuGet Package : DevExpress.Web.Mvc5.Dashboard

Declaration

csharp
public bool IncludeDashboardStateToUrl { get; set; }
vb
Public Property IncludeDashboardStateToUrl As Boolean

Property Value

TypeDescription
Boolean

true to include the dashboard state in the Web Dashboard’s URL; otherwise, false.

|

Remarks

The IncludeDashboardStateToUrl property is in effect when the DashboardExtensionSettings.WorkingMode is set to WorkingMode.Viewer or WorkingMode.ViewerOnly. To learn more about a dashboard state, see Manage Dashboard State.

Note

The Web Dashboard automatically removes the dashboard state from the long URL string to avoid cases when this URL is truncated by a web browser.

See Also

IncludeDashboardIdToUrl

DashboardExtensionSettings Class

DashboardExtensionSettings Members

DevExpress.DashboardWeb.Mvc Namespace