Docking Interface Reference

Allows access to Docking Framework . More...

List of all members.

Public Member Functions
	DockAsChild ([in] IDispatch *Control,[in] USHORT ControlAlign)
	Docks a control as a child control of the current frame.
	DockAsNeighbour ([in] IDispatch *Control,[in, defaultvalue(AL_CLIENT)] USHORT ControlAlign)
	Docks a control as a neighbour of the current frame.
	UnDock ([in, defaultvalue(TRUE)] VARIANT_BOOL ControlVisible)
	Undocks the frame.
Properties
BSTR RW	UniqueId []
	Gets or sets unique id.
VARIANT_BOOL RW	AllowDockAsChild []
	If "FALSE" then the user cannot dock a control as a child of the current frame.
VARIANT_BOOL RW	AllowDockAsNeighbour []
	If "FALSE" then the user cannot dock a control as a neighbour of the current frame.
VARIANT_BOOL RW	DropTarget []
	If "TRUE" then the user can drag & drop a control to the current frame.
VARIANT_BOOL RW	AlwaysDockTab []
	If "TRUE" then the current frame must be always docked into a TabControl.
VARIANT_BOOL RW	AlwaysDockPage []
	If "TRUE" then the current frame must be always docked into a PageControl.
VARIANT_BOOL RW	DockToolWindow []
	If "TRUE" then the docking Form for the frame will have ToolWindow = "TRUE" after a call of the UnDock method.
VARIANT_BOOL RW	AutoCreated []
	If "TRUE", then the control was created automatically.
LONG RW	PageControlTag []
	Related to AlwaysDockTab and AlwaysDockPage.

---

Detailed Description

Allows access to Docking Framework .

Provides docking framework specific properties for a control.

To obtain this object use the Control's Docking property.

The control must be Frame (CreateFrame).

Since:

1.1.15.

---

Member Function Documentation

DockAsChild	(	[in] IDispatch *	Control,
		[in] USHORT	ControlAlign
	)

Docks a control as a child control of the current frame.

Parameters:

	Control	The control.
	ControlAlign	Align for docking.

This parameter can be a one of the following values:

• AL_LEFT The control moves to the left side of its parent and resizes to fill the height of its parent. The width of the control is not affected.
• AL_RIGHT The control moves to the right side of its parent and resizes to fill the height of its parent. The width of the control is not affected.
• AL_TOP The control moves to the top of its parent and resizes to fill the width of its parent. The height of the control is not affected.
• AL_BOTTOM The control moves to the bottom of its parent and resizes to fill the width of its parent. The height of the control is not affected.
• AL_CLIENT The control resizes to fill the client area of its parent. If another control with Align equals to AL_LEFT, AL_TOP, AL_RIGHT, AL_BOTTOM, exists, the control resizes to fit within the remaining client area.

If the control's AlwaysDockTab = "TRUE" then a TabControl will be created in the current frame as the control's parent.

If the control's AlwaysDockPage = "TRUE" then a PageControl will be created in the current frame as the control's parent.

Since:

1.1.15.

DockAsNeighbour	(	[in] IDispatch *	Control,
		[in, defaultvalue(AL_CLIENT)] USHORT	ControlAlign
	)

Docks a control as a neighbour of the current frame.

Parameters:

	Control	The control.
	ControlAlign	Align for docking.

• If ControlAlign = AL_CLIENT then the control and the frame will be placed into a docking TabControl or a docking PageControl.

If the frame already a child of a docking TabControl or a docking PageControl then new tab will be created for the control.

Otherwise, new docking TabControl or docking PageControl will be created. The control will be placed into one tab. The frame into another tab.

• if ControlAlign != AL_CLIENT (ControlAlign = AL_LEFT, AL_RIGHT, AL_TOP or AL_BOTTOM) then a new docking frame will be created.

The control and the frame will be placed into the new docking frame.

The control will have Align = ControlAlign. The frame will have Align = AL_CLIENT. The docking frame will have AutoSplit = "TRUE". The docking frame will have AllowDockAsChild = "TRUE".

Note:

A control cannot be docked as neighbour if dock target is a Form.

Since:

1.1.15.

UnDock

(

[in, defaultvalue(TRUE)] VARIANT_BOOL

ControlVisible

)

Undocks the frame.

The docking Form will be created as the parent for the frame.

Since:

1.1.15.

---

Property Documentation

VARIANT_BOOL RW AllowDockAsChild

If "FALSE" then the user cannot dock a control as a child of the current frame.

Default value: "FALSE".

Since:

1.1.15.

VARIANT_BOOL RW AllowDockAsNeighbour

If "FALSE" then the user cannot dock a control as a neighbour of the current frame.

Default value: "TRUE" for a Frame.

If the control is a Form, then it's AllowDockAsNeighbour = "FALSE" and cannot be changed.

Since:

1.1.15.

VARIANT_BOOL RW AlwaysDockPage

If "TRUE" then the current frame must be always docked into a PageControl.

The parent PageControl will be created automatically.

Since:

1.1.15.

VARIANT_BOOL RW AlwaysDockTab

If "TRUE" then the current frame must be always docked into a TabControl.

The parent TabControl will be created automatically.

Since:

1.1.15.

VARIANT_BOOL RW AutoCreated

If "TRUE", then the control was created automatically.

For example, it can be an auto created docking TabControl. (see Docking Framework).

Auto created controls can be deleted automatically when the user moves its children outside.

Since:

1.1.15.

VARIANT_BOOL RW DockToolWindow

If "TRUE" then the docking Form for the frame will have ToolWindow = "TRUE" after a call of the UnDock method.

VARIANT_BOOL RW DropTarget

If "TRUE" then the user can drag & drop a control to the current frame.

Since:

1.1.15.

LONG RW PageControlTag

Related to AlwaysDockTab and AlwaysDockPage.

Specifies different kinds of multi-page components of same type. For example, different kinds of the PageControl.

Default: 0.

Since:

1.1.15.

BSTR RW UniqueId

Gets or sets unique id.

The control's value cannot be used for any other control.

Used when SaveLayout or LoadLayout occurs.

Since:

1.1.15.

---