New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

Telerik.Web.UI.RadDock

Class

Definition

Namespace:Telerik.Web.UI

Inheritance: Telerik.Web.UI.RadWebControlTelerik.Web.UI.RadDock

Events

add_command

Adds a command event handler for the raddock

JS

add_command

Parameters:handlerFunction

The event handler function to attach

add_dockPositionChanged

Adds a dockPositionChanged event handler for the raddock

JS

add_dockPositionChanged

Parameters:handlerFunction

The event handler function to attach

add_dockPositionChanging

Adds a dockPositionChanging event handler for the raddock

JS

add_dockPositionChanging

Parameters:handlerFunction

The event handler function to attach

add_drag

Adds a drag event handler for the raddock

JS

add_drag

Parameters:handlerFunction

The event handler function to attach

add_dragEnd

Adds a dragEnd event handler for the raddock

JS

add_dragEnd

Parameters:handlerFunction

The event handler function to attach

add_dragStart

Adds a dragStart event handler for the raddock

JS

add_dragStart

Parameters:handlerFunction

The event handler function to attach

add_enterZone

Adds a enterZone event handler for the raddock

JS

add_enterZone

Parameters:handlerFunction

The event handler function to attach

add_leaveZone

Adds a leaveZone event handler for the raddock

JS

add_leaveZone

Parameters:handlerFunction

The event handler function to attach

add_load

Adds a load event handler for the raddock

JS

add_load

Parameters:handlerFunction

The event handler function to attach

add_resizeEnd

Adds a resizeEnd event handler for the raddock

JS

add_resizeEnd

Parameters:handlerFunction

The event handler function to attach

add_resizeStart

Adds a resizeStart event handler for the raddock

JS

add_resizeStart

Parameters:handlerFunction

The event handler function to attach

remove_command

Removes a command event handler from the raddock

JS

remove_command

Parameters:handlerFunction

The event handler function to remove

remove_dockPositionChanged

Removes a dockPositionChanged event handler from the raddock

JS

remove_dockPositionChanged

Parameters:handlerFunction

The event handler function to remove

remove_dockPositionChanging

Removes a dockPositionChanging event handler from the raddock

JS

remove_dockPositionChanging

Parameters:handlerFunction

The event handler function to remove

remove_drag

Removes a drag event handler from the raddock

JS

remove_drag

Parameters:handlerFunction

The event handler function to remove

remove_dragEnd

Removes a dragEnd event handler from the raddock

JS

remove_dragEnd

Parameters:handlerFunction

The event handler function to remove

remove_dragStart

Removes a dragStart event handler from the raddock

JS

remove_dragStart

Parameters:handlerFunction

The event handler function to remove

remove_enterZone

Removes a enterZone event handler from the raddock

JS

remove_enterZone

Parameters:handlerFunction

The event handler function to remove

remove_leaveZone

Removes a leaveZone event handler from the raddock

JS

remove_leaveZone

Parameters:handlerFunction

The event handler function to remove

remove_load

Removes a load event handler from the raddock

JS

remove_load

Parameters:handlerFunction

The event handler function to remove

remove_resizeEnd

Removes a resizeEnd event handler from the raddock

JS

remove_resizeEnd

Parameters:handlerFunction

The event handler function to remove

remove_resizeStart

Removes a resizeStart event handler from the raddock

JS

remove_resizeStart

Parameters:handlerFunction

The event handler function to remove

Methods

clone

Clones the current Telerik.Web.UI.RadDock object.

JS

clone(String id): Telerik.Web.UI.RadDock

Parameters:idString

The string that will be set to the UniqueId of the cloned object.

Returns:

Telerik.Web.UI.RadDock

The cloned Telerik.Web.UI.RadDock object.

conditionalPostback

Performs a postback if the dock has AutoPostBack enabled.

JS

conditionalPostback(String parameter): void

Parameters:parameterString

The parameter passed to the server when postback is performed.

doPostBack

Calls the _doPostBack global function, passing the UniqueID of the control as event target paramenter.

JS

doPostBack(String parameter): void

Parameters:parameterString

The parameter passed to the server when postback is performed.

get_allowedZones

Gets an array containing the DockZone UniqueNames where the dock is allowed to dock.

JS

get_allowedZones(): Array

Returns:

Array

A string array containing the DockZone UniqueNames where the dock is allowed to dock.

get_autoPostBack

Gets the bool value indicating whether the dock will perform postback.

JS

get_autoPostBack(): Boolean

Returns:

