RepositoryItemBreadCrumbEdit.ResetNavigationHistory() Method

OBSOLETE

Use BreadCrumbEdit.ResetNavigationHistory method instead

Resets the history of end-user navigation within this BreadCrumbEdit control.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v24.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[EditorBrowsable(EditorBrowsableState.Never)]
[Obsolete("Use BreadCrumbEdit.ResetNavigationHistory method instead")]
public void ResetNavigationHistory()

VB.NET

<Obsolete("Use BreadCrumbEdit.ResetNavigationHistory method instead")>
<EditorBrowsable(EditorBrowsableState.Never)>
Public Sub ResetNavigationHistory

Remarks

The ResetNavigationHistory event resets a history. Use the BreadCrumbEdit.GetNavigationHistory method to obtain the navigation history.

Note

The history returned by the BreadCrumbEdit.GetNavigationHistory method and the history accessed through the RepositoryItemBreadCrumbEdit.History property store different navigation records. The first collection stores end-user navigation in Select mode (the RepositoryItemBreadCrumbEdit.BreadCrumbMode property) while the second one contains paths recorded when navigating in Edit mode. Thus, calling the ResetNavigationHistory method will not modify the RepositoryItemBreadCrumbEdit.History collection and no paths will be removed from the editor’s drop-down. To do so, call the History.Clear() method instead.