SplitView Class

Definition

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

Equivalent WinUI class: Microsoft.UI.Xaml.Controls.SplitView.

/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.ISplitViewFactory, Windows.Foundation.Metadata.CompositionType.Public, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ISplitViewStatics, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
/// [Windows.UI.Xaml.Markup.ContentProperty(Name="Content")]
class SplitView : Control
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
/// [Windows.UI.Xaml.Markup.ContentProperty(Name="Content")]
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.ISplitViewFactory, Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ISplitViewStatics, 65536, "Windows.Foundation.UniversalApiContract")]
class SplitView : Control
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
/// [Windows.UI.Xaml.Markup.ContentProperty(Name="Content")]
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.ISplitViewFactory, Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ISplitViewStatics, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ISplitViewStatics2, 196608, "Windows.Foundation.UniversalApiContract")]
class SplitView : Control
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.ISplitViewFactory), Windows.Foundation.Metadata.CompositionType.Public, 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ISplitViewStatics), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
[Windows.UI.Xaml.Markup.ContentProperty(Name="Content")]
public class SplitView : Control
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
[Windows.UI.Xaml.Markup.ContentProperty(Name="Content")]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.ISplitViewFactory), Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ISplitViewStatics), 65536, "Windows.Foundation.UniversalApiContract")]
public class SplitView : Control
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
[Windows.UI.Xaml.Markup.ContentProperty(Name="Content")]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.ISplitViewFactory), Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ISplitViewStatics), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ISplitViewStatics2), 196608, "Windows.Foundation.UniversalApiContract")]
public class SplitView : Control
Public Class SplitView
Inherits Control
<SplitView>
  <SplitView.Content>
    singleObject
  </SplitView.Content>
  <SplitView.Pane>
    singleObject
  </SplitView.Pane>
</SplitView>

Inheritance
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Examples

Tip

For more info, design guidance, and code examples, see Split view.

If you have the XAML Controls Gallery app installed, click here to open the app and see the SplitView in action.

Here's a SplitView control with an open Pane appearing inline next to the Content.

<SplitView IsPaneOpen="True"
           DisplayMode="Inline"
           OpenPaneLength="296">
    <SplitView.Pane>
        <TextBlock Text="Pane"
                   FontSize="24"
                   VerticalAlignment="Center"
                   HorizontalAlignment="Center"/>
    </SplitView.Pane>

    <Grid>
        <TextBlock Text="Content"
                   FontSize="24"
                   VerticalAlignment="Center"
                   HorizontalAlignment="Center"/>
    </Grid>
</SplitView>

Remarks

Tip

For more info, design guidance, and code examples, see Split view.

The SplitView control presents two areas of content: a Pane and the main Content. You typically use a SplitView to create a top-level navigation experience that adapts to different screen widths following the nav pane pattern or the master/details pattern, but it's not strictly limited to use for navigation.

The XAML for this SplitView is shown in the Examples section.

Split view control

The Content area is always present and can contain a single child element, which is typically a Panel derived container that contains additional child elements. Although the Content is always present, it can be completely covered by the Pane.

There are several properties you can set to control the appearance and behavior of the Pane. Set the IsPaneOpen property to open or close the Pane. The SplitView does not include a built-in affordance for users to toggle the state of the Pane, like a menu (or “hamburger”) button. You must provide this affordance and the code to toggle the IsPaneOpen property.

To specify the length of the open pane, set the OpenPaneLength property. You can set the PanePlacement property to have the Pane appear on either the left or right side of the Content.

Although the appearance of the control is largely based on the elements assigned to the Pane and Content, you can change the default background color of the Pane by setting the PaneBackground.

Set the DisplayMode property to configure the interaction of the Pane with the Content. By default, the Pane overlays the Content and disappears completely when closed. You can use one of the "inline" modes to show the Pane side-by-side with the Content. You can use the "compact" modes to make a narrow section of the Pane remain visible even when the Pane is closed. See the SplitViewDisplayMode enumeration for more info about the supported modes.

Version history

Windows version SDK version Value added
1607 14393 LightDismissOverlayMode
1709 16299 PaneOpened
1709 16299 PaneOpening

Constructors

SplitView()

Initializes a new instance of the SplitView class.

Equivalent WinUI constructor: Microsoft.UI.Xaml.Controls.SplitView.SplitView.

Properties

AccessKey

Gets or sets the access key (mnemonic) for this element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.AccessKey.

(Inherited from UIElement)
AccessKeyScopeOwner

Gets or sets a source element that provides the access key scope for this element, even if it's not in the visual tree of the source element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.AccessKeyScopeOwner.

(Inherited from UIElement)
ActualHeight

Gets the rendered height of a FrameworkElement. See Remarks.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.ActualHeight.

(Inherited from FrameworkElement)
ActualOffset

Gets the position of this UIElement, relative to its parent, computed during the arrange pass of the layout process.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.ActualOffset.

(Inherited from UIElement)
ActualSize

Gets the size that this UIElement computed during the arrange pass of the layout process.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.ActualSize.

(Inherited from UIElement)
ActualTheme

Gets the UI theme that is currently used by the element, which might be different than the RequestedTheme.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.ActualTheme.

(Inherited from FrameworkElement)
ActualWidth

Gets the rendered width of a FrameworkElement. See Remarks.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.ActualWidth.

