The requested page is not available for the requested platform. You are viewing the content for Default platform.

ASPxClientPopupControl Members

A client-side equivalent of the ASPxPopupControl control.

Properties

Name Description
name

Gets the unique, hierarchically-qualified identifier for the control.

(Inherited from ASPxClientControlBase)

Methods

Name Description
AdjustControl

Modifies the control's size against the control's container.

(Inherited from ASPxClientControl)
AdjustControls

Modifies the controls size within the specified container.

(Inherited from ASPxClientControl)
AdjustSize

Modifies a control's window size in accordance with the content.

(Inherited from ASPxClientPopupControlBase)
BringToFront

Brings the window to the front of the z-order.

(Inherited from ASPxClientPopupControlBase)
BringWindowToFront(window)

Brings the specified popup window to the front of the z-order.

Cast(obj)

Converts the specified object to the ASPxClientPopupControl type.

GetClientVisible

Obsolete. Returns a value specifying whether a control is displayed.

(Inherited from ASPxClientControlBase)
GetCollapsed

Returns a value indicating whether the window is collapsed.

(Inherited from ASPxClientPopupControlBase)
GetContentHTML

Obsolete. Returns the HTML code that is the content of the popup control's default popup window.

GetContentHeight

Gets the height of the default window's (for ASPxPopupControl) or panel's (for ASPxDockPanel) content region.

(Inherited from ASPxClientPopupControlBase)
GetContentHtml

Returns the HTML code that specifies the contents of the control's window.

(Inherited from ASPxClientPopupControlBase)
GetContentIFrame

Returns an iframe object containing a web page specified via the control's ASPxPopupControlBase.ContentUrl property (or the ASPxClientPopupControlBase.SetContentUrl client method).

(Inherited from ASPxClientPopupControlBase)
GetContentIFrameWindow

Returns an iframe object containing a web page specified via the control's ASPxPopupControlBase.ContentUrl property (or the ASPxClientPopupControlBase.SetContentUrl client method).

(Inherited from ASPxClientPopupControlBase)
GetContentUrl

Returns the URL pointing to the web page displayed within the control's window.

(Inherited from ASPxClientPopupControlBase)
GetContentWidth

Gets the width of the default window's (for ASPxPopupControl) or panel's (for ASPxDockPanel) content region.

(Inherited from ASPxClientPopupControlBase)
GetControlCollection

Returns a collection of client web control objects.

(Inherited from ASPxClientControl)
GetCurrentPopupElement

Returns an object that invoked the default window.

GetCurrentPopupElementIndex

Returns an index of the object that invoked the default window within the ASPxPopupControl.PopupElementID list.

GetFooterImageUrl

Returns the URL pointing to the image displayed within the window footer by default.

(Inherited from ASPxClientPopupControlBase)
GetFooterNavigateUrl

Returns the URL where the web browser will navigate when the text or image is clicked within a window's footer.

(Inherited from ASPxClientPopupControlBase)
GetFooterText

Returns the text displayed within a window's footer.

(Inherited from ASPxClientPopupControlBase)
GetHeaderImageUrl

Returns the URL pointing to the image displayed within the window header.

(Inherited from ASPxClientPopupControlBase)
GetHeaderNavigateUrl

Returns the URL where the web browser will navigate when the text or image is clicked within a window's header.

(Inherited from ASPxClientPopupControlBase)
GetHeaderText

Returns the text displayed within a window's header.

(Inherited from ASPxClientPopupControlBase)
GetHeight

Returns the control's height.

(Inherited from ASPxClientControl)
GetMainElement

This method is not in effect for a ASPxClientPopupControl object.

GetMaximized

Returns a value indicating whether the window is maximized.

(Inherited from ASPxClientPopupControlBase)
GetParentControl

Returns a client instance of the control that is the parent for a specified control.

(Inherited from ASPxClientControlBase)
GetPinned

Returns a value indicating whether the window is pinned.

(Inherited from ASPxClientPopupControlBase)
GetPopUpReasonMouseEvent

Returns an object containing the information about a mouse event that invoked a default popup window.

GetPopupControlCollection

Returns a collection of client popup control objects.

GetVisible

Returns a value specifying whether a control is displayed.

(Inherited from ASPxClientControlBase)
GetWidth

Returns the control's width.

(Inherited from ASPxClientControl)
GetWindow(index)

Returns a popup window specified by its index.

GetWindowByName(name)

Returns a popup window specified by its name.

GetWindowCollapsed(window)

Returns a value indicating whether the specified window is collapsed.

GetWindowContentHeight(window)

Gets the height of the specified popup window's content region.

GetWindowContentHtml(window)

Returns the HTML code that represents the contents of the specified popup window.

GetWindowContentIFrame(window)

