Skip to main content
Bar

BarContainerControl Class

Represents a control that displays Bar objects on-screen.

Namespace: DevExpress.Xpf.Bars

Assembly: DevExpress.Xpf.Core.v14.2.dll

#Declaration

[ToolboxTabName("DX.14.2: Navigation & Layout")]
[DXToolboxBrowsable]
public class BarContainerControl :
    BarItemsControl,
    IMultipleElementRegistratorSupport,
    IBarNameScopeSupport,
    IInputElement

#Returned By

The BarDockInfo.Container property returns an instance of BarContainerControl.

#Remarks

For a bar to be docked to the window, it must be associated with a specific bar container, represented by the BarContainerControl class. When a bar is associated with a bar container, it's displayed within this container. At runtime, an end-user can move bars between bar containers using drag-and-drop.

By default, the BarManager.CreateStandardLayout option is set to true. In this mode, four bar containers are created at the four edges of the BarManager, allowing bars to be docked at these positions. If the BarManager.CreateStandardLayout option is disabled, no bar containers are created implicitly.

Besides the four default bar containers, you can manually create any number of bar containers and freely position them within the window.

You can associate a bar with a bar container using one of the following methods:

  • Setting the Bar.DockInfo.ContainerType (BarDockInfo.ContainerType) property to the type of the required bar container (this property matches the container's BarContainerControl.ContainerType property).

    When bar containers are created implicitly (the BarManager.CreateStandardLayout property is set to true), you can only associate bars with a corresponding bar container via the ContainerType property.

    If you want to create a floating bar, set the Bar.DockInfo.ContainerType property to BarContainerType.Floating. There is no need to manually create floating bar containers.

  • Setting the Bar.DockInfo.Container (BarDockInfo.Container) property to the required bar container.

    This option is in effect when bar containers are created manually.

  • Setting the Bar.DockInfo.ContainerName (BarDockInfo.ContainerName) property to the name of the required bar container.

    This option is in effect when bar containers are created manually.

#Examples

#Inheritance

See Also