public DockPanel()

Initializes a new instance of the DockPanel class.

public HTMLElement StylingContainer

Gets the element sizing helpers write to.

public bool PropagateStylesToWrapper

Gets whether a sizing helper applied to this component should tag it so a wrapper-building container hoists the style onto the wrapper.

public IReadOnlyList<DockPane> CurrentPanes

The panes, in layout order.

public bool IsNarrow

Whether the panel is below CollapseBelow and shows its pinned panes on the rails.

public DockPanel Document(IComponent document)

Sets the document: the content in the middle that the panes are docked around.

public DockPanel Panes(params DockPane[] panes)

Adds panes.

public DockPanel Add(DockPane pane)

Adds a pane. A pane whose id is already taken replaces the old one in place.

public DockPanel Remove(string id)

Removes the pane with the given id.

public DockPane Pane(string id)

Returns the pane with the given id, or null.

public DockPanel EdgePriority(params DockEdge[] edges)

Decides which edges own the corners. The first edge is laid out outermost and spans the whole panel; each later one fits inside the earlier ones. Defaults to Top, Bottom, Left, Right: the top and bottom panes span the full width.

public DockPanel CollapseBelow(double pixels)

Below this width (in pixels) the panel shows every pinned pane on its rail instead of beside the document, without changing the pane; above it they dock again. Defaults to 600; 0 turns it off.

public DockPanel RestoreMenu(bool show = true)

Shows or hides the menu of closed panes at the top right of the document. Shown by default.

public DockPanel Labels(DockPanelLabels labels)

Replaces the text the panel draws on its own, for translation.

public DockPanel OnLayoutChanged(Action<string> onLayoutChanged)

Raised after every change of the arrangement — a pane moved, resized, closed, reopened, pinned or unpinned, a tab selected — with the layout as GetLayout writes it, ready to be saved.

public DockPanel OnCloseRequested(Func<DockPane, bool> onCloseRequested)

Raised when the user asks to close a pane. Return false to keep it open.

public DockPanel OnFlyoutOpened(Action<DockPane> onFlyoutOpened)

Raised when an unpinned pane slides out from its rail.

public DockPanel Open(string id)

Opens a closed pane where it was, and selects it if it is a tab.

public DockPanel Close(string id)

Closes a pane. The restore menu lists it until it is opened again.

public DockPanel Pin(string id)

Docks an unpinned pane beside the document again.

public DockPanel Unpin(string id)

Unpins a pane to its edge's rail; it slides out over the document when its tab is clicked.

public DockPanel Activate(string id)

Selects a pane's tab in its group.

public DockPanel Show(string id)

Brings a pane into view, whatever its state: opens it if it is closed, selects its tab, and slides it out if it is on a rail (unpinned, or every pane is because the panel is narrow).

public DockPanel Toggle(string id)

Hides a pane that is in view and shows one that is not: a docked pane is closed (and listed in the restore menu), a pane slid out from its rail slides back. What a PaneToggle button does.

public bool IsShown(string id)

Whether a pane can be seen right now: open, its tab selected if it shares a slot, and slid out if it lives on a rail.

public Button PaneToggle(string id)

A button that shows and hides one pane (Toggle), for a toolbar outside the panel, the way an IDE's View menu reaches its tool windows. It carries the pane's icon and title, is marked pressed (aria-pressed and the tss-dockpanel-toggle-on class) while the pane is in view, and follows every change made in the panel. A panel whose panes start closed can hide its own restore menu (RestoreMenu) and offer these instead.

public DockPanel Move(string id, DockEdge edge)

Moves a pane to another edge, on its own (out of any tab group).

public DockPanel ShowFlyout(string id)

Slides an unpinned (or collapsed) pane out over the document.

public string GetLayout()

Writes the arrangement — every pane's edge, size, share, tab group, pin and open state, and order — as JSON.

public bool LoadLayout(string layout)

Restores an arrangement written by GetLayout. Panes it does not mention keep their place after the ones it does, ids it mentions that are not panes are ignored, an edge the pane does not allow is ignored and sizes are clamped to the pane's limits. Returns false, changing nothing, if the text cannot be read.

