Enum DockDirection

Namespace

BSGameLib.UI.Controls

Assembly

BSGameLib.UI.dll

The edge of the layout that a child is docked to.

public enum DockDirection

Fields

Bottom = 3

Docked to the bottom edge, taking the height it needs.

Fill = 4

Takes the space that is left after the other children are docked.

Left = 0

Docked to the left edge, taking the width it needs.

Overlay = 5

Covers the layout's whole content rect and reserves none of it: every other child is laid out as though this one were not there, and this one gets the full rect wherever it is declared. For a control that floats over the rest - a chip in a corner, a badge - which docking cannot express, because docking to an edge takes a strip off that entire edge.

Where it is declared still decides two things: paint order, since children draw in order, and focus order, which is tree order. Last is usually what an overlay wants.

Right = 2

Docked to the right edge, taking the width it needs.

Top = 1

Docked to the top edge, taking the height it needs.