DashboardDesigner.AddToHistory(IHistoryItem) Method

Allows you to write an action to history.

Namespace: DevExpress.DashboardWin

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

NuGet Packages: DevExpress.Win.Dashboard, DevExpress.WindowsDesktop.Win.Dashboard

Declaration

C#

public void AddToHistory(
    IHistoryItem item
)

VB.NET

Public Sub AddToHistory(
    item As IHistoryItem
)

Parameters

Name	Type
item	IHistoryItem

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the AddToHistory(IHistoryItem) method.

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-properties/CS/WinForms-Dashboard-Custom-Properties/Modules/ChartScaleBreakModule.cs#L45

    CustomPropertyHistoryItem historyItem = new CustomPropertyHistoryItem(dashboardItem, PropertyName, newValue.ToString(), $"Scale break for {dashboardItem.ComponentName} is {status}");
    designer.AddToHistory(historyItem);
}

win-dashboard-designer-master-drill-down/CS/WinForms_Dashboard_Drill-Down/MasterDrillDownModule.cs#L80

    var newValue = !GetCustomPropertyValue(designer.SelectedDashboardItem?.ComponentName, MFDPropertyName);
    designer.AddToHistory(new CustomPropertyHistoryItem(designer.SelectedDashboardItem, MFDPropertyName, newValue.ToString(), string.Format("{0} Changed", MFDPropertyName)));
}

VB.NET

winforms-dashboard-custom-properties/VB/WinForms-Dashboard-Custom-Properties/Modules/ChartScaleBreakModule.vb#L45

    Dim historyItem As New CustomPropertyHistoryItem(dashboardItem, PropertyName, newValue.ToString(), $"Scale break for {dashboardItem.ComponentName} is {status}")
    designer.AddToHistory(historyItem)
End Sub

win-dashboard-designer-master-drill-down/VB/WinForms_Dashboard_Drill-Down/MasterDrillDownModule.vb#L85

    Dim newValue = Not GetCustomPropertyValue(designer.SelectedDashboardItem?.ComponentName, MFDPropertyName)
    designer.AddToHistory(New CustomPropertyHistoryItem(designer.SelectedDashboardItem, MFDPropertyName, newValue.ToString(), String.Format("{0} Changed", MFDPropertyName)))
End Sub