SetInitialDashboardStateBaseEventArgs.InitialState Property

Gets or sets the dashboard initial state.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v24.1.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public DashboardState InitialState { get; set; }

VB.NET

Public Property InitialState As DashboardState

Property Value

Type	Description
DashboardState	A DashboardState object that describes the dashboard state.

Remarks

You can handle the platform-specific SetInitialDashboardState event and assign the previously saved dashboard state to the e.InitialState property to restore the changes resulting from end-user interaction.

SetInitialDashboardState events:

• DashboardDesigner.SetInitialDashboardState
• DashboardViewer.SetInitialDashboardState
• DashboardControl.SetInitialDashboardState
• ASPxDashboard.SetInitialDashboardState

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the InitialState property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-dashboard-viewer-default-parameter-values/CS/WinViewer_DefaultParameterValues/Form1.cs#L17

    state.Parameters.Add(parameters);
    e.InitialState = state;
}

wpf-dashboard-how-to-set-initial-dashboard-state/CS/WpfDashboard_DashboardState/MainWindow.xaml.cs#L36

    var state = GetDataFromString(dashboardControl.Dashboard.CustomProperties.GetValue(PropertyName));
    e.InitialState = state;
}

winforms-dashboard-save-restore-dashboard-state/CS/WinFormsDashboard_DashboardState/Form1.cs#L52

    var state = GetStateFromCustomProperty();
    e.InitialState = state;
}

winforms-viewer-save-and-apply-dashboard-state/CS/WinFormsViewerSaveAndApplyDashboarState/ViewerForm1.cs#L30

    var state = GetDataFromString(dashboardViewer.Dashboard.CustomProperties.GetValue(PropertyName));
    e.InitialState = state;
}

winforms-designer-save-and-apply-dashboard-state/CS/WinDesignerDashboardState/DesignerForm1.cs#L29

    var state = GetDataFromString(dashboardDesigner.Dashboard.CustomProperties.GetValue(PropertyName));
    e.InitialState = state;
}

VB.NET

winforms-dashboard-viewer-default-parameter-values/VB/WinViewer_DefaultParameterValues/Form1.vb#L20

    state.Parameters.Add(parameters)
    e.InitialState = state
End Sub

wpf-dashboard-how-to-set-initial-dashboard-state/VB/WpfDashboard_DashboardState/MainWindow.xaml.vb#L31

    Dim state = GetDataFromString(dashboardControl.Dashboard.CustomProperties.GetValue(PropertyName))
    e.InitialState = state
End Sub

winforms-dashboard-save-restore-dashboard-state/VB/WinFormsDashboard_DashboardState/Form1.vb#L44

Private Sub DashboardViewer1_SetInitialDashboardState(ByVal sender As Object, ByVal e As SetInitialDashboardStateEventArgs)
    e.InitialState = GetStateFromCustomProperty()
End Sub

winforms-viewer-save-and-apply-dashboard-state/VB/WinFormsViewerSaveAndApplyDashboarState/ViewerForm1.vb#L29

    Dim state = GetDataFromString(dashboardViewer.Dashboard.CustomProperties.GetValue(PropertyName))
    e.InitialState = state
End Sub

winforms-designer-save-and-apply-dashboard-state/VB/WinDesignerDashboardState/DesignerForm1.vb#L28

    Dim state = GetDataFromString(dashboardDesigner.Dashboard.CustomProperties.GetValue(PropertyName))
    e.InitialState = state
End Sub