Tab
A newer version of this page is available. Switch to the current version.

ASPxPopupControl Class

A popup control.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v19.1.dll

Declaration

public class ASPxPopupControl :
    ASPxPopupControlBase,
    IControlDesigner

The following members accept/return ASPxPopupControl objects:

Library Related API Members
ASP.NET Controls and MVC Extensions ASPxSchedulerPrepareFormPopupContainerEventArgs.Popup
eXpressApp Framework CustomizePopupControlEventArgs.PopupControl

Remarks

The ASPxPopupControl allows you to create popup windows in your web application. Popup windows appear separately from an application’s main window and disappear after the specified user action.

Create a Popup Control

Design Time

The ASPxPopupControl control is available on the DX.19.1: Navigation & Layout toolbox tab in the Microsoft Visual Studio IDE.

Drag the control onto a form and customize control settings, or paste the control markup in the page’s source code.

<dx:ASPxPopupControl ID="ASPxPopupControl1" runat="server" HeaderText="Header" PopupElementID="ASPxButton1">
    <ContentCollection>
        <dx:PopupControlContentControl runat="server">
            <dx:ASPxTextBox ID="ASPxTextBox1" runat="server" Text="Text box" Width="170px">
            </dx:ASPxTextBox>
        </dx:PopupControlContentControl>
    </ContentCollection>
</dx:ASPxPopupControl> 

<dx:ASPxButton ID="ASPxButton1" runat="server" Text="Show Popup"></dx:ASPxButton>

Run Time

using DevExpress.Web;
...
protected void Page_Load(object sender, EventArgs e)
{
    Button btn = new Button();
    btn.ID = "ASPxButton1";
    btn.Text = "Show Popup";
    Page.Form.Controls.Add(btn);

    ASPxPopupControl pc = new ASPxPopupControl();
    pc.ID = "ASPxPopupControl1";
    Page.Form.Controls.Add(pc);
    pc.PopupElementID = "btn1";
    pc.HeaderText = "Header";
    pc.Controls.Add(CreateControl());
}
Control CreateControl()
{
    TextBox txt = new TextBox();
    txt.ID = "ASPxTextBox1";
    txt.Width = 200;
    txt.Text = "Text box";
    return txt;
}

Client-Side API

The ASPxPopupControl‘s client-side API is implemented with JavaScript language and exposed by the ASPxClientPopupControl object.

Availability

Available by default.

Class name

ASPxClientPopupControl

Access name

ClientInstanceName

Events

ASPxPopupControl.ClientSideEvents

See demo

Features

Windows Collection

The popup control stores its popup windows in the ASPxPopupControl.Windows collection. If this collection is empty, the control displays a single default popup window. In this case, you can define the default window’s appearance and behavior at the popup control level. If the ASPxPopupControl.Windows collection is not empty, use settings at an individual window level to customize each window.

Declaratively:

<dx:ASPxPopupControl runat="server" ID="Popup">
    <Windows>
        <dx:PopupWindow Name="AndrewFuller" ...></dx:PopupWindow>
        <dx:PopupWindow Name="JanetLeverling" ...></dx:PopupWindow>
        ...
    </Windows>
</dx:ASPxPopupControl>

In code:

protected void Popup_Init(object sender, EventArgs e) {
    List<PopupWindow> windowList = new List<PopupWindow>();
    foreach (Customer customer in CustomersList)
        windowList.Add(new PopupWindow() {
            HeaderText = customer.Name,