public override HTMLElement Render()

Renders the component's root HTML element.

Left

Docked to the left of the document; its size is a width.

Right

Docked to the right of the document; its size is a width.

Top

Docked above the document; its size is a height.

Bottom

Docked below the document; its size is a height.

public DockPane(string id, string title, IComponent content)

Initializes a new instance of the DockPane class.

Parameters

id

A stable identity, used by the layout GetLayout saves. Do not derive it from position.

title

The header, tab and rail text.

content

The pane's body.

public string Id { get; }

The pane's stable identity.

public string Title { get; private set; }

The header, tab and rail text.

public UIcons? PaneIcon { get; private set; }

An icon drawn before the title, or null.

public IComponent Content { get; private set; }

The pane's body.

public DockEdge Edge { get; internal set; }

The edge the pane is docked to. Defaults to Left.

public string TabGroup { get; internal set; }

Panes on the same edge with the same group name share one slot as tabs. Null for a pane of its own.

public double Size { get; internal set; }

The pane's width on the left and right edges, its height on the top and bottom ones, in pixels. The edge takes the size of the first pane on it; dragging the edge's splitter writes the new size to all of them.

public double MinSize { get; private set; }

The smallest the user can drag the pane to.

public double MaxSize { get; private set; }

The largest the user can drag the pane to.

public double Weight { get; internal set; }

The pane's share of its edge when several panes are stacked there. Defaults to 1.

public bool IsOpen { get; internal set; }

Whether the pane is shown at all.

public bool IsPinned { get; internal set; }

Whether the pane takes space beside the document; an unpinned pane sits on its edge's rail and slides out over the document.

public bool CanClose { get; private set; }

Whether the header offers a close button.

public bool CanPin { get; private set; }

Whether the header offers the auto-hide pin.

public bool CanMove { get; private set; }

Whether the pane can be dragged by its header to another edge or into a tab group.

public IReadOnlyList<DockEdge> AllowedEdges { get; private set; }

The edges the user may drag the pane to.

public DockPane Left()

Docks the pane to the left of the document.

public DockPane Right()

Docks the pane to the right of the document.

public DockPane Top()

Docks the pane above the document.

public DockPane Bottom()

Docks the pane below the document.

public DockPane DockTo(DockEdge edge)

Docks the pane to edge.

public DockPane InTabGroup(string group)

Makes the pane a tab of group: panes on the same edge with the same name share one slot.

public DockPane SetSize(double pixels)

Sets the pane's size, in pixels (a width on the left and right edges, a height on the others). Defaults to 260.

public DockPane SizeLimits(double min, double max)

Sets how small and how large the user can drag the pane. Defaults to 120 and 720.

public DockPane SetWeight(double weight)

Sets the pane's share of its edge when several panes are stacked there. Defaults to 1.

public DockPane Icon(UIcons icon)

Sets the icon drawn before the title.

public DockPane Unpinned(bool value = true)

Starts the pane unpinned: on its edge's rail, sliding out over the document when its tab is clicked.

public DockPane Closed(bool value = true)

Starts the pane closed. The panel's restore menu, or Open, brings it back.

public DockPane NotClosable()

Removes the close button.

public DockPane NotPinnable()

Removes the auto-hide pin.

public DockPane NotMovable()

Stops the pane from being dragged to another place.

public DockPane AllowEdges(params DockEdge[] edges)

Limits the edges the user may drag the pane to. A pane always may stay where it is.

public DockPane SetTitle(string title)

Replaces the pane's title.

public DockPane SetContent(IComponent content)

Replaces the pane's body.

public string AutoHide { get; set; }

The name of the pin on a docked pane, which slides it to the rail.

public string Pin { get; set; }

The name of the pin on a pane slid out from the rail, which docks it again.

public string Close { get; set; }

The name of a pane's close button.

public string ClosedPanes { get; set; }

The name of the button that lists the closed panes.

public string Reopen { get; set; }

The header of the restore menu.