Skip to main content

PopupBuilder Methods

A Popup control.
Name Description
AccessKey(JS) Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option.
AccessKey(String) Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option.
Animation(Action<PopupAnimationBuilder>) Mirrors the client-side animation object.
CloseOnOutsideClick(JS) Obsolete. Mirrors the client-side closeOnOutsideClick option.
CloseOnOutsideClick(Boolean) Obsolete. Mirrors the client-side closeOnOutsideClick option.
Container(JS) Specifies the container in which to render the UI component. Mirrors the client-side container option.
Container(String) Specifies the container in which to render the UI component. Mirrors the client-side container option.
Content(RazorBlock) Specifies content for a Popup control.
Content(String) Specifies content for a Popup control.
ContentTemplate(JS) Specifies the client-side contentTemplate.
ContentTemplate(RazorBlock) Specifies the client-side contentTemplate.
ContentTemplate(TemplateName) Specifies the client-side contentTemplate.
ContentTemplate(String) Specifies the client-side contentTemplate.
DeferRendering(JS) Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately. Mirrors the client-side deferRendering option.
DeferRendering(Boolean) Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately. Mirrors the client-side deferRendering option.
Disabled(JS) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
Disabled(Boolean) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
DragAndResizeArea(JS)
DragAndResizeArea(String)
DragEnabled(JS) Specifies whether or not to allow a user to drag the popup window. Mirrors the client-side dragEnabled option.
DragEnabled(Boolean) Specifies whether or not to allow a user to drag the popup window. Mirrors the client-side dragEnabled option.
DragOutsideBoundary(JS)
DragOutsideBoundary(Boolean)
EnableBodyScroll(JS)
EnableBodyScroll(Boolean)
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.
FocusStateEnabled(JS) Mirrors the client-side focusStateEnabled option.
FocusStateEnabled(Boolean) Mirrors the client-side focusStateEnabled option.
FullScreen(JS) Specifies whether to display the Popup in full-screen mode. Mirrors the client-side fullScreen option.
FullScreen(Boolean) Specifies whether to display the Popup in full-screen mode. Mirrors the client-side fullScreen option.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
Height(JS) Mirrors the client-side height option.
Height(Double) Mirrors the client-side height option.
Height(String) Mirrors the client-side height option.
HideOnOutsideClick(JS)
HideOnOutsideClick(Boolean)
HideOnParentScroll(JS)
HideOnParentScroll(Boolean)
Hint(JS) Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option.
Hint(String) Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option.
HoverStateEnabled(JS) Specifies whether the UI component changes its state when a user pauses on it. Mirrors the client-side hoverStateEnabled option.
HoverStateEnabled(Boolean) Specifies whether the UI component changes its state when a user pauses on it. Mirrors the client-side hoverStateEnabled option.
ID(JS) Specifies the id attribute for the control’s HTML element (used for nested controls within templates).
ID(String) Specifies the id attribute for the control’s HTML element.
MaxHeight(JS) Specifies the maximum height the UI component can reach while resizing. Mirrors the client-side maxHeight option.
MaxHeight(Double) Specifies the maximum height the UI component can reach while resizing. Mirrors the client-side maxHeight option.
MaxHeight(String) Specifies the maximum height the UI component can reach while resizing. Mirrors the client-side maxHeight option.
MaxWidth(JS) Specifies the maximum width the UI component can reach while resizing. Mirrors the client-side maxWidth option.
MaxWidth(Double) Specifies the maximum width the UI component can reach while resizing. Mirrors the client-side maxWidth option.
MaxWidth(String) Specifies the maximum width the UI component can reach while resizing. Mirrors the client-side maxWidth option.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MinHeight(JS) Specifies the minimum height the UI component can reach while resizing. Mirrors the client-side minHeight option.
MinHeight(Double) Specifies the minimum height the UI component can reach while resizing. Mirrors the client-side minHeight option.
MinHeight(String) Specifies the minimum height the UI component can reach while resizing. Mirrors the client-side minHeight option.
MinWidth(JS) Specifies the minimum width the UI component can reach while resizing. Mirrors the client-side minWidth option.
MinWidth(Double) Specifies the minimum width the UI component can reach while resizing. Mirrors the client-side minWidth option.
MinWidth(String) Specifies the minimum width the UI component can reach while resizing. Mirrors the client-side minWidth option.
OnContentReady(RazorBlock) A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option.
OnContentReady(String) A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option.
OnDisposing(RazorBlock) Mirrors the client-side onDisposing option.
OnDisposing(String) Mirrors the client-side onDisposing option.
OnHidden(RazorBlock) A function that is executed after the UI component is hidden. Mirrors the client-side onHidden option.
OnHidden(String) A function that is executed after the UI component is hidden. Mirrors the client-side onHidden option.
OnHiding(RazorBlock) A function that is executed before the UI component is hidden. Mirrors the client-side onHiding option.
OnHiding(String) A function that is executed before the UI component is hidden. Mirrors the client-side onHiding option.
OnInitialized(RazorBlock) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnInitialized(String) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnOptionChanged(RazorBlock) Mirrors the client-side onOptionChanged option.
OnOptionChanged(String) Mirrors the client-side onOptionChanged option.
OnResize(RazorBlock) A function that is executed each time the UI component is resized by one pixel. Mirrors the client-side onResize option.
OnResize(String) A function that is executed each time the UI component is resized by one pixel. Mirrors the client-side onResize option.
OnResizeEnd(RazorBlock) A function that is executed when resizing ends. Mirrors the client-side onResizeEnd option.
OnResizeEnd(String) A function that is executed when resizing ends. Mirrors the client-side onResizeEnd option.
OnResizeStart(RazorBlock) A function that is executed when resizing starts. Mirrors the client-side onResizeStart option.
OnResizeStart(String) A function that is executed when resizing starts. Mirrors the client-side onResizeStart option.
OnShowing(RazorBlock) A function that is executed before the UI component is displayed. Mirrors the client-side onShowing option.
OnShowing(String) A function that is executed before the UI component is displayed. Mirrors the client-side onShowing option.
OnShown(RazorBlock) A function that is executed after the UI component is displayed. Mirrors the client-side onShown option.
OnShown(String) A function that is executed after the UI component is displayed. Mirrors the client-side onShown option.
OnTitleRendered(RazorBlock) A function that is executed when the UI component's title is rendered. Mirrors the client-side onTitleRendered option.
OnTitleRendered(String) A function that is executed when the UI component's title is rendered. Mirrors the client-side onTitleRendered option.
Option(String, Object) Specifies an option by its name.
Position(PositionAlignment) Positions the UI component. Mirrors the client-side position option.
Position(Action<PositionConfigBuilder>) Positions the UI component. Mirrors the client-side position object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Render() Inherited from WidgetBuilder.
ResizeEnabled(JS) Specifies whether or not an end user can resize the UI component. Mirrors the client-side resizeEnabled option.
ResizeEnabled(Boolean) Specifies whether or not an end user can resize the UI component. Mirrors the client-side resizeEnabled option.
RestorePosition(JS)
RestorePosition(Boolean)
RtlEnabled(JS) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
RtlEnabled(Boolean) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
Shading(JS) Specifies whether to shade the background when the UI component is active. Mirrors the client-side shading option.
Shading(Boolean) Specifies whether to shade the background when the UI component is active. Mirrors the client-side shading option.
ShadingColor(JS) Specifies the shading color. Applies only if shading is enabled. Mirrors the client-side shadingColor option.
ShadingColor(String) Specifies the shading color. Applies only if shading is enabled. Mirrors the client-side shadingColor option.
ShowCloseButton(JS) Specifies whether or not the UI component displays the Close button. Mirrors the client-side showCloseButton option.
ShowCloseButton(Boolean) Specifies whether or not the UI component displays the Close button. Mirrors the client-side showCloseButton option.
ShowTitle(JS) A Boolean value specifying whether or not to display the title in the popup window. Mirrors the client-side showTitle option.
ShowTitle(Boolean) A Boolean value specifying whether or not to display the title in the popup window. Mirrors the client-side showTitle option.
TabIndex(JS) Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option.
TabIndex(Int32) Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option.
Title(JS) The title in the overlay window. Mirrors the client-side title option.
Title(String) The title in the overlay window. Mirrors the client-side title option.
TitleTemplate(JS) Specifies the client-side titleTemplate.
TitleTemplate(RazorBlock) Specifies the client-side titleTemplate.
TitleTemplate(TemplateName) Specifies the client-side titleTemplate.
TitleTemplate(String) Specifies the client-side titleTemplate.
ToolbarItems(Action<CollectionFactory<PopupToolbarItemBuilder>>) Provides access to the client-side toolbarItems option that represents a toolbar item collection.
ToString() Inherited from WidgetBuilder.
ToTemplate() Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder.
Visible(JS) Mirrors the client-side visible option.
Visible(Boolean) Mirrors the client-side visible option.
Width(JS) Mirrors the client-side width option.
Width(Double) Mirrors the client-side width option.
Width(String) Mirrors the client-side width option.
WrapperAttr(JS) Mirrors the client-side wrapperAttr option, specifies attributes for the control’s root HTML element.
WrapperAttr(Dictionary<String, Object>) Mirrors the client-side wrapperAttr option, specifies attributes for the control’s root HTML element.
WrapperAttr(Object) Mirrors the client-side wrapperAttr option, specifies attributes for the control’s root HTML element.
WrapperAttr(String, Object) Mirrors the client-side wrapperAttr option, specifies attributes for the control’s root HTML element.
See Also