(Inherited from FrameworkElement)
AllowDrop

Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.AllowDrop.

(Inherited from UIElement)
AllowFocusOnInteraction

Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.AllowFocusOnInteraction.

(Inherited from FrameworkElement)
AllowFocusWhenDisabled

Gets or sets whether a disabled control can receive focus.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.AllowFocusWhenDisabled.

(Inherited from FrameworkElement)
Background

Gets or sets a brush that provides the background of the control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.Background.

(Inherited from Control)
BackgroundSizing

Gets or sets a value that indicates how far the background extends in relation to this element's border.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.BackgroundSizing.

(Inherited from Control)
BaseUri

Gets a Uniform Resource Identifier (URI) that represents the base Uniform Resource Identifier (URI) for an XAML-constructed object at XAML load time. This property is useful for Uniform Resource Identifier (URI) resolution at run time.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.BaseUri.

(Inherited from FrameworkElement)
BorderBrush

Gets or sets a brush that describes the border fill of a control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.BorderBrush.

(Inherited from Control)
BorderThickness

Gets or sets the border thickness of a control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.BorderThickness.

(Inherited from Control)
CacheMode

Gets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.CacheMode.

(Inherited from UIElement)
CanBeScrollAnchor

Gets or sets a value that indicates whether the UIElement can be a candidate for scroll anchoring.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.CanBeScrollAnchor.

(Inherited from UIElement)
CanDrag

Gets or sets a value that indicates whether the element can be dragged as data in a drag-and-drop operation.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.CanDrag.

(Inherited from UIElement)
CenterPoint

Gets or sets the center point of the element, which is the point about which rotation or scaling occurs. Affects the rendering position of the element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.CenterPoint.

(Inherited from UIElement)
CharacterSpacing

Gets or sets the uniform spacing between characters, in units of 1/1000 of an em.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.CharacterSpacing.

(Inherited from Control)
Clip

Gets or sets the RectangleGeometry used to define the outline of the contents of a UIElement.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Clip.

(Inherited from UIElement)
CompactPaneLength

Gets or sets the width of the SplitView pane in its compact display mode.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.CompactPaneLength.

CompactPaneLengthProperty

Identifies the CompactPaneLength  dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.CompactPaneLengthProperty.

CompositeMode

Gets or sets a property that declares alternate composition and blending modes for the element in its parent layout and window. This is relevant for elements that are involved in a mixed XAML / Microsoft DirectX UI.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.CompositeMode.

(Inherited from UIElement)
Content

Gets or sets the contents of the main panel of a SplitView.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.Content.

ContentProperty

Identifies the Content  dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.ContentProperty.

ContextFlyout

Gets or sets the flyout associated with this element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.ContextFlyout.

(Inherited from UIElement)
CornerRadius

Gets or sets the radius for the corners of the control's border.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.CornerRadius.

(Inherited from Control)
DataContext

Gets or sets the data context for a FrameworkElement. A common use of a data context is when a FrameworkElement uses the {Binding} markup extension and participates in data binding.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.DataContext.

(Inherited from FrameworkElement)
DefaultStyleKey

Gets or sets the key that references the default style for the control. Authors of custom controls use this property to change the default for the style that their control uses.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.DefaultStyleKey.

(Inherited from Control)
DefaultStyleResourceUri

Gets or sets the path to the resource file that contains the default style for the control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.DefaultStyleResourceUri.

(Inherited from Control)
DesiredSize

Gets the size that this UIElement computed during the measure pass of the layout process.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.DesiredSize.

(Inherited from UIElement)
Dispatcher

Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread.

Equivalent WinUI property: Microsoft.UI.Xaml.DependencyObject.Dispatcher.

(Inherited from DependencyObject)
DisplayMode

Gets of sets a value that specifies how the pane and content areas of a SplitView are shown.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.DisplayMode.

DisplayModeProperty

Identifies the DisplayMode  dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.DisplayModeProperty.

ElementSoundMode

Get or sets a value that specifies a control's preference for whether sounds are played.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.ElementSoundMode.

(Inherited from Control)
ExitDisplayModeOnAccessKeyInvoked

Gets or sets a value that specifies whether the access key display is dismissed when an access key is invoked.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.ExitDisplayModeOnAccessKeyInvoked.

(Inherited from UIElement)
FlowDirection

Gets or sets the direction in which text and other UI elements flow within any parent element that controls their layout. This property can be set to either LeftToRight or RightToLeft. Setting FlowDirection to RightToLeft on any element sets the alignment to the right, the reading order to right-to-left and the layout of the control to flow from right to left.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.FlowDirection.

(Inherited from FrameworkElement)
FocusState

Gets a value that specifies whether this control has focus, and the mode by which focus was obtained.

(Inherited from Control)
FocusVisualMargin

Gets or sets the outer margin of the focus visual for a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.FocusVisualMargin.

(Inherited from FrameworkElement)
FocusVisualPrimaryBrush

Gets or sets the brush used to draw the outer border of a HighVisibility or Reveal focus visual for a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.FocusVisualPrimaryBrush.

(Inherited from FrameworkElement)
FocusVisualPrimaryThickness

Gets or sets the thickness of the outer border of a HighVisibility or Reveal focus visual for a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.FocusVisualPrimaryThickness.

(Inherited from FrameworkElement)
FocusVisualSecondaryBrush