Boolean

The bool value indicating whether the dock will perform postback.

get_closed

Gets the bool value indicating whether the dock is closed or not.

JS

get_closed(): Boolean

Returns:

Boolean

Bool value indicating whether the dock is closed or not.

get_collapsed

Gets the bool value indicating whether the dock is collapsed or not.

JS

get_collapsed(): Boolean

Returns:

Boolean

Bool value indicating whether the dock is collapsed or not.

get_commands

Gets an object containing all present (enabled) dock commands. A single command can be accessed in the following way: "objCommands.CommandName" or "objCommands["CommandName"]".

JS

get_commands(): Array

Returns:

Array

get_commandsContainer

Gets a reference to the element container of the dock's commands.

JS

get_commandsContainer(): Object

Returns:

Object

The element containing dock

get_contentContainer

Gets a reference to the element of the dock's content container.

JS

get_contentContainer(): Object

Returns:

Object

The element of the dock

get_dockMode

Gets the DockMode of the RadDock control. It can be: 1. Floating; 2. Docked; 3. Default;

JS

get_dockMode(): Telerik.Web.UI.DockMode

Returns:

Telerik.Web.UI.DockMode

The Telerik.Web.UI.DockMode of the RadDock control. It can be

get_dockZone

Gets the parent zone(Telerik.Web.UI.RadDockZone object) to which the dock is docked.

JS

get_dockZone(): Telerik.Web.UI.RadDockZone

Returns:

Telerik.Web.UI.RadDockZone

The parent DockZone.

get_dockZoneID

Gets the ID of the zone where the RadDock control is docked to.

JS

get_dockZoneID(): String

Returns:

String

The ID of the zone where the RadDock control is docked to.

get_dockZones

Returns an array which contains all dock zones.

JS

get_dockZones(): Array

Returns:

Array

get_element

Returns the DOM element for this control.

JS

get_element(): Element

Returns:

Element

get_enableAnimation

Gets the bool value indicating whether the animation is enabled.

JS

get_enableAnimation(): Boolean

Returns:

Boolean

The bool value indicating whether the animation is enabled.

get_enableDrag

Gets the bool value indicating whether the user can drag the control to a new location.

JS

get_enableDrag(): Boolean

Returns:

Boolean

The bool value indicating whether the user can drag the control to a new location.

get_forbiddenZones

Gets an array containing the DockZone UniqueNames where the dock cannot be docked to.

JS

get_forbiddenZones(): Array

Returns:

Array

A string array containing the DockZone UniqueNames where the dock cannot docked to.

get_handle

Gets the current handle by which the dock can be dragged.

JS

get_handle(): Object

Returns:

Object

The handle by which the dock can be dragged.

get_height

Gets the height of the control.

JS

get_height(): Number

Returns:

Number

The height of the control.

get_index

Gets the (0-offset) docking position of the control within its parent docking zone.

JS

get_index(): Number

Returns:

Number

The

get_layoutID

Gets the ID of the Telerik.Web.UI.RadDockLayout that manages the state of the RadDock control.

JS

get_layoutID(): String

Returns:

String

The ID of the Telerik.Web.UI.RadDockLayout that manages the state of the RadDock control.

get_left

Gets the X-coordinate of the dock (relative to the top-left corner of the browser window).

JS

get_left(): Number

Returns:

Number

The number indicating the X

get_parent

If the control is docked, returns the object for the parent docking zone.

JS

get_parent(): Object

Returns:

Object

get_pinned

Gets the bool value indicating whether the control is pinned.

JS

get_pinned(): Number

Returns:

Number

The bool value indicating whether the control is pinned.

get_resizable

Gets the bool value indicating whether the control can be resized.

JS

get_resizable(): Boolean

Returns:

Boolean

The bool value indicating whether the control can be resized.

get_skin

Gets the currently applied skin to the control.

JS

get_skin(): String

Returns:

String

The control

get_tag

Tag

JS

get_tag(): Object

Returns:

Object

get_title

Gets the title text of the dock control.

JS

get_title(): String

Returns:

String

The text of the dock

get_titleBar

Gets a reference to the element of the dock's TitleBar template.

JS

get_titleBar(): Object

Returns:

Object

The element of the dock

get_titleElement

Gets the element containing the title text of the dock (the EM element).

JS

get_titleElement(): Object

Returns:

Object

The element that contains the dock

get_top

Gets the Y-coordinate of the dock (relative to the top-left corner of the browser window).

JS

get_top(): Number

