Back to Devexpress

DashboardSavingEventArgs.Handled Property

dashboard-devexpress-dot-dashboardwin-dot-dashboardsavingeventargs-ba2e2668.md

latest3.1 KB
Original Source

DashboardSavingEventArgs.Handled Property

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

Namespace : DevExpress.DashboardWin

Assembly : DevExpress.Dashboard.v25.2.Win.dll

NuGet Package : DevExpress.Win.Dashboard

Declaration

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

Property Value

TypeDescription
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.

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.

winforms-dashboard-custom-save-and-open-procedures/CS/Dashboard_LoadingAndSaving/Form1.cs#L17

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

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

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

See Also

Dashboard

Saved

Command

DashboardSavingEventArgs Class

DashboardSavingEventArgs Members

DevExpress.DashboardWin Namespace