DashboardDesigner.SaveDashboardLayout(Stream) Method
Saves a dashboard layout (layout items and layout containers) to a stream.
Namespace: DevExpress.DashboardWin
Assembly: DevExpress.Dashboard.v19.2.Win.dll
Declaration
Parameters
Name | Type | Description |
---|---|---|
stream | Stream | A Stream object that contains the dashboard layout. |
Remarks
Layout Concepts
The dashboard uses layout items and layout containers to arrange dashboard items in a hierarchical structure. This structure is called a dashboard layout.
Element | Description | API (Desktop / Web) |
---|---|---|
Layout item | Contains and displays an individual dashboard item. | DashboardLayoutItem DashboardLayoutItem |
Layout group | A container that is used to arrange layout items (or other layout groups) either horizontally or vertically. At the same time, layout groups are containers that display dashboard item groups. | DashboardLayoutGroup DashboardLayoutGroup |
Layout tab page | A container for layout items and groups. | DashboardLayoutTabPage DashboardLayoutTabPage |
Layout tab container | A container for layout tab pages. | DashboardLayoutTabContainer DashboardLayoutTabContainer |
Refer to Dashboard Layout for additional information about layout concepts.
Note that if SaveDashboardLayout(Stream)
is used to save the layout and you change the name of a dashboard item or the number of items in the DashboardDesigner, the layout is rendered incorrectly when you use LoadDashboardLayout(Stream) to restore it.
The SaveDashboardLayout / DashboardDesigner.LoadDashboardLayout do not save a dashboard state. Use the DashboardDesigner.GetDashboardState and DashboardDesigner.SetDashboardState methods to obtain and apply the dashboard state, respectively. The DashboardDesigner.SetInitialDashboardState event restores the saved dashboard state.