Gets or sets the brush used to draw the inner border of a HighVisibility or Reveal focus visual for a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.FocusVisualSecondaryBrush.

(Inherited from FrameworkElement)
FocusVisualSecondaryThickness

Gets or sets the thickness of the inner border of a HighVisibility or Reveal focus visual for a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.FocusVisualSecondaryThickness.

(Inherited from FrameworkElement)
FontFamily

Gets or sets the font used to display text in the control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.FontFamily.

(Inherited from Control)
FontSize

Gets or sets the size of the text in this control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.FontSize.

(Inherited from Control)
FontStretch

Gets or sets the degree to which a font is condensed or expanded on the screen.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.FontStretch.

(Inherited from Control)
FontStyle

Gets or sets the style in which the text is rendered.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.FontStyle.

(Inherited from Control)
FontWeight

Gets or sets the thickness of the specified font.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.FontWeight.

(Inherited from Control)
Foreground

Gets or sets a brush that describes the foreground color.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.Foreground.

(Inherited from Control)
Height

Gets or sets the suggested height of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Height.

(Inherited from FrameworkElement)
HighContrastAdjustment

Gets or sets a value that indicates whether the framework automatically adjusts the element's visual properties when high contrast themes are enabled.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.HighContrastAdjustment.

(Inherited from UIElement)
HorizontalAlignment

Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.HorizontalAlignment.

(Inherited from FrameworkElement)
HorizontalContentAlignment

Gets or sets the horizontal alignment of the control's content.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.HorizontalContentAlignment.

(Inherited from Control)
IsAccessKeyScope

Gets or sets a value that indicates whether an element defines its own access key scope.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.IsAccessKeyScope.

(Inherited from UIElement)
IsDoubleTapEnabled

Gets or sets a value that determines whether the DoubleTapped event can originate from that element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.IsDoubleTapEnabled.

(Inherited from UIElement)
IsEnabled

Gets or sets a value indicating whether the user can interact with the control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.IsEnabled.

(Inherited from Control)
IsFocusEngaged

Get or sets a value that indicates whether focus is constrained within the control boundaries (for game pad/remote interaction).

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.IsFocusEngaged.

(Inherited from Control)
IsFocusEngagementEnabled

Get or sets a value that indicates whether focus can be constrained within the control boundaries (for game pad/remote interaction).

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.IsFocusEngagementEnabled.

(Inherited from Control)
IsHitTestVisible

Gets or sets whether the contained area of this UIElement can return true values for hit testing.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.IsHitTestVisible.

(Inherited from UIElement)
IsHoldingEnabled

Gets or sets a value that determines whether the Holding event can originate from that element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.IsHoldingEnabled.

(Inherited from UIElement)
IsLoaded

Gets a value that indicates whether the element has been added to the element tree and is ready for interaction.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.IsLoaded.

(Inherited from FrameworkElement)
IsPaneOpen

Gets or sets a value that specifies whether the SplitView pane is expanded to its full width.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.IsPaneOpen.

IsPaneOpenProperty

Identifies the IsPaneOpen  dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.IsPaneOpenProperty.

IsRightTapEnabled

Gets or sets a value that determines whether the RightTapped event can originate from that element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.IsRightTapEnabled.

(Inherited from UIElement)
IsTabStop

Gets or sets a value that indicates whether a control is included in tab navigation.

(Inherited from Control)
IsTapEnabled

Gets or sets a value that determines whether the Tapped event can originate from that element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.IsTapEnabled.

(Inherited from UIElement)
IsTextScaleFactorEnabled

Gets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.IsTextScaleFactorEnabled.

(Inherited from Control)
KeyboardAcceleratorPlacementMode

Gets or sets a value that indicates whether the control tooltip displays the key combination for it's associated keyboard accelerator.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyboardAcceleratorPlacementMode.

(Inherited from UIElement)
KeyboardAcceleratorPlacementTarget

Gets or sets a value that indicates the control tooltip that displays the accelerator key combination.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyboardAcceleratorPlacementTarget.

(Inherited from UIElement)
KeyboardAccelerators

Gets the collection of key combinations that invoke an action using the keyboard.

Accelerators are typically assigned to buttons or menu items.

Example of a menu showing keyboard accelerators for various menu items
Example of a menu showing keyboard accelerators for various menu items

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyboardAccelerators.

(Inherited from UIElement)
KeyTipHorizontalOffset

Gets or sets a value that indicates how far left or right the Key Tip is placed in relation to the UIElement.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyTipHorizontalOffset.

(Inherited from UIElement)
KeyTipPlacementMode

Gets or sets a value that indicates where the access key Key Tip is placed in relation to the boundary of the UIElement.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyTipPlacementMode.

(Inherited from UIElement)
KeyTipTarget

Gets or sets a value that indicates the element targeted by the access key Key Tip.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyTipTarget.

(Inherited from UIElement)
KeyTipVerticalOffset

Gets or sets a value that indicates how far up or down the Key Tip is placed in relation to the UI element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyTipVerticalOffset.

(Inherited from UIElement)
Language

Gets or sets localization/globalization language information that applies to a FrameworkElement, and also to all child elements of the current FrameworkElement in the object representation and in UI.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Language.

(Inherited from FrameworkElement)
LightDismissOverlayMode