Returns an iframe object containing a web page specified via the specified popup window's PopupWindow.ContentUrl property (or the popup control's ASPxClientPopupControl.SetWindowContentUrl client method).

GetWindowContentUrl(window)

Returns the URL pointing to the web page displayed within the control's specific popup window.

GetWindowContentWidth(window)

Gets the width of the specified popup window's content region.

GetWindowCount

Returns the number of popup windows in the popup control.

GetWindowCurrentPopupElement(window)

Returns an object that invoked the specified popup window.

GetWindowCurrentPopupElementIndex(window)

Returns an index of the object that invoked the specified popup window, within the window's PopupWindow.PopupElementID list.

GetWindowHeight(window)

Returns the height of a specific popup window.

GetWindowMaximized(window)

Returns a value indicating whether the specified window is maximized.

GetWindowPinned(window)

Returns a value indicating whether the specified window is pinned.

GetWindowPopUpReasonMouseEvent(window)

Returns an object containing the information about a mouse event that invoked the specified popup window.

GetWindowWidth(window)

Returns the width of a specific popup window.

Hide

Closes the control's window.

(Inherited from ASPxClientPopupControlBase)
HideWindow(window)

Closes the popup control's specified window.

InCallback

Returns a value that determines whether a callback request sent by a web control is being currently processed on the server side.

(Inherited from ASPxClientControlBase)
IsVisible

Returns a value that specifies whether the control's window is displayed.

(Inherited from ASPxClientPopupControlBase)
IsWindowVisible(window)

Returns a value that specifies whether the popup control's specific window is displayed.

PerformCallback(parameter)

Sends a callback to the server and generates the server-side ASPxPopupControlBase.WindowCallback event, passing the specified argument to it.

(Inherited from ASPxClientPopupControlBase)
PerformWindowCallback(window, parameter)

Sends a callback with parameters to update the popup window by processing the related popup window and the passed information on the server.

RefreshContentUrl

Refreshes the content of the web page displayed within the control's window.

(Inherited from ASPxClientPopupControlBase)
RefreshPopupElementConnection

Refreshes the connection between the ASPxPopupControl and the popup element.

RefreshWindowContentUrl(window)

Refreshes the content of the web page displayed within the control's specific popup window.

SendMessageToAssistiveTechnology(message)

Specifies the text that Assistive Technologies (screen readers or braille display, for example) will provide to a user.

(Inherited from ASPxClientControlBase)
SetAdaptiveMaxHeight(maxHeight)

Sets the maximum height of the popup window in adaptive mode.

SetAdaptiveMaxWidth(maxWidth)

Sets the maximum width of the popup window in adaptive mode.

SetAdaptiveMinHeight(minHeight)

Sets the minimum height of the popup window in adaptive mode.

SetAdaptiveMinWidth(minWidth)

Sets the minimum width of the popup window in adaptive mode.

SetClientVisible(visible)

Obsolete. Specifies whether a control is displayed.

(Inherited from ASPxClientControlBase)
SetCollapsed(value)

Sets a value indicating whether the window is collapsed.

(Inherited from ASPxClientPopupControlBase)
SetContentHTML(html)

Obsolete. Defines the HTML content for the popup control's default popup window.

SetContentHtml(html)

Sets the HTML markup specifying the contents of the control's window.

(Inherited from ASPxClientPopupControlBase)
SetContentUrl(url)

Sets the URL to point to the web page that should be loaded into, and displayed within the control's window.

(Inherited from ASPxClientPopupControlBase)
SetFooterImageUrl(value)

Specifies the URL which points to the image displayed within the window footer by default.

(Inherited from ASPxClientPopupControlBase)
SetFooterNavigateUrl(value)

Specifies the URL where the web browser will navigate when the text or image is clicked within a window's footer.

(Inherited from ASPxClientPopupControlBase)
SetFooterText(value)

Specifies the text displayed within a window's footer.

(Inherited from ASPxClientPopupControlBase)
SetHeaderImageUrl(value)

Specifies the URL which points to the image displayed within the window header.

(Inherited from ASPxClientPopupControlBase)
SetHeaderNavigateUrl(value)

Specifies the URL where the web browser will navigate when the text or image is clicked within a window's header.

(Inherited from ASPxClientPopupControlBase)
SetHeaderText(value)

Specifies the popup window's header text.

(Inherited from ASPxClientPopupControlBase)
SetHeight(height)

Specifies the control's height. Note that this method is not in effect for some controls.

(Inherited from ASPxClientControl)
SetMaximized(value)

Sets a value indicating whether the window is maximized.

(Inherited from ASPxClientPopupControlBase)
SetPinned(value)

Sets a value indicating whether the window is pinned.

(Inherited from ASPxClientPopupControlBase)
SetPopupElementID(popupElementId)

