Skip to main content
A newer version of this page is available. .
Tab

ASPxPopupControlBase.ShowOnPageLoad Property

Gets or sets a value that specifies whether the window is automatically displayed when a client browser loads the page.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v18.2.dll

Declaration

[DefaultValue(false)]
public virtual bool ShowOnPageLoad { get; set; }

Property Value

Type Default Description
Boolean **false**

true, if the window is displayed on the page load; otherwise, false.

Remarks

The ShowOnPageLoad property can’t be changed during a callback.

Note

For ASPxPopupControl only:

If the ASPxPopupControl.Windows collection is not empty, the ShowOnPageLoad property is not in effect, and cannot be used to specify a common page load behavior for all popup windows. In this case, use the PopupWindow.ShowOnPageLoad property of individual popup windows from the collection.

Example

In this example, the client BringToFront method of an ASPxPopupControl is used to display the control's default window above other popup windows displayed on the page.

<%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="PopupControl_BringToFrontSample" %>

<%@ Register Assembly="DevExpress.Web.v13.1" Namespace="DevExpress.Web.ASPxEditors" TagPrefix="dxe" %>
<%@ Register Assembly="DevExpress.Web.v13.1" Namespace="DevExpress.Web.ASPxPopupControl" TagPrefix="dxpc" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title>Untitled Page</title>

    <script type="text/javascript">
        function BringWindow1ToFront() {
            popupControl1.BringToFront();
        }
        function BringWindow2ToFront() {
            popupControl2.BringToFront();
        }
    </script>

</head>
<body>
    <form id="form1" runat="server">
        <div>
            <table>
                <tr>
                    <td width="250px">
                        <dxpc:ASPxPopupControl ID="pc1" ClientInstanceName="popupControl1" runat="server" 
                            HeaderText="Window1" ShowOnPageLoad="True" Top="10" Left="10" CloseAction="CloseButton">
                            <ContentCollection>
                                <dxpc:PopupControlContentControl runat="server" />
                            </ContentCollection>
                        </dxpc:ASPxPopupControl>
                        <dxpc:ASPxPopupControl ID="pc2" ClientInstanceName="popupControl2" runat="server" 
                            HeaderText="Window2" ShowOnPageLoad="True" Top="20" Left="20" CloseAction="CloseButton">
                            <ContentCollection>
                                <dxpc:PopupControlContentControl runat="server" />
                            </ContentCollection>
                        </dxpc:ASPxPopupControl></td>
                    <td valign="top">
                        <dxe:ASPxButton ID="btn1" runat="server" Text="Window1 to front" AutoPostBack="False">
                            <ClientSideEvents Click="BringWindow1ToFront" />
                        </dxe:ASPxButton></td>
                    <td valign="top">
                        <dxe:ASPxButton ID="btn2" runat="server" Text="Window2 to front" AutoPostBack="False">
                            <ClientSideEvents Click="BringWindow2ToFront" />
                        </dxe:ASPxButton></td>
                </tr>
            </table>
        </div>
    </form>
</body>
</html>

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ShowOnPageLoad property.

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.

See Also