Avalonia API Reference
Split
A control with two views: A collapsible pane and an area for content
Definition
Namespace: Avalonia.Controls
Assembly: Avalonia.Controls (in Avalonia.Controls.dll) Version: 11.3.999
Assembly: Avalonia.Controls (in Avalonia.Controls.dll) Version: 11.3.999
C#
[TemplatePartAttribute("PART_PaneRoot", typeof(Panel))]
[PseudoClassesAttribute(new string[] { ... })]
[PseudoClassesAttribute(new string[] { ... })]
[PseudoClassesAttribute(new string[] { ... })]
[PseudoClassesAttribute(new string[] { ... })]
public class SplitView : ContentControlVB
<TemplatePartAttribute("PART_PaneRoot", GetType(Panel))>
<PseudoClassesAttribute(New String() { ... })>
<PseudoClassesAttribute(New String() { ... })>
<PseudoClassesAttribute(New String() { ... })>
<PseudoClassesAttribute(New String() { ... })>
Public Class SplitView
Inherits ContentControlF#
[<TemplatePartAttribute("PART_PaneRoot", typeof(Panel))>]
[<PseudoClassesAttribute(new string[] { ... })>]
[<PseudoClassesAttribute(new string[] { ... })>]
[<PseudoClassesAttribute(new string[] { ... })>]
[<PseudoClassesAttribute(new string[] { ... })>]
type SplitView =
class
inherit ContentControl
end- Inheritance
- Object AvaloniaObject Animatable StyledElement Visual Layoutable Interactive InputElement Control TemplatedControl ContentControl SplitView
Constructors
| SplitView | Initializes a new instance of the SplitView class |
Properties
| ActualThemeVariant | (Inherited from StyledElement) |
| Background |
Gets or sets the brush used to draw the control's background.
(Inherited from TemplatedControl) |
| BackgroundSizing |
Gets or sets how the control's background is drawn relative to the control's border.
(Inherited from TemplatedControl) |
| BorderBrush |
Gets or sets the brush used to draw the control's border.
(Inherited from TemplatedControl) |
| BorderThickness |
Gets or sets the thickness of the control's border.
(Inherited from TemplatedControl) |
| Bounds | (Inherited from Visual) |
| BypassFlowDirectionPolicies | (Inherited from Visual) |
| Classes | (Inherited from StyledElement) |
| Clip | (Inherited from Visual) |
| ClipToBounds | (Inherited from Visual) |
| CompactPaneLength | Gets or sets the length of the pane when in CompactOverlay or CompactInline mode |
| Content |
Gets or sets the content to display.
(Inherited from ContentControl) |
| ContentTemplate |
Gets or sets the data template used to display the content of the control.
(Inherited from ContentControl) |
| ContextFlyout |
Gets or sets a context flyout to the control
(Inherited from Control) |
| ContextMenu |
Gets or sets a context menu to the control.
(Inherited from Control) |
| CornerRadius |
Gets or sets the radius of the border rounded corners.
(Inherited from TemplatedControl) |
| Cursor | (Inherited from InputElement) |
| DataContext | (Inherited from StyledElement) |
| DataTemplates |
Gets or sets the data templates for the control.
(Inherited from Control) |
| DesiredSize | (Inherited from Layoutable) |
| DisplayMode | Gets or sets the SplitViewDisplayMode for the SplitView |
| Effect | (Inherited from Visual) |
| FlowDirection | (Inherited from Visual) |
| Focusable | (Inherited from InputElement) |
| FocusAdorner |
Gets or sets the control's focus adorner.
(Inherited from Control) |
| FontFamily |
Gets or sets the font family used to draw the control's text.
(Inherited from TemplatedControl) |
| FontFeatures |
Gets or sets the font features turned on/off.
(Inherited from TemplatedControl) |
| FontSize |
Gets or sets the size of the control's text in points.
(Inherited from TemplatedControl) |
| FontStretch |
Gets or sets the font stretch used to draw the control's text.
(Inherited from TemplatedControl) |
| FontStyle |
Gets or sets the font style used to draw the control's text.
(Inherited from TemplatedControl) |
| FontWeight |
Gets or sets the font weight used to draw the control's text.
(Inherited from TemplatedControl) |
| Foreground |
Gets or sets the brush used to draw the control's text and other foreground elements.
(Inherited from TemplatedControl) |
| GestureRecognizers | (Inherited from InputElement) |
| HasMirrorTransform | (Inherited from Visual) |
| Height | (Inherited from Layoutable) |
| HorizontalAlignment | (Inherited from Layoutable) |
| HorizontalContentAlignment |
Gets or sets the horizontal alignment of the content within the control.
(Inherited from ContentControl) |
| InheritanceParent | (Inherited from AvaloniaObject) |
| IsArrangeValid | (Inherited from Layoutable) |
| IsEffectivelyEnabled | (Inherited from InputElement) |
| IsEffectivelyVisible | (Inherited from Visual) |
| IsEnabled | (Inherited from InputElement) |
| IsEnabledCore | (Inherited from InputElement) |
| IsFocused | (Inherited from InputElement) |
| IsHitTestVisible | (Inherited from InputElement) |
| IsInitialized | (Inherited from StyledElement) |
| IsKeyboardFocusWithin | (Inherited from InputElement) |
| IsLoaded |
Gets a value indicating whether the control is fully constructed in the visual tree
and both layout and render are complete.
(Inherited from Control) |
| IsMeasureValid | (Inherited from Layoutable) |
| IsPaneOpen | Gets or sets whether the pane is open or closed |
| IsPointerOver | (Inherited from InputElement) |
| IsTabStop | (Inherited from InputElement) |
| IsVisible | (Inherited from Visual) |
| Item | (Inherited from AvaloniaObject) |
| Item | (Inherited from AvaloniaObject) |
| KeyBindings | (Inherited from InputElement) |
| LogicalChildren | (Inherited from StyledElement) |
| Margin | (Inherited from Layoutable) |
| MaxHeight | (Inherited from Layoutable) |
| MaxWidth | (Inherited from Layoutable) |
| MinHeight | (Inherited from Layoutable) |
| MinWidth | (Inherited from Layoutable) |
| Name | (Inherited from StyledElement) |
| Opacity | (Inherited from Visual) |
| OpacityMask | (Inherited from Visual) |
| OpenPaneLength | Gets or sets the length of the pane when open |
| Padding |
Gets or sets the padding placed between the border of the control and its content.
(Inherited from TemplatedControl) |
| Pane | Gets or sets the Pane for the SplitView |
| PaneBackground | Gets or sets the background of the pane |
| PanePlacement | Gets or sets the SplitViewPanePlacement for the SplitView |
| PaneTemplate | Gets or sets the data template used to display the header content of the control. |
| Parent | (Inherited from StyledElement) |
| Presenter |
Gets the presenter from the control's template.
(Inherited from ContentControl) |
| PseudoClasses | (Inherited from StyledElement) |
| RenderTransform | (Inherited from Visual) |
| RenderTransformOrigin | (Inherited from Visual) |
| Resources | (Inherited from StyledElement) |
| StyleKey | (Inherited from StyledElement) |
| StyleKeyOverride | (Inherited from StyledElement) |
| Styles | (Inherited from StyledElement) |
| TabIndex | (Inherited from InputElement) |
| Tag |
Gets or sets a user-defined object attached to the control.
(Inherited from Control) |
| Template |
Gets or sets the template that defines the control's appearance.
(Inherited from TemplatedControl) |
| TemplatedParent | (Inherited from StyledElement) |
| TemplateSettings | Gets or sets the TemplateSettings for the SplitView. |
| Theme | (Inherited from StyledElement) |
| Transitions | (Inherited from Animatable) |
| UseLayoutRounding | (Inherited from Layoutable) |
| UseLightDismissOverlayMode |
Gets or sets whether WinUI equivalent LightDismissOverlayMode is enabled
When enabled, and the pane is open in Overlay or CompactOverlay mode, the contents of the SplitView are darkened to visually separate the open pane and the rest of the SplitView. |
| VerticalAlignment | (Inherited from Layoutable) |
| VerticalContentAlignment |
Gets or sets the vertical alignment of the content within the control.
(Inherited from ContentControl) |
| VisualChildren | (Inherited from Visual) |
| VisualRoot | (Inherited from Visual) |
| Width | (Inherited from Layoutable) |
| ZIndex | (Inherited from Visual) |
Methods
| AddHandler(RoutedEvent, Delegate, RoutingStrategies, Boolean) | (Inherited from Interactive) |
| AddHandler``1(RoutedEventUMP, EventHandlerUMP, RoutingStrategies, Boolean) | (Inherited from Interactive) |
| ApplyStyling | (Inherited from StyledElement) |
| ApplyTemplate | (Inherited from TemplatedControl) |
| Arrange(Rect) | (Inherited from Layoutable) |
| ArrangeCore(Rect) | (Inherited from Layoutable) |
| ArrangeOverride(Size) | (Inherited from Layoutable) |
| BeginInit | (Inherited from StyledElement) |
| Bind(AvaloniaProperty, IBinding) | (Inherited from AvaloniaObject) |
| Bind(AvaloniaProperty, IObservableObject, BindingPriority) | (Inherited from AvaloniaObject) |
| Bind``1(DirectPropertyBaseUMP, IObservableUMP) | (Inherited from AvaloniaObject) |
| Bind``1(DirectPropertyBaseUMP, IObservableBindingValueUMP) | (Inherited from AvaloniaObject) |
| Bind``1(DirectPropertyBaseUMP, IObservableObject) | (Inherited from AvaloniaObject) |
| Bind``1(StyledPropertyUMP, IObservableUMP, BindingPriority) | (Inherited from AvaloniaObject) |
| Bind``1(StyledPropertyUMP, IObservableBindingValueUMP, BindingPriority) | (Inherited from AvaloniaObject) |
| Bind``1(StyledPropertyUMP, IObservableObject, BindingPriority) | (Inherited from AvaloniaObject) |
| BuildEventRoute(RoutedEvent) | (Inherited from Interactive) |
| CheckAccess | (Inherited from AvaloniaObject) |
| ClearValue(AvaloniaProperty) | (Inherited from AvaloniaObject) |
| ClearValue``1(AvaloniaPropertyUMP) | (Inherited from AvaloniaObject) |
| ClearValue``1(DirectPropertyBaseUMP) | (Inherited from AvaloniaObject) |
| ClearValue``1(StyledPropertyUMP) | (Inherited from AvaloniaObject) |
| CoerceValue(AvaloniaProperty) | (Inherited from AvaloniaObject) |
| EndInit | (Inherited from StyledElement) |
| Equals(Object) | (Inherited from AvaloniaObject) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| Focus(NavigationMethod, KeyModifiers) | (Inherited from InputElement) |
| GetBaseValue``1(StyledPropertyUMP) | (Inherited from AvaloniaObject) |
| GetHashCode | (Inherited from AvaloniaObject) |
| GetTemplateFocusTarget |
Gets the element that receives the focus adorner.
(Inherited from TemplatedControl) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetValue(AvaloniaProperty) | (Inherited from AvaloniaObject) |
| GetValue``1(DirectPropertyBaseUMP) | (Inherited from AvaloniaObject) |
| GetValue``1(StyledPropertyUMP) | (Inherited from AvaloniaObject) |
| InitializeIfNeeded | (Inherited from StyledElement) |
| InvalidateArrange | (Inherited from Layoutable) |
| InvalidateMeasure | (Inherited from Layoutable) |
| InvalidateMirrorTransform | (Inherited from Visual) |
| InvalidateVisual | (Inherited from Visual) |
| IsAnimating(AvaloniaProperty) | (Inherited from AvaloniaObject) |
| IsSet(AvaloniaProperty) | (Inherited from AvaloniaObject) |
| LogicalChildrenCollectionChanged(Object, NotifyCollectionChangedEventArgs) | (Inherited from Visual) |
| Measure(Size) | (Inherited from Layoutable) |
| MeasureCore(Size) | (Inherited from Layoutable) |
| MeasureOverride(Size) | (Inherited from Layoutable) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnAccessKey(RoutedEventArgs) | (Inherited from InputElement) |
| OnApplyTemplate(TemplateAppliedEventArgs) | (Overrides TemplatedControlOnApplyTemplate(TemplateAppliedEventArgs)) |
| OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs) | (Inherited from TemplatedControl) |
| OnAttachedToVisualTree(VisualTreeAttachmentEventArgs) | (Overrides Visual.OnAttachedToVisualTree(VisualTreeAttachmentEventArgs)) |
| OnAttachedToVisualTreeCore(VisualTreeAttachmentEventArgs) | (Inherited from Control) |
| OnCoerceIsPaneOpen(Boolean) | Called when the IsPaneOpen property has to be coerced. |
| OnCreateAutomationPeer |
Returns a new, type-specific AutomationPeer implementation for the control.
(Inherited from Control) |
| OnDataContextBeginUpdate | (Inherited from StyledElement) |
| OnDataContextChanged(EventArgs) | (Inherited from StyledElement) |
| OnDataContextEndUpdate | (Inherited from StyledElement) |
| OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs) | (Inherited from TemplatedControl) |
| OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs) | (Overrides Visual.OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs)) |
| OnDetachedFromVisualTreeCore(VisualTreeAttachmentEventArgs) | (Inherited from Control) |
| OnGotFocus(GotFocusEventArgs) | (Inherited from Control) |
| OnInitialized | (Inherited from StyledElement) |
| OnKeyDown(KeyEventArgs) | (Overrides InputElement.OnKeyDown(KeyEventArgs)) |
| OnKeyUp(KeyEventArgs) | (Inherited from Control) |
| OnLoaded(RoutedEventArgs) |
Invoked just before the Loaded event.
(Inherited from Control) |
| OnLostFocus(RoutedEventArgs) | (Inherited from Control) |
| OnMeasureInvalidated | (Inherited from Layoutable) |
| OnPaneClosed(RoutedEventArgs) | |
| OnPaneClosing(CancelRoutedEventArgs) | |
| OnPaneOpened(RoutedEventArgs) | |
| OnPaneOpening(CancelRoutedEventArgs) | |
| OnPointerCaptureLost(PointerCaptureLostEventArgs) | (Inherited from InputElement) |
| OnPointerEntered(PointerEventArgs) | (Inherited from InputElement) |
| OnPointerExited(PointerEventArgs) | (Inherited from InputElement) |
| OnPointerMoved(PointerEventArgs) | (Inherited from InputElement) |
| OnPointerPressed(PointerPressedEventArgs) | (Inherited from InputElement) |
| OnPointerReleased(PointerReleasedEventArgs) | (Inherited from Control) |
| OnPointerWheelChanged(PointerWheelEventArgs) | (Inherited from InputElement) |
| OnPropertyChanged(AvaloniaPropertyChangedEventArgs) | (Overrides ContentControlOnPropertyChanged(AvaloniaPropertyChangedEventArgs)) |
| OnPropertyChangedCore(AvaloniaPropertyChangedEventArgs) | (Inherited from Animatable) |
| OnSizeChanged(SizeChangedEventArgs) |
Invoked just before the SizeChanged event.
(Inherited from Control) |
| OnTemplateChanged(AvaloniaPropertyChangedEventArgs) |
Called when the Template property changes.
(Inherited from TemplatedControl) |
| OnTextInput(TextInputEventArgs) | (Inherited from InputElement) |
| OnUnloaded(RoutedEventArgs) |
Invoked just before the Unloaded event.
(Inherited from Control) |
| OnVisualParentChanged(Visual, Visual) | (Inherited from Layoutable) |
| RaiseEvent(RoutedEventArgs) | (Inherited from Interactive) |
| RaisePropertyChanged``1(DirectPropertyBaseUMP, UMP, UMP) | (Inherited from AvaloniaObject) |
| RegisterContentPresenter(ContentPresenter) | (Overrides ContentControlRegisterContentPresenter(ContentPresenter)) |
| RemoveHandler(RoutedEvent, Delegate) | (Inherited from Interactive) |
| RemoveHandler``1(RoutedEventUMP, EventHandlerUMP) | (Inherited from Interactive) |
| Render(DrawingContext) | (Inherited from Visual) |
| SetAndRaise``1(DirectPropertyBaseUMP, UMP, UMP) | (Inherited from AvaloniaObject) |
| SetCurrentValue(AvaloniaProperty, Object) | (Inherited from AvaloniaObject) |
| SetCurrentValue``1(StyledPropertyUMP, UMP) | (Inherited from AvaloniaObject) |
| SetValue(AvaloniaProperty, Object, BindingPriority) | (Inherited from AvaloniaObject) |
| SetValue``1(DirectPropertyBaseUMP, UMP) | (Inherited from AvaloniaObject) |
| SetValue``1(StyledPropertyUMP, UMP, BindingPriority) | (Inherited from AvaloniaObject) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryGetResource(Object, ThemeVariant, Object) | (Inherited from StyledElement) |
| UpdateDataValidation(AvaloniaProperty, BindingValueType, Exception) | (Inherited from AvaloniaObject) |
| UpdateIsEffectivelyEnabled | (Inherited from InputElement) |
| UpdateLayout | (Inherited from Layoutable) |
| VerifyAccess | (Inherited from AvaloniaObject) |
Events
| ActualThemeVariantChanged | (Inherited from StyledElement) |
| AttachedToLogicalTree | (Inherited from StyledElement) |
| AttachedToVisualTree | (Inherited from Visual) |
| ContextRequested |
Occurs when the user has completed a context input gesture, such as a right-click.
(Inherited from Control) |
| DataContextChanged | (Inherited from StyledElement) |
| DetachedFromLogicalTree | (Inherited from StyledElement) |
| DetachedFromVisualTree | (Inherited from Visual) |
| DoubleTapped | (Inherited from InputElement) |
| EffectiveViewportChanged | (Inherited from Layoutable) |
| GotFocus | (Inherited from InputElement) |
| Holding | (Inherited from InputElement) |
| Initialized | (Inherited from StyledElement) |
| KeyDown | (Inherited from InputElement) |
| KeyUp | (Inherited from InputElement) |
| LayoutUpdated | (Inherited from Layoutable) |
| Loaded |
Occurs when the control has been fully constructed in the visual tree and both
layout and render are complete.
(Inherited from Control) |
| LostFocus | (Inherited from InputElement) |
| PaneClosed | Fired when the pane is closed. |
| PaneClosing | Fired when the pane is closing. |
| PaneOpened | Fired when the pane is opened. |
| PaneOpening | Fired when the pane is opening. |
| PointerCaptureLost | (Inherited from InputElement) |
| PointerEntered | (Inherited from InputElement) |
| PointerExited | (Inherited from InputElement) |
| PointerMoved | (Inherited from InputElement) |
| PointerPressed | (Inherited from InputElement) |
| PointerReleased | (Inherited from InputElement) |
| PointerWheelChanged | (Inherited from InputElement) |
| PropertyChanged | (Inherited from AvaloniaObject) |
| ResourcesChanged | (Inherited from StyledElement) |
| SizeChanged |
Occurs when the bounds (actual size) of the control have changed.
(Inherited from Control) |
| Tapped | (Inherited from InputElement) |
| TemplateApplied |
Raised when the control's template is applied.
(Inherited from TemplatedControl) |
| TextInput | (Inherited from InputElement) |
| TextInputMethodClientRequested | (Inherited from InputElement) |
| Unloaded |
Occurs when the control is removed from the visual tree.
(Inherited from Control) |
Fields
| CompactPaneLengthProperty | Defines the CompactPaneLength property |
| DisplayModeProperty | Defines the DisplayMode property |
| IsPaneOpenProperty | Defines the IsPaneOpen property |
| OpenPaneLengthProperty | Defines the OpenPaneLength property |
| PaneBackgroundProperty | Defines the PaneBackground property |
| PaneClosedEvent | Defines the PaneClosed event. |
| PaneClosingEvent | Defines the PaneClosing event. |
| PaneOpenedEvent | Defines the PaneOpened event. |
| PaneOpeningEvent | Defines the PaneOpening event. |
| PanePlacementProperty | Defines the PanePlacement property |
| PaneProperty | Defines the Pane property |
| PaneTemplateProperty | Defines the PaneTemplate property. |
| TemplateSettingsProperty | Defines the TemplateSettings property |
| UseLightDismissOverlayModeProperty | Defines the UseLightDismissOverlayMode property |
Extension Methods
| BringIntoView |
Tries to bring the control into view.
(Defined by ControlExtensions) |
| BringIntoView(Rect) |
Tries to bring the control into view.
(Defined by ControlExtensions) |
| FindControlT(String) |
Finds the named control in the scope of the specified control.
(Defined by ControlExtensions) |
| FindDataTemplate(Object, IDataTemplate) |
Find a data template that matches a piece of data.
(Defined by DataTemplateExtensions) |
| GetControlT(String) |
Finds the named control in the scope of the specified control and throws if not found.
(Defined by ControlExtensions) |
| GetTemplateChildren | (Defined by TemplateExtensions) |