RepositoryItemPopupBase.QueryPopUp Event

Enables you to specify whether an attempt to open the editor’s popup window will succeed.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v24.2.dll

Declaration

C#

[DXCategory("Events")]
public virtual event CancelEventHandler QueryPopUp

VB.NET

<DXCategory("Events")>
Public Overridable Event QueryPopUp As CancelEventHandler

Event Data

The QueryPopUp event's data class is CancelEventArgs. The following properties provide information specific to this event:

Property	Description
Cancel	Gets or sets a value indicating whether the event should be canceled.

Remarks

The QueryPopUp event is raised each time the editor’s popup window is about to be opened. Handle the event when you want to stop the window from being opened by setting the event’s Cancel parameter to true.

An editor’s popup window cannot be opened if the editor is disabled or read-only (the RepositoryItem.Enabled property value is false or the RepositoryItem.ReadOnly property value is true).

The current QueryPopUp event is equivalent to the editor’s PopupBaseEdit.QueryPopUp event.

Example

The following code lists a PopupBaseEdit.QueryPopUp event handler which enables opening the dropdown window only if the user typed the text in the edit box which matches an item in the RepositoryItemComboBox.Items collection.

If the user typed a value which does not exist in the collection, the popup is not opened.

C#

private void comboBoxEdit1_QueryPopUp(object sender, 
  System.ComponentModel.CancelEventArgs e) {
    ComboBoxEdit combo = sender as ComboBoxEdit;
    e.Cancel = combo.Properties.Items.IndexOf(combo.Text) == -1;
}

VB.NET

Private Sub ComboBoxEdit1_QueryPopUp(ByVal sender As Object, _
  ByVal e As System.ComponentModel.CancelEventArgs) _
  Handles ComboBoxEdit1.QueryPopUp
    Dim combo As ComboBoxEdit = CType(sender, ComboBoxEdit)
    If combo.Properties.Items.IndexOf(combo.Text) = -1 Then
      e.Cancel = True
    End If
End Sub

Related GitHub Examples

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

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-grid-use-layoutview-as-master-view/CS/WindowsApplication3/MasterDetailHelper.cs#L101

item.TextEditStyle = DevExpress.XtraEditors.Controls.TextEditStyles.HideTextEditor;
item.QueryPopUp += OnPopup;
item.CloseUp += OnCloseUp;

winforms-spreadsheet-use-a-spreadsheet-control-as-inplace-editor/CS/WindowsFormsApplication1/Form1.cs#L25

rePopupContainer.PopupControl = popupContainerControl1;
rePopupContainer.QueryPopUp += new CancelEventHandler(rePopupContainer_QueryPopUp);
rePopupContainer.QueryResultValue += new DevExpress.XtraEditors.Controls.QueryResultValueEventHandler(rePopupContainer_QueryResultValue);

VB.NET

winforms-grid-use-layoutview-as-master-view/VB/WindowsApplication3/MasterDetailHelper.vb#L112

item.TextEditStyle = DevExpress.XtraEditors.Controls.TextEditStyles.HideTextEditor
AddHandler item.QueryPopUp, AddressOf OnPopup
AddHandler item.CloseUp, AddressOf OnCloseUp

winforms-spreadsheet-use-a-spreadsheet-control-as-inplace-editor/VB/WindowsFormsApplication1/Form1.vb#L23

rePopupContainer.PopupControl = popupContainerControl1
AddHandler rePopupContainer.QueryPopUp, New CancelEventHandler(AddressOf rePopupContainer_QueryPopUp)
AddHandler rePopupContainer.QueryResultValue, New DevExpress.XtraEditors.Controls.QueryResultValueEventHandler(AddressOf rePopupContainer_QueryResultValue)