Gets or sets a value that specifies whether the area outside of a light-dismiss UI is darkened.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.LightDismissOverlayMode.

LightDismissOverlayModeProperty

Identifies the LightDismissOverlayMode dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.LightDismissOverlayModeProperty.

Lights

Gets the collection of XamlLight objects attached to this element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Lights.

(Inherited from UIElement)
ManipulationMode

Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. Setting this value enables handling the manipulation events from this element in app code.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.ManipulationMode.

(Inherited from UIElement)
Margin

Gets or sets the outer margin of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Margin.

(Inherited from FrameworkElement)
MaxHeight

Gets or sets the maximum height constraint of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.MaxHeight.

(Inherited from FrameworkElement)
MaxWidth

Gets or sets the maximum width constraint of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.MaxWidth.

(Inherited from FrameworkElement)
MinHeight

Gets or sets the minimum height constraint of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.MinHeight.

(Inherited from FrameworkElement)
MinWidth

Gets or sets the minimum width constraint of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.MinWidth.

(Inherited from FrameworkElement)
Name

Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Name.

(Inherited from FrameworkElement)
Opacity

Gets or sets the degree of the object's opacity.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Opacity.

(Inherited from UIElement)
OpacityTransition

Gets or sets the ScalarTransition that animates changes to the Opacity property.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.OpacityTransition.

(Inherited from UIElement)
OpenPaneLength

Gets or sets the width of the SplitView pane when it's fully expanded.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.OpenPaneLength.

OpenPaneLengthProperty

Identifies the  OpenPaneLength dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.OpenPaneLengthProperty.

Padding

Gets or sets the padding inside a control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.Padding.

(Inherited from Control)
Pane

Gets or sets the contents of the pane of a SplitView.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.Pane.

PaneBackground

Gets or sets the Brush to apply to the background of the Pane area of the control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.PaneBackground.

PaneBackgroundProperty

Identifies the PaneBackground  dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.PaneBackgroundProperty.

PanePlacement

Gets or sets a value that specifies whether the pane is shown on the right or left side of the SplitView.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.PanePlacement.

PanePlacementProperty

Identifies the PanePlacement  dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.PanePlacementProperty.

PaneProperty

Identifies the Pane  dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.PaneProperty.

Parent

Gets the parent object of this FrameworkElement in the object tree.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Parent.

(Inherited from FrameworkElement)
PointerCaptures

Gets the set of all captured pointers, represented as Pointer values.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.PointerCaptures.

(Inherited from UIElement)
Projection

Gets or sets the perspective projection (3-D effect) to apply when rendering this element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Projection.

(Inherited from UIElement)
RenderSize

Gets the final render size of a UIElement. Use is not recommended, see Remarks.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.RenderSize.

(Inherited from UIElement)
RenderTransform

Gets or sets transform information that affects the rendering position of a UIElement.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.RenderTransform.

(Inherited from UIElement)
RenderTransformOrigin

Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.RenderTransformOrigin.

(Inherited from UIElement)
RequestedTheme

Gets or sets the UI theme that is used by the UIElement (and its child elements) for resource determination. The UI theme you specify with RequestedTheme can override the app-level RequestedTheme.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.RequestedTheme.

(Inherited from FrameworkElement)
RequiresPointer

Gets or sets whether a UI element supports mouse mode, which emulates pointer interaction experiences with non-pointer input devices such as an Xbox gamepad or remote control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.RequiresPointer.

(Inherited from Control)
Resources

Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Resources.

(Inherited from FrameworkElement)
Rotation

Gets or sets the angle of clockwise rotation, in degrees. Rotates relative to the RotationAxis and the CenterPoint. Affects the rendering position of the element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Rotation.

(Inherited from UIElement)
RotationAxis

Gets or sets the axis to rotate the element around.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.RotationAxis.

(Inherited from UIElement)
RotationTransition

Gets or sets the ScalarTransition that animates changes to the Rotation property.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.RotationTransition.

(Inherited from UIElement)
Scale

Gets or sets the scale of the element. Scales relative to the element's CenterPoint. Affects the rendering position of the element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Scale.

(Inherited from UIElement)
ScaleTransition

Gets or sets the Vector3Transition that animates changes to the Scale property.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.ScaleTransition.

(Inherited from UIElement)
Shadow

Gets or sets the shadow effect cast by the element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Shadow.

(Inherited from UIElement)
Style

Gets or sets an instance Style that is applied for this object during layout and rendering.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Style.

(Inherited from FrameworkElement)
TabFocusNavigation

Gets or sets a value that modifies how tabbing and TabIndex work for this control.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.TabFocusNavigation.

(Inherited from UIElement)
TabIndex

Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key.

(Inherited from Control)
TabNavigation

Gets or sets a value that modifies how tabbing and TabIndex work for this control.

Note

For Windows 10 Creators Update (build 10.0.15063) and newer, the TabFocusNavigation property is available on the UIElement base class to include objects in the tab sequence that do not use a ControlTemplate.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.TabNavigation.

(Inherited from Control)
Tag

Gets or sets an arbitrary object value that can be used to store custom information about this object.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Tag.

(Inherited from FrameworkElement)
Template

Gets or sets a control template. The control template defines the visual appearance of a control in UI, and is defined in XAML markup.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.Template.

(Inherited from Control)
TemplateSettings

