Skip to main content

DxPopupBase Members

Defines the base API for classes that implement popup windows.

Properties

Name Description
ApplyBackgroundShading Specifies whether to shade the background when the Popup appears.
Attributes Specifies a collection of standard HTML attributes applied to the Popup.
BodyContentTemplate Specifies a template for content of the pop-up window’s body.
BodyCssClass Assigns a CSS class to the body.
BodyTemplate Specifies a template for the pop-up window’s body. Replaces the default render fragment (including paddings, scrollbars, etc.)
BodyText Specifies text displayed in the Popup body.
ChildContent Specifies the body’s content.
CloseOnEscape Specifies whether the Popup should be closed when a user presses Escape.
CloseOnOutsideClick Specifies whether the Popup should be closed when a user clicks outside the Popup’s boundaries.
Content Obsolete. This property is now obsolete. Use the BodyContentTemplate property instead.
CssClass Assigns a CSS class to the entire Popup.
EnableAdaptivity Specifies whether the Popup adapts its width on phones and tables.
FooterContentTemplate Specifies a template for content of the pop-up window’s footer.
FooterCssClass Assigns a CSS class to the footer.
FooterTemplate Specifies a template for the window’s footer. Replaces the default render fragment (including paddings, scrollbars, etc.)
FooterText Specifies text displayed in the Popup footer.
HeaderContentTemplate Specifies a template for content of the pop-up window’s header.
HeaderCssClass Assigns a CSS class to the header.
HeaderTemplate Specifies a template for the window’s header. Replaces the default render fragment (including paddings, scrollbars, etc.)
HeaderText Specifies text displayed in the Popup header.
Height Specifies the Popup’s height.
Id Specifies the component’s unique identifier.
IsInitialized Gets whether the Popup component is initialized.
MaxHeight Specifies the Popup’s maximum height when it adapts to fit its content.
MaxWidth Specifies the Popup’s maximum width when it adapts to fit its content.
MinHeight Specifies the Popup’s minimum height when it adapts to fit its content.
MinWidth Specifies the Popup’s minimum width when it adapts to fit its content.
Scrollable Specifies whether the vertical scrollbar appears in the drop-down window if its content exceeds the window’s boundaries.
ShowCloseButton Specifies whether the header displays the Close button.
ShowFooter Specifies whether the Popup displays the footer.
ShowHeader Specifies whether the Popup displays the header.
SizeMode Specifies the size of the component and its content.
Visible Specifies whether the Popup is visible.
Width Specifies the Popup’s width.
ZIndex Specifies the Popup’s z-index.

Methods

Name Description
CloseAsync(CancellationToken) Asynchronously closes the Popup.
DisposeAsync() Asynchronously disposes of the Popup.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
ShowAsync(CancellationToken) Asynchronously shows the Popup.
ToString() Returns a string that represents the current object. Inherited from Object.

Events

Name Description
CloseButtonClick Obsolete. This event is now obsolete. Handle the Closing or Closed event instead.
Closed Fires after the Popup is closed.
Closing Fires before the Popup is closed.
Created Fires after the Popup is created.
Disposed Fires after the Popup is disposed.
Showing Fires before the Popup is displayed.
Shown Fires after the Popup is displayed.
VisibleChanged Fires when the Popup changes its Visible property value.
See Also