ImageComboBoxEdit.GetPopupEditForm() Method

Returns the control’s popup window.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.2.dll

Declaration

C#

public PopupImageComboBoxEditListBoxForm GetPopupEditForm()

VB.NET

Public Function GetPopupEditForm As PopupImageComboBoxEditListBoxForm

Returns

Type	Description
DevExpress.XtraEditors.Popup.PopupImageComboBoxEditListBoxForm	A DevExpress.XtraEditors.Popup.PopupImageComboBoxEditListBoxForm object that represents the control’s popup window. null (Nothing in VB) if the popup window has not been opened yet.

Remarks

At runtime, the control’s popup window can be opened with a click on the control’s dropdown button, or in code using the PopupBaseEdit.ShowPopup method. After the popup window has been opened for the first time, you can use the GetPopupEditForm method to get access to the popup window object. If the popup window has not been opened yet, the GetPopupEditForm returns null (Nothing in VB). Typically, you will be calling the GetPopupEditForm method in the PopupBaseEdit.Popup event handler to get access to the popup window after it has been opened. In the event handler, you can adjust the popup window settings, or handle its events. See the code below.

C#

private void imageComboBoxEdit1_Popup(object sender, EventArgs e) {
    DevExpress.XtraEditors.ImageComboBoxEdit edit = sender as DevExpress.XtraEditors.ImageComboBoxEdit;
    if (edit != null){
        DevExpress.XtraEditors.Popup.PopupImageComboBoxEditListBoxForm popupForm = edit.GetPopupEditForm();
        // ... 
    }
}

VB.NET

Private Sub ImageComboBoxEdit1_Popup(sender As Object, e As EventArgs) Handles ImageComboBoxEdit1.Popup
    Dim edit As DevExpress.XtraEditors.ImageComboBoxEdit = TryCast(sender, DevExpress.XtraEditors.ImageComboBoxEdit)
    If edit IsNot Nothing Then
        Dim popupForm As DevExpress.XtraEditors.Popup.PopupImageComboBoxEditListBoxForm = edit.GetPopupEditForm()
        ' ...
    End If
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetPopupEditForm() 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#

winforms-imagecomboboxedit-disable-specific-items/CS/WindowsApplication33/Form1.cs#L46

ImageComboBoxEdit edit = sender as ImageComboBoxEdit;
if(edit.GetPopupEditForm() != null) {
    int selectedItemIndex = edit.GetPopupEditForm().SelectedItemIndex;

VB.NET

winforms-imagecomboboxedit-disable-specific-items/VB/WindowsApplication33/Form1.vb#L41

Dim edit As ImageComboBoxEdit = TryCast(sender, ImageComboBoxEdit)
If edit.GetPopupEditForm() IsNot Nothing Then
    Dim selectedItemIndex As Integer = edit.GetPopupEditForm().SelectedItemIndex