Gets an object that provides calculated values that can be referenced as TemplateBinding sources when defining templates for a SplitView control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.TemplateSettings.

TemplateSettingsProperty

Identifies the TemplateSettings  dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.SplitView.TemplateSettingsProperty.

Transform3D

Gets or sets the 3-D transform effect to apply when rendering this element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Transform3D.

(Inherited from UIElement)
TransformMatrix

Gets or sets the transformation matrix to apply to the element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.TransformMatrix.

(Inherited from UIElement)
Transitions

Gets or sets the collection of Transition style elements that apply to a UIElement.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Transitions.

(Inherited from UIElement)
Translation

Gets or sets the x, y, and z rendering position of the element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Translation.

(Inherited from UIElement)
TranslationTransition

Gets or sets the Vector3Transition that animates changes to the Translation property.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.TranslationTransition.

(Inherited from UIElement)
Triggers

Gets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. See Remarks.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Triggers.

(Inherited from FrameworkElement)
UIContext

Gets the context identifier for the element.

(Inherited from UIElement)
UseLayoutRounding

Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.UseLayoutRounding.

(Inherited from UIElement)
UseSystemFocusVisuals

Gets or sets a value that indicates whether the control uses focus visuals that are drawn by the system or those defined in the control template.

(Inherited from Control)
VerticalAlignment

Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.VerticalAlignment.

(Inherited from FrameworkElement)
VerticalContentAlignment

Gets or sets the vertical alignment of the control's content.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.VerticalContentAlignment.

(Inherited from Control)
Visibility

Gets or sets the visibility of a UIElement. A UIElement that is not visible is not rendered and does not communicate its desired size to layout.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Visibility.

(Inherited from UIElement)
Width

Gets or sets the width of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Width.

(Inherited from FrameworkElement)
XamlRoot

Gets or sets the XamlRoot in which this element is being viewed.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.XamlRoot.

(Inherited from UIElement)
XYFocusDown

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) down.

(Inherited from Control)
XYFocusDownNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of a down navigation.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.XYFocusDownNavigationStrategy.

(Inherited from UIElement)
XYFocusKeyboardNavigation

Gets or sets a value that enables or disables navigation using the keyboard directional arrows.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.XYFocusKeyboardNavigation.

(Inherited from UIElement)
XYFocusLeft

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) left.

(Inherited from Control)
XYFocusLeftNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of a left navigation.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.XYFocusLeftNavigationStrategy.

(Inherited from UIElement)
XYFocusRight

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) right.

(Inherited from Control)
XYFocusRightNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of a right navigation.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.XYFocusRightNavigationStrategy.

(Inherited from UIElement)
XYFocusUp

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) up.

(Inherited from Control)
XYFocusUpNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of an up navigation.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.XYFocusUpNavigationStrategy.

(Inherited from UIElement)

Methods

AddHandler(RoutedEvent, Object, Boolean)

Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked even if the event is handled elsewhere.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.AddHandler.

(Inherited from UIElement)
ApplyTemplate()

Loads the relevant control template so that its parts can be referenced.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.ApplyTemplate.

(Inherited from Control)
Arrange(Rect)

Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.Arrange.

(Inherited from UIElement)
ArrangeOverride(Size)

Provides the behavior for the "Arrange" pass of layout. Classes can override this method to define their own "Arrange" pass behavior.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.ArrangeOverride.

(Inherited from FrameworkElement)
CancelDirectManipulations()

Cancels ongoing direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.CancelDirectManipulations.

(Inherited from UIElement)
CapturePointer(Pointer)

Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.CapturePointer.

(Inherited from UIElement)
ClearValue(DependencyProperty)

Clears the local value of a dependency property.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ClearValue.

(Inherited from DependencyObject)
FindName(String)

Retrieves an object that has the specified identifier name.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.FindName.

(Inherited from FrameworkElement)
FindSubElementsForTouchTargeting(Point, Rect)

Enables a UIElement subclass to expose child elements that assist with resolving touch targeting.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.FindSubElementsForTouchTargeting.

(Inherited from UIElement)
Focus(FocusState)

Attempts to set the focus on the control.

(Inherited from Control)
GetAnimationBaseValue(DependencyProperty)

Returns any base value established for a dependency property, which would apply in cases where an animation is not active.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetAnimationBaseValue.

(Inherited from DependencyObject)
GetBindingExpression(DependencyProperty)

Returns the BindingExpression that represents the binding on the specified property.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.GetBindingExpression.

(Inherited from FrameworkElement)
GetChildrenInTabFocusOrder()

Enables a UIElement subclass to expose child elements that take part in Tab focus.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.GetChildrenInTabFocusOrder.

(Inherited from UIElement)
GetTemplateChild(String)

Retrieves the named element in the instantiated ControlTemplate visual tree.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.GetTemplateChild.

(Inherited from Control)
GetValue(DependencyProperty)

Returns the current effective value of a dependency property from a DependencyObject.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetValue.

(Inherited from DependencyObject)
GoToElementStateCore(String, Boolean)

When implemented in a derived class, enables per-state construction of a visual tree for a control template in code, rather than by loading XAML for all states at control startup.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.GoToElementStateCore.

(Inherited from FrameworkElement)
InvalidateArrange()

Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.InvalidateArrange.

(Inherited from UIElement)
InvalidateMeasure()

