DashboardSavingEventArgs.Handled Property

Gets or sets whether default actions are required to save the dashboard.

Namespace: DevExpress.DashboardWin

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

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public bool Handled { get; set; }

VB.NET

Public Property Handled As Boolean

Property Value

Type	Description
Boolean	true, if no default actions are required to save the dashboard; otherwise, false.

Remarks

After you have provided a custom dashboard saving procedure, set the Handled property to true. Otherwise, the default save actions will be performed.

To access a dashboard that should be saved, use the DashboardSavingEventArgs.Dashboard property.

If your custom save routine has failed, set the DashboardSavingEventArgs.Saved property to false.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Handled 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-custom-save-and-open-procedures/CS/Dashboard_LoadingAndSaving/Form1.cs#L17

    dashboardDesigner1.Dashboard.SaveToXml(filePath);
    e.Handled = true;
}

VB.NET

winforms-dashboard-custom-save-and-open-procedures/VB/Dashboard_LoadingAndSaving/Form1.vb#L18

    dashboardDesigner1.Dashboard.SaveToXml(filePath)
    e.Handled = True
End If