WebWindow Class

A Window used in ASP.NET Web Forms applications.

Namespace: DevExpress.ExpressApp.Web

Assembly: DevExpress.ExpressApp.Web.v22.1.dll

Declaration

C#

public class WebWindow :
    Window

VB.NET

Public Class WebWindow
    Inherits Window

Related API Members

The following members return WebWindow objects:

• PopupWindowManager.FindRequestedWindow()
• PopupWindowManager.GetWindowById(String)
• WebApplication.LogonWindow
• WebWindow.CurrentRequestWindow

Remarks

The WebWindow is a Window descendant used in ASP.NET Web Forms applications. As such, it is visualized by a Web Forms page. Compared to the base Window class, WebWindow introduces certain useful members. The WebWindow.ControlsCreating event allows you to perform specific actions before the Window’s page controls are created. The WebWindow.PagePreRender event can be used to customize the page’s controls before the page is rendered. The WebWindow.CurrentRequestPage property can be used when implementing a custom View Item to load a custom user control from a specified path. There are also several Register… methods that allow you to register various client scripts for the Window’s page.

XAF applications automatically prolong ASP.NET Web Forms sessions. Each WebWindow adds SessionKeepAliveControl to its page. This control prevents an ASP.NET Web Forms session from expiring by periodically calling the SessionKeepAliveReconnect JavaScript function sending the request to the SessionKeepAliveReconnectHttpHandler HTTP Handler. This handler does not have any associated data and does not process anything. Its only purpose is to prevent sessions from expiring.

The WebWindow has a special descendant used when displaying pop-up Windows - the PopupWindow.

For general information on Windows, refer to the Window class description and Windows and Frames help topic.

Related GitHub Examples

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

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#

XAF_how-to-customize-an-aspnet-template-e4359/CS/CustomizeTemplate.Web/MyDefaultVerticalTemplateContent.ascx.cs#L23

base.OnLoad(e);
Page.ClientScript.RegisterClientScriptResource(typeof(WebWindow), "DevExpress.ExpressApp.Web.Resources.JScripts.XafNavigation.js");
Page.ClientScript.RegisterClientScriptResource(typeof(WebWindow), "DevExpress.ExpressApp.Web.Resources.JScripts.XafFooter.js");

XAF_how-to-create-information-panels-e2690/CS/InfoPanels.Web/MyDefaultVerticalTemplateContent.ascx.cs#L17

base.OnLoad(e);
if (WebWindow.CurrentRequestWindow != null) {
    WebWindow.CurrentRequestWindow.PagePreRender += new EventHandler(CurrentRequestWindow_PagePreRender);

XAF_how-to-implement-dependent-views-in-a-dashboardview-filter-based-on-selection-e4916/CS/Solution3.Module.Web/Controllers/DashboardRefreshController.cs#L15

base.OnViewControlsCreated();
if(WebWindow.CurrentRequestWindow == null) return;
WebWindow.CurrentRequestWindow.PagePreRender -= CurrentRequestWindow_PagePreRender;

xaf-web-forms-use-oauth2-authentication-providers/CS/AuthenticationOwin.Module.Web/Controllers/LogonAuthController.cs#L63

private void RegisterVisibleUserExistingTextScript(bool visible) {
    ((WebWindow)Frame).RegisterClientScript("LogonActionActive",
                string.Format("SetVisibleUserExistingText({0});", ClientSideEventsHelper.ToJSBoolean(visible)), true);

XAF_how-to-add-a-button-to-a-form-using-custom-view-item-t137443/CS/MySolution.Module.Web/ButtonDetailViewItemWeb.cs#L21

void button_Click(object sender, EventArgs e) {
    WebWindow.CurrentRequestWindow.RegisterClientScript("ShowAlert", @"alert('Action from custom view item was executed!');");
}

VB.NET

XAF_how-to-customize-an-aspnet-template-e4359/VB/CustomizeTemplate.Web/MyDefaultVerticalTemplateContent.ascx.vb#L26

MyBase.OnLoad(e)
Page.ClientScript.RegisterClientScriptResource(GetType(WebWindow), "DevExpress.ExpressApp.Web.Resources.JScripts.XafNavigation.js")
Page.ClientScript.RegisterClientScriptResource(GetType(WebWindow), "DevExpress.ExpressApp.Web.Resources.JScripts.XafFooter.js")

XAF_how-to-create-information-panels-e2690/VB/InfoPanels.Web/MyDefaultVerticalTemplateContent.ascx.vb#L19

MyBase.OnLoad(e)
If WebWindow.CurrentRequestWindow IsNot Nothing Then
    AddHandler WebWindow.CurrentRequestWindow.PagePreRender, AddressOf CurrentRequestWindow_PagePreRender

XAF_how-to-implement-dependent-views-in-a-dashboardview-filter-based-on-selection-e4916/VB/Solution3.Module.Web/Controllers/DashboardRefreshController.vb#L17

MyBase.OnViewControlsCreated()
If WebWindow.CurrentRequestWindow Is Nothing Then
    Return

xaf-web-forms-use-oauth2-authentication-providers/VB/AuthenticationOwin.Module.Web/Controllers/LogonAuthController.vb#L65

Private Sub RegisterVisibleUserExistingTextScript(ByVal visible As Boolean)
    CType(Frame, WebWindow).RegisterClientScript("LogonActionActive", String.Format("SetVisibleUserExistingText({0});", ClientSideEventsHelper.ToJSBoolean(visible)), True)
End Sub

XAF_how-to-add-a-button-to-a-form-using-custom-view-item-t137443/VB/MySolution.Module.Web/ButtonDetailViewItemWeb.vb#L28

Private Sub button_Click(ByVal sender As Object, ByVal e As EventArgs)
    WebWindow.CurrentRequestWindow.RegisterClientScript("ShowAlert", "alert('Action from custom view item was executed!');")
End Sub

Inheritance

Object

Frame

Window

WebWindow

PopupWindow