Returns:

Number

The number indicating the Y

get_uniqueID

Gets the UniqueID of the control.

JS

get_uniqueID(): String

Returns:

String

The UniqueID of the control.

get_uniqueName

Gets the UniqueName of the control.

JS

get_uniqueName(): String

Returns:

String

The UniqueName of the control.

get_width

Gets the width of the control.

JS

get_width(): Number

Returns:

Number

The width of the control.

getCommand

Gets the command by the name specified.

JS

getCommand(String name): Telerik.Web.UI.DockCommand

Parameters:nameString

The name of the command.

Returns:

Telerik.Web.UI.DockCommand

The command with the given name.

saveClientState

Gets the serialized client state of the dock control.

JS

saveClientState(): void

set_allowedZones

Sets allowed zones (DockZones where the dock is allowed to dock) to the dock. (Use the AllowedZones property in order for the changes to take effect on the server-side and not on the client-side only)

JS

set_allowedZones(Array value): void

Parameters:valueArray

A string array containing the DockZone UniqueNames where the dock is allowed to dock.

set_autoPostBack

Sets a bool value indicating whether the dock will perform postback.

JS

set_autoPostBack(Boolean value): void

Parameters:valueBoolean

Parameter indicating whether the dock will perform postback.

set_closed

Closes/Opens the RadDock control.

JS

set_closed(Boolean value, Boolean playAnimation): void

Parameters:valueBoolean

The value indicating whether the dock will be opened or closed.

playAnimationBoolean

Whether or not animation should be played.

set_collapsed

Collapses/Expands the RadDock control.

JS

set_collapsed(Boolean value, Boolean playAnimation): void

Parameters:valueBoolean

The value indicating whether the dock is collapsed or expanded.

playAnimationBoolean

Whether or not animation should be played.

set_dockMode

Sets a DockMode to the dock.(Use the DockMode property in order for the changes to take effect on the server-side and not on the client-side only)

JS

set_dockMode(Telerik.Web.UI.DockMode value): void

Parameters:valueTelerik.Web.UI.DockMode

Whether the dock will be

set_enableAnimation

Enables or disables the dock animations. (Use the EnableAnimation property in order for the changes to take effect on the server-side and not on the client-side only)

JS

set_enableAnimation(Boolean value): void

Parameters:valueBoolean

The bool value indicating whether the animation will be enabled

set_enableDrag

Sets a value enabling or disabling the ability of the user to drag the control to a new location. (Use the EnableDrag property in order for the changes to take effect on the server-side and not on the client-side only)

JS

set_enableDrag(Boolean value): void

Parameters:valueBoolean

The bool value indicating whether the user can drag the control to a new location.

set_forbiddenZones

Sets forbidden zones (DockZones where the dock cannot be docked to) to the dock. (Use the ForbiddenZones property in order for the changes to take effect on the server-side and not on the client-side only)

JS

set_forbiddenZones(Array value): void

Parameters:valueArray

A string array containing the DockZone UniqueNames where the dock cannot docked to.

set_handle

Sets a drag handle to the element passed as a parameter.

JS

set_handle(Object element): void

Parameters:elementObject

set_height

Sets a height to the control.

JS

set_height(Number value): void

Parameters:valueNumber

The height of the control.

set_left

Sets a X-coordinate to the dock (relative to the top-left corner of the browser window).

JS

set_left(Number value): void

Parameters:valueNumber

The value set to the X

set_pinned

Causes a floating control to become pinned or unpinned. Dock with DockMode="Floating" can be pinned only. (Use the Pinned property in order for the changes to take effect on the server-side and not on the client-side only)

JS

set_pinned(Boolean value): void

Parameters:valueBoolean

The bool value indicating whether the control will be pinned

set_resizable

Enables/Disables the resizing of the control.

JS

set_resizable(Boolean value): void

Parameters:valueBoolean

The value indicating whether the control can be resized or not.

set_title

Sets a title to the control.(Use the Title property in order for the changes to take effect on the server-side and not on the client-side only)

JS

set_title(String value): void

Parameters:valueString

The text that will be assigned to the control

set_top

Sets a Y-coordinate to the dock (relative to the top-left corner of the browser window).

JS

set_top(Number value): void

Parameters:valueNumber

The value set to the Y

set_width

Sets a width to the control.

JS

set_width(Number value): void

Parameters:valueNumber

The width of the control.

undock

Undocks the RadDock control from its containing zone.

JS

undock(): void

Not finding the help you need?

Contact Support