Sets the ID of a web control or HTML element (or a list of IDs) with which the current popup control is associated.

SetSize(width, height)

Specifies the default popup window's size.

SetVisible(visible)

Specifies whether a control is displayed.

(Inherited from ASPxClientControlBase)
SetWidth(width)

Specifies the control's width.

(Inherited from ASPxClientControl)
SetWindowAdaptiveMaxHeight(window, maxHeight)

Sets the maximum height of the specified popup window in adaptive mode.

SetWindowAdaptiveMaxWidth(window, maxWidth)

Sets the maximum width of the specified popup window in adaptive mode.

SetWindowAdaptiveMinHeight(window, minHeight)

Sets the minimum height of the specified popup window in adaptive mode.

SetWindowAdaptiveMinWidth(window, minWidth)

Sets the minimum width of the specified popup window in adaptive mode.

SetWindowCollapsed(window, value)

Sets a value indicating whether the specified window is collapsed.

SetWindowContentHtml(window, html)

Defines the HTML content for a specific popup window within the popup control.

SetWindowContentUrl(window, url)

Sets the URL pointing to the web page that should be loaded into and displayed within the control's specific popup window.

SetWindowMaximized(window, value)

Sets a value indicating whether the specified window is maximized.

SetWindowPinned(window, value)

Sets a value indicating whether the specified window is pinned.

SetWindowPopupElementID(window, popupElementId)

Sets the ID of a web control or HTML element (or a list of IDs) with which the current popup control's window is associated.

SetWindowSize(window, width, height)

Specifies the size of a specific popup window.

Show

Invokes the control's window at the popup element with the specified index.

(Inherited from ASPxClientPopupControlBase)
ShowAtElement(htmlElement)

Invokes the control's window and displays it over the specified HTML element.

(Inherited from ASPxClientPopupControlBase)
ShowAtElementByID(id)

Invokes the control's window and displays it over an HTML element specified by its unique identifier.

(Inherited from ASPxClientPopupControlBase)
ShowAtPos(x, y)

Invokes the control's window at the specified position.

(Inherited from ASPxClientPopupControlBase)
ShowWindow(window)

Invokes the specified popup window at the popup element with the specified index.

ShowWindowAtElement(window, htmlElement)

Invokes the popup control's specific window and displays it over the specified HTML element.

ShowWindowAtElementByID(window, id)

Invokes the popup control's specific window and displays it over an HTML element specified by its unique identifier.

ShowWindowAtPos(window, x, y)

Invokes the popup control's specific popup window at the specified position.

StretchVertically

Stretches the popup window in adaptive mode vertically to the full height of the browser window.

UpdatePosition

Updates the default popup window's position, to correctly align it at either the specified element, or the center of the browser's window.

UpdatePositionAtElement(htmlElement)

Updates the default popup window's position, to correctly align it at the specified HTML element.

UpdateWindowPosition(window)

Updates the specified popup window's position, to correctly align it at either the specified element, or the center of the browser's window.

UpdateWindowPositionAtElement(window, htmlElement)

Updates the specified popup window's position, to correctly align it at the specified HTML element.

WindowStretchVertically(window)

Stretches the specified popup window in adaptive mode vertically to the full height of the browser window.

Events

Name Description
AfterResizing

Occurs on the client side when window resizing completes.

(Inherited from ASPxClientPopupControlBase)
BeforeResizing

Occurs on the client side when window resizing initiates.

(Inherited from ASPxClientPopupControlBase)
BeginCallback

Occurs when a callback for server-side processing is initiated.

(Inherited from ASPxClientPopupControlBase)
CallbackError

Fires on the client if any server error occurs during server-side processing of a callback sent by the control.

(Inherited from ASPxClientPopupControlBase)
CloseButtonClick

Occurs when a popup window's close button is clicked.

CloseUp

Occurs on the client side when a control's window closes or hides.

(Inherited from ASPxClientPopupControlBase)
Closing

Enables you to cancel window closing on the client side.

(Inherited from ASPxClientPopupControlBase)
EndCallback

Occurs on the client side after a callback's server-side processing has been completed.

(Inherited from ASPxClientPopupControlBase)
Init

Occurs on the client side after the control has been initialized.

(Inherited from ASPxClientControlBase)
PinnedChanged

Occurs on the client side when the window pin state is changed.

(Inherited from ASPxClientPopupControlBase)
PopUp

Occurs on the client side when a control's window is invoked.

(Inherited from ASPxClientPopupControlBase)
Resize

Occurs on the client side after a window has been resized.

(Inherited from ASPxClientPopupControlBase)
Shown

Occurs on the client side after a control's window has been invoked.

(Inherited from ASPxClientPopupControlBase)
See Also