The requested page is not available for the requested platform. You are viewing the content for Default platform.

DashboardConfigurator.SetDashboardStateService(IDashboardStateService) Method

Specifies a service allowing you to manage a dashboard state.

Namespace: DevExpress.DashboardWeb

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

Declaration

public void SetDashboardStateService(
    IDashboardStateService service
)
Public Sub SetDashboardStateService(
    service As IDashboardStateService
)

Parameters

Name Type Description
service IDashboardStateService

An object implementing the IDashboardStateService interface that specifies a service allowing you to manage a dashboard state.

Remarks

Important

To learn how to use the DashboardConfigurator's API, see the Server-Side API Overview topic.

To learn more about a dashboard state, see Manage Dashboard State.

Examples

The sample illustrates how to specify a dashboard state (such as master filter or parameter values) in code and how to apply this state when loading a dashboard for the first time. In this example, the DashboardState object holds the required dashboard state. The DashboardConfigurator.SetDashboardStateService method is used to apply the specified dashboard state when loading a dashboard.

Imports System.Web.Mvc

Namespace MvcDashboard_DefaultDashboardState.Controllers
    Public Class HomeController
        Inherits Controller

        Public Function Index() As ActionResult
            Return View()
        End Function
    End Class
End Namespace
See Also