Invalidates the measurement state (layout) for a UIElement.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.InvalidateMeasure.

(Inherited from UIElement)
InvalidateViewport()

Invalidates the viewport state for a UIElement that is used to calculate the effective viewport.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.InvalidateViewport.

(Inherited from FrameworkElement)
Measure(Size)

Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.Measure.

(Inherited from UIElement)
MeasureOverride(Size)

Provides the behavior for the "Measure" pass of the layout cycle. Classes can override this method to define their own "Measure" pass behavior.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.MeasureOverride.

(Inherited from FrameworkElement)
OnApplyTemplate()

Invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in your app. Override this method to influence the default post-template logic of a class.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.OnApplyTemplate.

(Inherited from FrameworkElement)
OnBringIntoViewRequested(BringIntoViewRequestedEventArgs)

Called before the BringIntoViewRequested event occurs. Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.OnBringIntoViewRequested.

(Inherited from UIElement)
OnCharacterReceived(CharacterReceivedRoutedEventArgs)

Called before the CharacterReceived event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnCharacterReceived.

(Inherited from Control)
OnCreateAutomationPeer()

When implemented in a derived class, returns class-specific AutomationPeer implementations for the Microsoft UI Automation infrastructure.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.OnCreateAutomationPeer.

(Inherited from UIElement)
OnDisconnectVisualChildren()

Override this method to implement how layout and logic should behave when items are removed from a class-specific content or children property.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.OnDisconnectVisualChildren.

(Inherited from UIElement)
OnDoubleTapped(DoubleTappedRoutedEventArgs)

Called before the DoubleTapped event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnDoubleTapped.

(Inherited from Control)
OnDragEnter(DragEventArgs)

Called before the DragEnter event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnDragEnter.

(Inherited from Control)
OnDragLeave(DragEventArgs)

Called before the DragLeave event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnDragLeave.

(Inherited from Control)
OnDragOver(DragEventArgs)

Called before the DragOver event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnDragOver.

(Inherited from Control)
OnDrop(DragEventArgs)

Called before the Drop event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnDrop.

(Inherited from Control)
OnGotFocus(RoutedEventArgs)

Called before the GotFocus event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnGotFocus.

(Inherited from Control)
OnHolding(HoldingRoutedEventArgs)

Called before the Holding event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnHolding.

(Inherited from Control)
OnKeyboardAcceleratorInvoked(KeyboardAcceleratorInvokedEventArgs)

Called when a keyboard shortcut (or accelerator) is processed in your app. Override this method to handle how your app responds when a keyboard accelerator is invoked.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.OnKeyboardAcceleratorInvoked.

(Inherited from UIElement)
OnKeyDown(KeyRoutedEventArgs)

Called before the KeyDown event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnKeyDown.

(Inherited from Control)
OnKeyUp(KeyRoutedEventArgs)

Called before the KeyUp event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnKeyUp.

(Inherited from Control)
OnLostFocus(RoutedEventArgs)

Called before the LostFocus event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnLostFocus.

(Inherited from Control)
OnManipulationCompleted(ManipulationCompletedRoutedEventArgs)

Called before the ManipulationCompleted event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnManipulationCompleted.

(Inherited from Control)
OnManipulationDelta(ManipulationDeltaRoutedEventArgs)

Called before the ManipulationDelta event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnManipulationDelta.

(Inherited from Control)
OnManipulationInertiaStarting(ManipulationInertiaStartingRoutedEventArgs)

Called before the ManipulationInertiaStarting event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnManipulationInertiaStarting.

(Inherited from Control)
OnManipulationStarted(ManipulationStartedRoutedEventArgs)

Called before the ManipulationStarted event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnManipulationStarted.

(Inherited from Control)
OnManipulationStarting(ManipulationStartingRoutedEventArgs)

Called before the ManipulationStarting event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnManipulationStarting.

(Inherited from Control)
OnPointerCanceled(PointerRoutedEventArgs)

Called before the PointerCanceled event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPointerCanceled.

(Inherited from Control)
OnPointerCaptureLost(PointerRoutedEventArgs)

Called before the PointerCaptureLost event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPointerCaptureLost.

(Inherited from Control)
OnPointerEntered(PointerRoutedEventArgs)

Called before the PointerEntered event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPointerEntered.

(Inherited from Control)
OnPointerExited(PointerRoutedEventArgs)

Called before the PointerExited event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPointerExited.

(Inherited from Control)
OnPointerMoved(PointerRoutedEventArgs)

Called before the PointerMoved event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPointerMoved.

(Inherited from Control)
OnPointerPressed(PointerRoutedEventArgs)

Called before the PointerPressed event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPointerPressed.

(Inherited from Control)
OnPointerReleased(PointerRoutedEventArgs)

Called before the PointerReleased event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPointerReleased.

(Inherited from Control)
OnPointerWheelChanged(PointerRoutedEventArgs)

Called before the PointerWheelChanged event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPointerWheelChanged.

(Inherited from Control)
OnPreviewKeyDown(KeyRoutedEventArgs)

Called before the PreviewKeyDown event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPreviewKeyDown.

(Inherited from Control)
OnPreviewKeyUp(KeyRoutedEventArgs)

Called before the PreviewKeyUp event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPreviewKeyUp.

(Inherited from Control)
OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs)

