PopupWindow Class
Represents an individual popup window.
Namespace: DevExpress.Web
Assembly: DevExpress.Web.v24.2.dll
Declaration
Related API Members
The following members return PopupWindow objects:
Remarks
The PopupWindow class contains settings which define an individual popup window within the ASPxPopupControl. A popup window is typically used to display any subsidiary information about an element (or several elements) specified by the PopupWindow.PopupElementID property, depending upon a specific client action set via the ASPxPopupControl.PopupAction.
A popup window may consist of the following:
- A header which can display an image (PopupWindow.HeaderImage), text (PopupWindow.HeaderText) and a specific close button, which when clicked, closes the popup window. End-users can move a popup window within the page by dragging the window’s header, if the ASPxPopupControlBase.AllowDragging property is set to
true. The header’s visibility is controlled by the PopupWindow.ShowHeader property. The ASPxPopupControlBase.DragElement property is used to specify the popup window’s part is available for drag and drop operations. - A footer which can display an image (PopupWindow.FooterImage), text (PopupWindow.FooterText) and size grip (PopupWindow.SizeGripImage). The footer’s visibility is controlled by the PopupWindow.ShowFooter property.
- A content area which can display a content text (PopupWindow.Text) and which allows different visual elements to be added through the ContentControlCollectionItem.Controls property. A popup window’s content can also be represented by an external web page specified via the PopupWindow.ContentUrl property.
All popup windows are stored in a popup control’s ASPxPopupControl.Windows collection. Individual popup windows can be accessed using index notation, by their names, or their content texts.
Note that a common appearance and behavior can be specified for all popup windows by using a popup control’s properties. In order to define custom settings for individual windows, use the window level’s properties. Some specific settings such as a content text (PopupWindow.Text) and an associated elements (PopupWindow.PopupElementID) cannot be defined at the popup control level and should be assigned for each popup window individually.
Note that the PopupWindow class has a client-side equivalent - an object of the ASPxClientPopupWindow type.