Skip to content
This repository has been archived by the owner on Nov 10, 2019. It is now read-only.

The SplitView Control

Manuel Römer edited this page Aug 24, 2018 · 6 revisions

SplitView

This page describes the SplitView control. The control is designed after the [UWP SplitView]https://docs.microsoft.com/de-de/windows/uwp/design/controls-and-patterns/split-view). As a result, the documentation pages are going to be very similar. Consider reading the official Microsoft documentation for getting an overview for this control.

Properties

Property Type Description
PanePlacement SplitViewPanePlacement Gets or sets the placement position of the pane.
DisplayMode SplitViewDisplayMode Gets or sets the SplitView's display mode, specifying how the pane display is handled.
IsPaneOpen bool Gets or sets a value indicating whether the pane is currently opened.
CompactPaneLength double Gets or sets the length of the pane when it is closed and in a compact display mode.
OpenPaneLength double Gets or sets the length of the pane when it is opened.
Pane object Gets or sets the pane's content.
PaneBackground Brush Gets or sets the pane container's background brush.

Visual States

DisplayModeStates

  • Closed
  • ClosedCompactLeft
  • ClosedCompactRight
  • OpenOverlayLeft
  • OpenOverlayRight
  • OpenInlineLeft
  • OpenInlineRight
  • OpenCompactOverlayLeft
  • OpenCompactOverlayRight
  • OpenCompactInlineLeft
  • OpenCompactInlineRight

Anatomy

The SplitView consists of two areas:

  1. A Pane area, which is usually used for placing items like navigation elements.
  2. A Content area, which is used to display any kind of content. This content typically interacts with the elements in the pane.

IsPaneOpen

The pane can be Open and Closed. If opened, the pane will always have the full width. If closed, the pane will either be narrowed down to a small strip, or hidden completely. The latter behavior depends on the pane's display mode.

Display Modes

The pane has four different display modes:

  1. Inline
  2. Overlay
  3. CompactInline
  4. CompactOverlay

Depending on whether the pane is opened or not, it is displayed like this:

Inline

When the pane is visible, it takes up space. When closed, it disappears completely.

Overlay

The same as Inline, with the difference that the pane doesn't take up any space and thus hovers over the content.

CompactInline

The pane always takes up space. When opened, it is being expanded to its full width. When closed, it is being reduced to a small strip.

CompactOverlay

The same as CompactInline, with the difference that the pane hovers over the content when opened.

PanePlacement

The SplitView also supports placing the pane to the right. This doesn't change anything about the display modes. The only thing that changes is the animations and, obviously, the placement of the pane.