MVCxClientDockPanel Members

A client-side counterpart of the DockPanel extension.

Properties

Name Description
name Gets the unique, hierarchically-qualified identifier for the control. Inherited from ASPxClientControlBase.
panelUID Gets or sets the unique identifier of a panel on a page. Inherited from ASPxClientDockPanel.

Methods

Name Description
AdjustControl Modifies the control’s size against the control’s container. Inherited from ASPxClientControl.
AdjustControls static 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.
Cast(obj) static Converts the specified object to the MVCxClientDockPanel type.
Dock(zone) Docks the current panel in a zone at the specified position. Inherited from ASPxClientDockPanel.
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.
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 client ASPxClientPopupControlBase.SetContentUrl method). Inherited from ASPxClientPopupControlBase.
GetContentIFrameWindow Returns an iframe object containing a web page specified via the control’s ASPxPopupControlBase.ContentUrl property (or the client ASPxClientPopupControlBase.SetContentUrl 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 static Returns a collection of client web control objects. Inherited from ASPxClientControl.
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 Returns an HTML element that is the root of the control’s hierarchy. Inherited from ASPxClientControlBase.
GetMaximized Returns a value indicating whether the window is maximized. Inherited from ASPxClientPopupControlBase.
GetOwnerZone Retrieves a zone that owns the current panel. Inherited from ASPxClientDockPanel.
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.
GetVisible Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetVisibleIndex Gets a value specifying the position of the current panel, amongst the visible panels within a zone. Inherited from ASPxClientDockPanel.
GetWidth Returns the control’s width. Inherited from ASPxClientControl.
Hide Closes the control’s window. Inherited from ASPxClientPopupControlBase.
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.
IsDocked Returns a value indicating whether the panel is docked. Inherited from ASPxClientDockPanel.
IsVisible Returns a value that specifies whether the control’s window is displayed. Inherited from ASPxClientPopupControlBase.
MakeFloat Undocks the current panel and place it at the specified position. Inherited from ASPxClientDockPanel.
PerformCallback(data) Sends a callback with a parameter to update the DockPanel by processing the passed information on the server, in an Action specified by the DockPanel‘s PopupControlSettingsBase.CallbackRouteValues (via the DockPanelSettings.CallbackRouteValues) property.
RefreshContentUrl Refreshes the content of the web page displayed within the control’s window. Inherited from ASPxClientPopupControlBase.
SendMessageToAssistiveTechnology(message) Specifies the text that Assistive Technologies (screen readers or braille display, for example) will provide to a user. Inherited from ASPxClientControlBase.
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) 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) Maximizes a popup window. Inherited from ASPxClientPopupControlBase.
SetPinned(value) Sets a value indicating whether the window is pinned. Inherited from ASPxClientPopupControlBase.
SetVisible(visible) Specifies whether a control is displayed. Inherited from ASPxClientControlBase.
SetVisibleIndex(visibleIndex) Sets a value specifying the position of the current panel, amongst the visible panels in a zone. Inherited from ASPxClientDockPanel.
SetWidth(width) Specifies the control’s width in pixels. Inherited from ASPxClientControl.
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.

Events

Name Description
AfterDock Fires on the client side after a panel is docked in a zone. Inherited from ASPxClientDockPanel.
AfterFloat Fires on the client side after a panel is undocked from a zone. Inherited from ASPxClientDockPanel.
AfterResizing Occurs on the client side when window resizing completes. Inherited from ASPxClientPopupControlBase.
BeforeDock Fires on the client side before a panel is docked in a zone and allows you to cancel the action. Inherited from ASPxClientDockPanel.
BeforeFloat Fires on the client side before a panel is made floating (undocked from a zone) and allows you to cancel the action. Inherited from ASPxClientDockPanel.
BeforeResizing Occurs on the client side when window resizing initiates. Inherited from ASPxClientPopupControlBase.
BeginCallback Occurs when a callback for server-side processing is initiated.
CallbackError Fires on the client if any server error occurs during server-side processing of a callback sent by the control. Inherited from ASPxClientPopupControlBase.
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.
EndDragging Occurs after a panel dragging operation is complete. Inherited from ASPxClientDockPanel.
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.
StartDragging Occurs when a panel dragging operation is started. Inherited from ASPxClientDockPanel.
See Also