PopupBaseEdit.CancelPopup() Method

Closes the popup window discarding the changes made.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

public virtual void CancelPopup()

VB.NET

Public Overridable Sub CancelPopup

Remarks

The CancelPopup method closes the popup window and restores the editor’s previous value (i.e. before invoking the window). Note: this method is only useful for editors whose popup windows are not closed immediately after changing edit values. For instance, choosing a date within the date editor’s dropdown calendar immediately closes the dropdown. For an editor that can update its value while the dropdown is open, end-users can press the ESC key to close the dropdown discarding changes made. MemoExEdit and ImageEdit editors also provide the Cancel button within their dropdowns for this.

The following events are raised when attempting to close an editor’s dropdown window:

• RepositoryItemPopupBase.QueryCloseUp. The event allows you to prevent the dropdown window from being closed.
• RepositoryItemPopupBase.CloseUp. The event enables you to specify whether modifications made within the dropdown should be accepted or discarded.

To close the dropdown window accepting changes, use the PopupBaseEdit.ClosePopup method.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CancelPopup() 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#

how-to-display-a-custom-button-collection-in-the-popupcontaineredits-popup-window-e3667/CS/PopupContainerFormCustomButton.cs#L87

{
    OwnerEdit.CancelPopup();
}

how-to-create-a-data-source-wrapper-that-adds-an-empty-item-to-the-lookup-list-e1180/CS/Form1.cs#L33

LookUpEdit editor = (LookUpEdit)sender;
editor.CancelPopup();
editor.EditValue = null;

VB.NET

how-to-display-a-custom-button-collection-in-the-popupcontaineredits-popup-window-e3667/VB/PopupContainerFormCustomButton.vb#L70

Private Sub customButton_CancelClick(ByVal sender As Object, ByVal e As EventArgs)
    OwnerEdit.CancelPopup()
End Sub

how-to-create-a-data-source-wrapper-that-adds-an-empty-item-to-the-lookup-list-e1180/VB/Form1.vb#L35

Dim editor As LookUpEdit = CType(sender, LookUpEdit)
editor.CancelPopup()
editor.EditValue = Nothing