Called just before a keyboard shortcut (or accelerator) is processed in your app. Invoked whenever application code or internal processes call ProcessKeyboardAccelerators. Override this method to influence the default accelerator handling.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.OnProcessKeyboardAccelerators.

(Inherited from UIElement)
OnRightTapped(RightTappedRoutedEventArgs)

Called before the RightTapped event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnRightTapped.

(Inherited from Control)
OnTapped(TappedRoutedEventArgs)

Called before the Tapped event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnTapped.

(Inherited from Control)
PopulatePropertyInfo(String, AnimationPropertyInfo)

Defines a property that can be animated.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.PopulatePropertyInfo.

(Inherited from UIElement)
PopulatePropertyInfoOverride(String, AnimationPropertyInfo)

When overridden in a derived class, defines a property that can be animated.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.PopulatePropertyInfoOverride.

(Inherited from UIElement)
ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if a local value is set.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ReadLocalValue.

(Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)

Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.RegisterPropertyChangedCallback.

(Inherited from DependencyObject)
ReleasePointerCapture(Pointer)

Releases pointer captures for capture of one specific pointer by this UIElement.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.ReleasePointerCapture.

(Inherited from UIElement)
ReleasePointerCaptures()

Releases all pointer captures held by this element.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.ReleasePointerCaptures.

(Inherited from UIElement)
RemoveFocusEngagement()

Releases focus from the control boundaries for a control that has focus engagement (for game pad/remote interaction).

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.RemoveFocusEngagement.

(Inherited from Control)
RemoveHandler(RoutedEvent, Object)

Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.RemoveHandler.

(Inherited from UIElement)
SetBinding(DependencyProperty, BindingBase)

Attaches a binding to a FrameworkElement, using the provided binding object.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.SetBinding.

(Inherited from FrameworkElement)
SetValue(DependencyProperty, Object)

Sets the local value of a dependency property on a DependencyObject.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.SetValue.

(Inherited from DependencyObject)
StartAnimation(ICompositionAnimationBase)

Begins the specified animation on the element.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.StartAnimation.

(Inherited from UIElement)
StartBringIntoView()

Initiates a request to the XAML framework to bring the element into view within any scrollable regions it is contained within.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.StartBringIntoView.

(Inherited from UIElement)
StartBringIntoView(BringIntoViewOptions)

Initiates a request to the XAML framework to bring the element into view using the specified options.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.StartBringIntoView.

(Inherited from UIElement)
StartDragAsync(PointerPoint)

Initiates a drag-and-drop operation.

(Inherited from UIElement)
StopAnimation(ICompositionAnimationBase)

Stops the specified animation on the element.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.StopAnimation.

(Inherited from UIElement)
TransformToVisual(UIElement)

Returns a transform object that can be used to transform coordinates from the UIElement to the specified object.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.TransformToVisual.

(Inherited from UIElement)
TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs)

Attempts to invoke a keyboard shortcut (or accelerator) by searching the entire visual tree of the UIElement for the shortcut.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.TryInvokeKeyboardAccelerator.

(Inherited from UIElement)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)

Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.UnregisterPropertyChangedCallback.

(Inherited from DependencyObject)
UpdateLayout()

Ensures that all positions of child objects of a UIElement are properly updated for layout.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.UpdateLayout.

(Inherited from UIElement)

Events

AccessKeyDisplayDismissed

Occurs when access keys should no longer be displayed.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.AccessKeyDisplayDismissed.

(Inherited from UIElement)
AccessKeyDisplayRequested

Occurs when the user requests that access keys be displayed.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.AccessKeyDisplayRequested.

(Inherited from UIElement)
AccessKeyInvoked

Occurs when a user completes an access key sequence.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.AccessKeyInvoked.

(Inherited from UIElement)
ActualThemeChanged

Occurs when the ActualTheme property value has changed.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.ActualThemeChanged.

(Inherited from FrameworkElement)
BringIntoViewRequested

Occurs when StartBringIntoView is called on this element or one of its descendants.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.BringIntoViewRequested.

(Inherited from UIElement)
CharacterReceived

Occurs when a single, composed character is received by the input queue.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.CharacterReceived.

(Inherited from UIElement)
ContextCanceled

Occurs when a context input gesture continues into a manipulation gesture, to notify the element that the context flyout should not be opened.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ContextCanceled.

(Inherited from UIElement)
ContextRequested

Occurs when the user has completed a context input gesture, such as a right-click.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ContextRequested.

(Inherited from UIElement)
DataContextChanged

Occurs when the value of the FrameworkElement.DataContext property changes.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.DataContextChanged.

(Inherited from FrameworkElement)
DoubleTapped

Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.DoubleTapped.

(Inherited from UIElement)
DragEnter

Occurs when the input system reports an underlying drag event with this element as the target.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.DragEnter.

(Inherited from UIElement)
DragLeave

Occurs when the input system reports an underlying drag event with this element as the origin.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.DragLeave.

(Inherited from UIElement)
DragOver

Occurs when the input system reports an underlying drag event with this element as the potential drop target.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.DragOver.

(Inherited from UIElement)
DragStarting

Occurs when a drag operation is initiated.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.DragStarting.

(Inherited from UIElement)
Drop

Occurs when the input system reports an underlying drop event with this element as the drop target.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.Drop.

(Inherited from UIElement)
DropCompleted

Occurs when a drag-and-drop operation with this element as the source is ended.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.DropCompleted.

