Hide docking area

Command group	Flag affected	Reversible	Execute on client	Platform(s)
Toolbars	NO	NO	NO	All

Syntax

Description

This command closes either the top, bottom, left, or right docking area. The docking area is specified using one of the docking area constants: kDockingAreaTop, kDockingAreaBottom, kDockingAreaLeft, or kDockingAreaRight.

When you close a library, Omnis does not automatically close any docking areas that are open. You must explicitly hide each docking area using Hide docking area. Leaving docking areas open and closing the library containing those docking areas can cause problems in your application.

Example

Show docking area
 
kDockingAreaLeft

# install toolbar on left docking area

Install toolbar
 
tbMyToolbar

 
# when the library closes, hide the docking area

Hide docking area
 
kDockingAreaLeft

 
# alternatively you can use the following notation

Do
 
$root.$prefs.$dockingareas.$assign
(
kDockingAreaNone
)