cui.getDockState

cui.getDockState <RolloutFloater_or_Rollout>

This method returns the current dock state of the registered dialog bar.

Parameters

<RolloutFloater_or_Rollout>

This parameter must be a RolloutFloater created with NewRolloutFloater or a Rollout that has been installed in a dialog using CreateDialog, and has been registered using cui.RegisterDialogBar.

Output

The current dock state of the given dialog bar can be one of the following:

#cui_dock_left

#cui_dock_top

#cui_dock_right

#cui_dock_bottom

#cui_floatable

See also

CreateDialog

DestroyDialog

GetDialogPos and SetDialogPos

cui.RegisterDialogBar and cui.UnRegisterDialogBar