Summary

Represents a container with two views; one view for the main content and another view that is typically used for navigation commands.

Namespace

MahApps.Metro.Controls

Base Types

Control

graph BT Type-->Base0["Control"] Type["SplitView"] class Type type-node

Syntax

[TemplatePart(Name = "PaneClipRectangle", Type = typeof(RectangleGeometry))]
[TemplatePart(Name = "LightDismissLayer", Type = typeof(Rectangle))]
[TemplatePart(Name = "PART_ResizingThumb", Type = typeof(MetroThumb))]
[TemplateVisualState(Name = "Closed                 ", GroupName = "DisplayModeStates")]
[TemplateVisualState(Name = "ClosedCompactLeft      ", GroupName = "DisplayModeStates")]
[TemplateVisualState(Name = "ClosedCompactRight     ", GroupName = "DisplayModeStates")]
[TemplateVisualState(Name = "OpenOverlayLeft        ", GroupName = "DisplayModeStates")]
[TemplateVisualState(Name = "OpenOverlayRight       ", GroupName = "DisplayModeStates")]
[TemplateVisualState(Name = "OpenInlineLeft         ", GroupName = "DisplayModeStates")]
[TemplateVisualState(Name = "OpenInlineRight        ", GroupName = "DisplayModeStates")]
[TemplateVisualState(Name = "OpenCompactOverlayLeft ", GroupName = "DisplayModeStates")]
[TemplateVisualState(Name = "OpenCompactOverlayRight", GroupName = "DisplayModeStates")]
[ContentProperty(nameof(Content))]
[StyleTypedProperty(Property = nameof(ResizeThumbStyle), StyleTargetType = typeof(MetroThumb))]
public class SplitView : Control

Attributes

Type	Description
TemplatePart
TemplatePart
TemplatePart
TemplateVisualState
TemplateVisualState
TemplateVisualState
TemplateVisualState
TemplateVisualState
TemplateVisualState
TemplateVisualState
TemplateVisualState
TemplateVisualState
ContentProperty
StyleTypedProperty

Constructors

Name	Summary
SplitView()	Initializes a new instance of the `SplitView` class.

Events

Name	Type	Summary
PaneClosed	EventHandler	Occurs when the `SplitView` pane is closed.
PaneClosing	EventHandler<SplitViewPaneClosingEventArgs>	Occurs when the `SplitView` pane is closing.

Fields

Name	Constant Value	Summary
CanResizeOpenPaneProperty		Identifies the `CanResizeOpenPane` dependency property. static
CompactPaneLengthProperty		Identifies the `CompactPaneLength` dependency property. static
ContentProperty		Identifies the `Content` dependency property. static
DisplayModeProperty		Identifies the `DisplayMode` dependency property. static
IsPaneOpenProperty		Identifies the `IsPaneOpen` dependency property. static
MaximumOpenPaneLengthProperty		Identifies the `MaximumOpenPaneLength` dependency property. static
MinimumOpenPaneLengthProperty		Identifies the `MinimumOpenPaneLength` dependency property. static
OpenPaneLengthProperty		Identifies the `OpenPaneLength` dependency property. static
OverlayBrushProperty		Identifies the `OverlayBrush` dependency property. static
PaneBackgroundProperty		Identifies the `PaneBackground` dependency property. static
PaneForegroundProperty		Identifies the `PaneForeground` dependency property. static
PanePlacementProperty		Identifies the `PanePlacement` dependency property. static
PaneProperty		Identifies the `Pane` dependency property. static
ResizeThumbStyleProperty		Identifies the `ResizeThumbStyle` dependency property. static
TemplateSettingsProperty		Identifies the `TemplateSettings` dependency property. static

Properties

Name	Value	Summary
CanResizeOpenPane	bool	Gets or Sets if the open pane can be resized by the user. The default value is false.
CompactPaneLength	double	Gets or sets the width of the `SplitView` pane in its compact display mode.
Content	UIElement	Gets or sets the contents of the main panel of a `SplitView`.
DisplayMode	SplitViewDisplayMode	Gets of sets a value that specifies how the pane and content areas of a `SplitView` are shown.
IsPaneOpen	bool	Gets or sets a value that specifies whether the `SplitView` pane is expanded to its full width.
LogicalChildren	IEnumerator
MaximumOpenPaneLength	double	Gets or sets the maximum width of the `SplitView` pane when it's fully expanded.
MinimumOpenPaneLength	double	Gets or sets the minimum width of the `SplitView` pane when it's fully expanded.
OpenPaneLength	double	Gets or sets the width of the `SplitView` pane when it's fully expanded.
OverlayBrush	Brush	Gets or sets a value that specifies the OverlayBrush
Pane	UIElement	Gets or sets the contents of the pane of a `SplitView`.
PaneBackground	Brush	Gets or sets the Brush to apply to the background of the `Pane` area of the control.
PaneForeground	Brush	Gets or sets the Brush to apply to the foreground of the `Pane` area of the control.
PanePlacement	SplitViewPanePlacement	Gets or sets a value that specifies whether the pane is shown on the right or left side of the `SplitView`.
ResizeThumbStyle	Style	Gets or Sets the `Style` for the resizing Thumb (type of `MetroThumb`)
TemplateSettings	SplitViewTemplateSettings	Gets an object that provides calculated values that can be referenced as TemplateBinding sources when defining templates for a `SplitView` control.

Methods

Name	Value	Summary
ChangeVisualState(bool, bool)	void
OnApplyTemplate()	void
OnIsPaneOpenChanged()	void
OnRenderSizeChanged(SizeChangedInfo)	void

SplitView Class