NavBarItemSelectingEventArgs.Cancel Property

Gets or sets a value indicating whether the operation which raised an event should be canceled.

Namespace: DevExpress.Xpf.NavBar

Assembly: DevExpress.Xpf.NavBar.v20.2.dll

Declaration

public bool Cancel { get; set; }
Public Property Cancel As Boolean

Property Value

Type Description
Boolean

true if the operation raising the event should be canceled; otherwise, false.

Remarks

The NavBarItemSelectingEventArgs object is passed to events that fire before specific initiated actions are completed. The Cancel property of this object enables you to cancel the action which is about to be performed.

For example, this property is useful when you handle the NavBarViewBase.ItemSelecting event. Set this property to true to cancel selection of the processed item. This can be used if you want to prohibit item selection with respect to specific conditions.

Examples

In this example, the NavBarViewBase.ItemSelecting event is handled, to invoke a confirmation dialog allowing the selection of a specific item ('Private') to be canceled.

View Example

private void navBar_ItemSelecting(object sender, NavBarItemSelectingEventArgs e){
    if (e.NewItem.Content.ToString() == "Private"){
        MessageBoxResult result = MessageBox.Show("Are you sure to select the 'Private' item?", "Confirm Dialog", MessageBoxButton.YesNo);
        e.Cancel = (result == MessageBoxResult.No);
    }
}
See Also