ControlBar

Inheritance Hierarchy

          IComponent

          IControlBar

          ControlBar

Description

The ControlBar component is not visual, and is used to create popup panels on a form.

Working with the Component

As the panel the form is displayed, which is specified in the  MetabaseObject  property of the ControlBar component.

The popup panel can have one of the three states. Docked: the panel is always displayed on the form, the panel menu is displayed, all the main form components are moved. Undocked: the panel is displayed in a separate window. Manipulations with floating panel are performed in the same way, as with the similar floating windows in different tools of the platform. Hidden: the form includes a tab on hovering over which the panel expands on top of all form components. The panel remains expanded in the following cases; while one of the panel's components is focused. Panel components are not focused, but mouse cursor is in over the panel. The direction of expanding the panel depends on its position.

If in the form, used as the pop-up panel the basic  Icon property is changed, on display the panel in the hidden state this icon is displayed on the tab near the panel name.

Example

The form design mode:

After starting the form:

Properties of the ControlBar Component

  Property name Brief description
AllowDocking The AllowDocking property determines, whether the popup panel can be docked.
AllowFloat The AllowFloat property determines, whether the popup panel can float.
AutoHide The AutoHide property determines, whether the popup panel can be hidden.
ComponentCount The ComponentCount property returns the number of child components.
Components The Components property returns the child component.
Data The Data property is used to store any custom data.
DockEdge The DockEdge property returns the settings which set the edges of the parent window, to which the popup panel can be docked at the form runtime.
DockPosition The DockPosition property determines the edge of the parent window, to which the popup panel should be docked
Floating The Floating property returns True, if the panel is floating.
Form The Form property returns the parent form for this popup panel.
Height The Height property determines vertical size of the popup panel in pixels.
Hidden The Hidden property determines the state of the panel.
Id The Id property determines the unique identifier of the popup panel.
Left The Left property sets coordinate of the left border of the popup panel.
MetabaseObject The MetabaseObject property determines the identifier of the form, which should be displayed in the popup panel.
Name The Name property determines the component name.
Tag The Tag property is not used by the compiler. A user can change the value of the Tag property and use it as he wishes.
Text The Text property sets the title text for the pop-up panel, or the text displayed on the tab if the panel is hidden.
Top The Top property sets coordinate of the top border of the popup panel.
Visible The Visible property determines whether a component is displayed when a form is executed.
Width The Width property determines horizontal size of the popup panel in pixels.

Methods of the ControlBar Component

  Method name Brief description
DockIn The DockIn method groups the popup panel.
DockOf The DockOf method docks the panel to the panel in the input parameter.
Float The Float method changes the panel state to floating.
IsDocked The IsDocked method checks, whether this popup panel is included in the same group, as the panel in the input parameter.
PutParentForm The PutParentForm method sets the parent form for the popup panel.

See also:

Additional Components