PopupCloseMode Enum

Contains values specifying how a dropdown editor’s popup window was closed.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v18.1.dll

Declaration

C#

public enum PopupCloseMode

VB.NET

Public Enum PopupCloseMode

Members

Name	Description
Normal	Specifies that the dropdown window was closed because an end-user selected an option from the editor’s dropdown.
Cancel	Specifies that the dropdown window was closed because an end-user pressed the ESC key or clicked the close button (available for LookUpEdit, CalcEdit and PopupContainerEdit controls).
Immediate	Specifies that the dropdown window was closed because an end-user clicked outside the editor.
ButtonClick	Specifies that the dropdown window was closed because an end-user clicked the editor’s dropdown button.
CloseUpKey	Specifies that the dropdown window was closed because an end-user pressed a shortcut used to close the dropdown (the ALT+DOWN ARROW or RepositoryItemPopupBase.CloseUpKey).

Related API Members

The following properties accept/return PopupCloseMode values:

• ClosedEventArgs.CloseMode
• CloseUpEventArgs.CloseMode
• PopupBaseEdit.PopupCloseMode

Remarks

When a popup editor’s dropdown window is closed, the RepositoryItemPopupBase.Closed event occurs. Its ClosedEventArgs.CloseMode parameter represents a PopupCloseMode value and this determines how the dropdown window was closed.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PopupCloseMode enum.

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#

a-custom-editor-that-allows-editing-an-images-filename-and-behaves-like-imageedit-e2004/CS/CustomImageEdit/CustomImageEdit.cs#L156

{
    ClosePopup(PopupCloseMode.Normal);
}

how-to-show-the-close-and-clear-buttons-in-a-comboboxedit-popup-window-e3087/CS/WindowsApplication3/CustomPopupForm.cs#L75

{
    ClosePopup(PopupCloseMode.Cancel);
}

how-to-set-a-treelist-as-a-custom-drop-down-for-the-tokenedit-t163562/CS/TokenEditTest/CustomTokenEditDropDownControl.cs#L30

    TreeList.FilterNodes();
    if(TreeList.VisibleNodesCount == 0) OwnerEdit.ClosePopup(PopupCloseMode.Cancel);
}

tokenedit-how-to-place-a-custom-control-on-the-dropdown-window-t159053/CS/CustomTokenEditDropDownControl.cs#L30

    TreeList.FilterNodes();
    if(TreeList.VisibleNodesCount == 0) OwnerEdit.ClosePopup(PopupCloseMode.Cancel);
}

how-to-create-a-comboboxedit-control-with-mru-capabilities-e2551/CS/WindowsFormsApplication18/MRUComboBoxEdit.cs#L16

protected override void OnPopupClosed(PopupCloseMode closeMode)
{

VB.NET

a-custom-editor-that-allows-editing-an-images-filename-and-behaves-like-imageedit-e2004/VB/CustomImageEdit/CustomImageEdit.vb#L165

Private Sub okButton_Click(ByVal sender As Object, ByVal e As EventArgs)
    ClosePopup(PopupCloseMode.Normal)
End Sub

how-to-show-the-close-and-clear-buttons-in-a-comboboxedit-popup-window-e3087/VB/WindowsApplication3/CustomPopupForm.vb#L72

Private Sub OnCloseButtonClick(ByVal sender As Object, ByVal e As EventArgs)
    ClosePopup(PopupCloseMode.Cancel)
End Sub

how-to-set-a-treelist-as-a-custom-drop-down-for-the-tokenedit-t163562/VB/TokenEditTest/CustomTokenEditDropDownControl.vb#L33

If TreeList.VisibleNodesCount = 0 Then
    OwnerEdit.ClosePopup(PopupCloseMode.Cancel)
End If

how-to-create-a-comboboxedit-control-with-mru-capabilities-e2551/VB/WindowsFormsApplication18/MRUComboBoxEdit.vb#L14

Protected Overrides Sub OnPopupClosed(ByVal closeMode As PopupCloseMode)
    MyBase.OnPopupClosed(closeMode)

how-to-add-a-custom-filter-item-into-the-date-filter-popup-e5172/VB/MyDateFilterPopup.vb#L128

Protected Overrides Sub OnActivator_CloseUp(ByVal sender As Object, ByVal e As CloseUpEventArgs)
    If Not(e.CloseMode = PopupCloseMode.Immediate AndAlso customCheck.Checked) Then
        ApplyCustomFilter(e)