(Inherited from UIElement)
EffectiveViewportChanged

Occurs when the FrameworkElement 's effective viewport changes.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.EffectiveViewportChanged.

(Inherited from FrameworkElement)
FocusDisengaged

Occurs when focus is released from the control boundaries (for game pad/remote interaction).

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.Control.FocusDisengaged.

(Inherited from Control)
FocusEngaged

Occurs when focus is constrained within the control boundaries (for game pad/remote interaction).

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.Control.FocusEngaged.

(Inherited from Control)
GettingFocus

Occurs before a UIElement receives focus. This event is raised synchronously to ensure focus isn't moved while the event is bubbling.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.GettingFocus.

(Inherited from UIElement)
GotFocus

Occurs when a UIElement receives focus. This event is raised asynchronously, so focus can move again before bubbling is complete.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.GotFocus.

(Inherited from UIElement)
Holding

Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.Holding.

(Inherited from UIElement)
IsEnabledChanged

Occurs when the IsEnabled property changes.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.Control.IsEnabledChanged.

(Inherited from Control)
KeyDown

Occurs when a keyboard key is pressed while the UIElement has focus.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.KeyDown.

(Inherited from UIElement)
KeyUp

Occurs when a keyboard key is released while the UIElement has focus.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.KeyUp.

(Inherited from UIElement)
LayoutUpdated

Occurs when the layout of the visual tree changes, due to layout-relevant properties changing value or some other action that refreshes the layout.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.LayoutUpdated.

(Inherited from FrameworkElement)
Loaded

Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.Loaded.

(Inherited from FrameworkElement)
Loading

Occurs when a FrameworkElement begins to load.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.Loading.

(Inherited from FrameworkElement)
LosingFocus

Occurs before a UIElement loses focus. This event is raised synchronously to ensure focus isn't moved while the event is bubbling.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.LosingFocus.

(Inherited from UIElement)
LostFocus

Occurs when a UIElement loses focus. This event is raised asynchronously, so focus can move again before bubbling is complete.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.LostFocus.

(Inherited from UIElement)
ManipulationCompleted

Occurs when a manipulation on the UIElement is complete.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ManipulationCompleted.

(Inherited from UIElement)
ManipulationDelta

Occurs when the input device changes position during a manipulation.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ManipulationDelta.

(Inherited from UIElement)
ManipulationInertiaStarting

Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ManipulationInertiaStarting.

(Inherited from UIElement)
ManipulationStarted

Occurs when an input device begins a manipulation on the UIElement.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ManipulationStarted.

(Inherited from UIElement)
ManipulationStarting

Occurs when the manipulation processor is first created.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ManipulationStarting.

(Inherited from UIElement)
NoFocusCandidateFound

Occurs when a user attempts to move focus (via tab or directional arrows), but focus doesn't move because no focus candidate is found in the direction of movement.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.NoFocusCandidateFound.

(Inherited from UIElement)
PaneClosed

Occurs when the SplitView pane is closed.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.SplitView.PaneClosed.

PaneClosing

Occurs when the SplitView pane is closing.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.SplitView.PaneClosing.

PaneOpened

Occurs when the SplitView pane is opened.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.SplitView.PaneOpened.

PaneOpening

Occurs when the SplitView pane is opening.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.SplitView.PaneOpening.

PointerCanceled

Occurs when a pointer that made contact abnormally loses contact.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerCanceled.

(Inherited from UIElement)
PointerCaptureLost

Occurs when pointer capture previously held by this element moves to another element or elsewhere.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerCaptureLost.

(Inherited from UIElement)
PointerEntered

Occurs when a pointer enters the hit test area of this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerEntered.

(Inherited from UIElement)
PointerExited

Occurs when a pointer leaves the hit test area of this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerExited.

(Inherited from UIElement)
PointerMoved

Occurs when a pointer moves while the pointer remains within the hit test area of this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerMoved.

(Inherited from UIElement)
PointerPressed

Occurs when the pointer device initiates a Press action within this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerPressed.

(Inherited from UIElement)
PointerReleased

Occurs when the pointer device that previously initiated a Press action is released, while within this element. Note that the end of a Press action is not guaranteed to fire a PointerReleased event; other events may fire instead. For more info, see Remarks.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerReleased.

(Inherited from UIElement)
PointerWheelChanged

Occurs when the delta value of a pointer wheel changes.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerWheelChanged.

(Inherited from UIElement)
PreviewKeyDown

Occurs when a keyboard key is pressed while the UIElement has focus.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PreviewKeyDown.

(Inherited from UIElement)
PreviewKeyUp

Occurs when a keyboard key is released while the UIElement has focus.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PreviewKeyUp.

(Inherited from UIElement)
ProcessKeyboardAccelerators

Occurs when a keyboard shortcut (or accelerator) is pressed.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ProcessKeyboardAccelerators.

(Inherited from UIElement)
RightTapped

Occurs when a right-tap input stimulus happens while the pointer is over the element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.RightTapped.

(Inherited from UIElement)
SizeChanged

Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.SizeChanged.

(Inherited from FrameworkElement)
Tapped

Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.Tapped.

(Inherited from UIElement)
Unloaded

Occurs when this object is no longer connected to the main object tree.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.Unloaded.

(Inherited from FrameworkElement)

Applies to

See also