Name

Description

dockingManager.DockingZones collection

Collection of the available docking zones.

dockingManager.DockableObjects collection

Collection of the available dockable objects.

Name

Description

zone.IsDockingZone property

Returns true if the current object is docking zone.

zone.Type property

Gets the type of the docking zone. For the list of the available types see the RadDockingZoneTypeFlags object.

zone.ExpandAllObjects()

Expands all dockable objects objects inside the zone.

zone.CollapseAllObjects()

Collapses all dockable objects objects inside the zone.

zone.GetPosition(dockableObject)

Gets the current position of a given dockable object at the zone.

zone.SetAtPosition(dockableObject, position)

Sets the position of specified dockable object, that is docked inside the zone.

GetDockedObjects() function

Gets an array with the dockable objects currently docked inside this zone.

Name

Description

RadDockingZoneTypeFlags.Vertical property

Vertical zone

RadDockingZoneTypeFlags.Horizontal property

Horizontal zone

RadDockingZoneTypeFlags.Top property

Top (horizontal) zone

RadDockingZoneTypeFlags.Bottom property

Bottom (horizontal) zone

RadDockingZoneTypeFlags.Left property

Left (vertical) zone

RadDockingZoneTypeFlags.Right property

Right (vertical) zone

RadDockingZoneTypeFlags.All property

RadDockableObject only. Combination of all types above

RadDockingZoneTypeFlags.Custom property

RadDockableObject only. Docking zones are specified by their id.

Name

Description

dockableObject.IsDockableObject property

Returns true if the object is dockable object.

dockableObject.ParentDockingZone property

Returns the reference to the parent docking zone if object is docked; otherwise – null.

dockableObject.IsDocked() function

Returns true if object is docked; otherwise false.

dockableObject.IsGripVisible(oGrip) function

Returns true if the given oGrip is visible.

Parametes:

oGrip – grip object to check.

dockableObject.SetGripVisible(oGrip, bVisible) function

Shows/hides the given grip.

Parameters:

 oGrip – grip object to show/hide.

bVisible – flag that indicates whether to show (true) or hide (false) the grip.

dockableObject.TitleBar property

Returns a reference to the TitleBar object.

dockableObject.TopGrip property

Returns a reference to the Top grip object.

dockableObject.BottomGrip property

Returns a reference to the Bottom grip object.

dockableObject.LeftGrip property

Returns a reference to the Left grip object.

dockableObject.RightGrip property

Returns a reference to the Right grip object.

dockableObject.AddEventHandler(sEventName, funcEventHandler) function

Subscribes a given function to be executed when the specified event occurs.

Parameters:

sEventName – name of the event to subscribe for;

funcEventHandler – reference to the function that will be executed when the event occurs.

dockableObject.RemoveEventHandler(sEventName, funcEventHandler) function

Unsubscribes a given function not to be executed when the specified event occurs.

Parameters:

sEventName – name of the event to unsubscribe for;

funcEventHandler – reference to the function that will be removed from the list of the event handler.

dockableObject.MoveTo(x, y,useEffects) function

Moves the dockable object to the specified position (x, y).

Parameters:

x – the new left coordinate to move to;

y – the new top coordinate to move to;

useEffects - boolean; if set to true the move action will be performed using animated effect.

dockableObject.SetSize(width, height) function

Set the size of the dockable object.

Parameters:

width – the new width of the object;

height – the new height of the object;

dockableObject.IsVisible() function

Returns true if the object is visible; otherwise – false.

dockableObject.Show() function

Shows a hidden object.

dockableObject.Hide() function

Hides a visible object.

dockableObject.GetCommandByName(sCommandName) function

Gets a command object with the specified name.

dockableObject.DockTo(dockingZone) function

Docks the object to the specified docking zone.

dockableObject.Expand(expanded) function

Expands/collapse the object.
Parameters:

expanded – if false collapses the object; otherwise expand it.

dockableObject.Collapse() function

Collapses the object.

dockableObject.Pin() function

Pins the object.

dockableObject.Unpin() function

Unpins the object.

SaveState() function

Saves the current state of the dockable object.
Use dockableObject.SaveState() after explicit call to dockableObject.MoveTo() or dockableObject.SetSize() so the object to be able to preserve its state on post backs to the server.

Name

Description

Name property

The name of the command.

IsEnabled() function

Returns a value whether the command is enabled.

Enable(bEnabled) function

Sets the enabled state of the command.

OnCommand property

Gets or sets the function to be executed when the command is clicked.