SwapChainPanel SwapChainPanel SwapChainPanel Class

Definition

Provides a hosting surface, where Microsoft DirectX swap chains provide content that can be rendered into a XAML UI. A SwapChainPanel element is a key component for an app that renders Microsoft DirectX graphics and then presents those visuals within a XAML page.

public : class SwapChainPanel : Grid, ISwapChainPanel
public class SwapChainPanel : Grid, ISwapChainPanel
Public Class SwapChainPanel Inherits Grid Implements ISwapChainPanel
<SwapChainPanel .../>
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

A SwapChainPanel is a Grid subclass, so you can use ColumnDefinitions and RowDefinitions properties to declare the panel's characteristics, and the attached properties of Grid such as Grid.Row and Grid.Column on child elements to position those child elements in the layout.

For code examples that use SwapChainPanel, see XAML SwapChainPanel DirectX interop sample.

The SwapChainPanel class does not inherit from the Control class, so you can't programmatically focus it directly for purposes of capturing key events. Consider setting the focus to a focusable element inside the panel and letting the key event bubble.

In order to maintain crisp vector rendering, you should listen for the CompositionScaleChanged event and query the CompositionScaleX and CompositionScaleY property values to account for the current UI scale, and potentially render again from DirectX. Otherwise XAML layout might do the scaling and your visuals might be degraded.

Initializing a SwapChainPanel element

Before a SwapChainPanel can render content, you must initialize it from the Microsoft DirectX side.

Cast the SwapChainPanel instance to IInspectable or IUnknown, then call QueryInterface to obtain a reference to the ISwapChainPanelNative interface (this is the native interface implementation that is the complement to the SwapChainPanel and enables the interop bridge). Then, call ISwapChainPanelNative::SetSwapChain on that reference to associate your implemented swap chain with the SwapChainPanel instance.

It's common to put the code that queries the interface and sets the swap chain as part of a Create*Resources method. The Create*Resources methods are an implementation pattern that's seen in the Microsoft DirectX Renderer class templates/examples, and you'll also see this implementation pattern in the SDK samples, and in the code you get from the DirectX (XAML) project template in Microsoft Visual Studio. Specifically, in the DirectX (XAML) project template, you'll see the **QueryInterface ** call and the call to ISwapChainPanelNative::SetSwapChain in the DeviceResources::CreateWindowSizeDependentResources method implementation in DeviceResources.cpp.

The API that enables you to add a SwapChain to an existing SwapChainPanel is not a runtime class API, it is a Microsoft DirectX API. You implement the swap chain input as a Microsoft DirectX interface (IDXGISwapChain).

SwapChainPanel and SwapChainBackgroundPanel

SwapChainPanel has less restrictions on its interactions and placement in UI than does SwapChainBackgroundPanel.

Swap chains

  • Swap chains must run on the main UI thread. This is usually accomplished by calling SetSwapChain on a reference that was initialized as a XAML object element.
  • A single swap chain can be associated with multiple SwapChainPanel elements. Or, your app can have multiple swap chains, with each providing the presentation for a separate SwapChainPanel.
  • However, performance can decline if many swap chains are updated simultaneously. We recommend that your app use no more than four swap chains.
  • Content that's rendered via the swap chain is not stretched when it's resized by the user; instead, the resizing behavior is similar to setting Stretch="None" on an Image element.
  • There are other techniques for rendering swap chain content that goes directly to the app's core window rather than a XAML-composed element. See CreateSwapChainForCoreWindow.

Processing input on background threads

Using the CreateCoreIndependentInputSource method, apps can process input and render to a SwapChainPanel entirely on one or more background threads. This enables high performance input and rendering independent of the XAML UI thread.

Constructors

SwapChainPanel() SwapChainPanel() SwapChainPanel()

Initializes a new instance of the SwapChainPanel class.

public : SwapChainPanel()
public SwapChainPanel()
Public Sub New()

Remarks

Important

Initialization through the constructor is not enough to enable the SwapChainPanel element to render the swap chain. You must use a native interface and Microsoft DirectX code. For more info see the "Initializing a SwapChainPanel element" section in the SwapChainPanel class topic.

Properties

AccessKey AccessKey AccessKey

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AccessKeyProperty AccessKeyProperty AccessKeyProperty

Identifies for the AccessKey dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AccessKeyScopeOwner AccessKeyScopeOwner 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.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AccessKeyScopeOwnerProperty AccessKeyScopeOwnerProperty AccessKeyScopeOwnerProperty

Identifies for the AccessKeyScopeOwner dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

ActualHeight ActualHeight ActualHeight

Gets the rendered height of a FrameworkElement. See Remarks.

(Inherited from FrameworkElement)

ActualHeightProperty ActualHeightProperty ActualHeightProperty

Identifies the ActualHeight dependency property. See Remarks.

(Inherited from FrameworkElement)

ActualTheme ActualTheme ActualTheme

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

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

ActualThemeProperty ActualThemeProperty ActualThemeProperty

Identifies the ActualTheme dependency property.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

ActualWidth ActualWidth ActualWidth

Gets the rendered width of a FrameworkElement. See Remarks.

(Inherited from FrameworkElement)

ActualWidthProperty ActualWidthProperty ActualWidthProperty

Identifies the ActualWidth dependency property. See Remarks.

(Inherited from FrameworkElement)

AllowDrop AllowDrop AllowDrop

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

(Inherited from UIElement)

AllowDropProperty AllowDropProperty AllowDropProperty

Identifies the AllowDrop dependency property.

(Inherited from UIElement)

AllowFocusOnInteraction AllowFocusOnInteraction AllowFocusOnInteraction

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

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty

Identifies for the AllowFocusOnInteraction dependency property.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AllowFocusWhenDisabled AllowFocusWhenDisabled AllowFocusWhenDisabled

Gets or sets whether a disabled control can receive focus.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AllowFocusWhenDisabledProperty AllowFocusWhenDisabledProperty AllowFocusWhenDisabledProperty

Identifies the AllowFocusWhenDisabled dependency property.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Background Background Background

Gets or sets a Brush that fills the panel content area.

(Inherited from Panel)

BackgroundProperty BackgroundProperty BackgroundProperty

Identifies the Background dependency property.

(Inherited from Panel)

BaseUri BaseUri 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.

(Inherited from FrameworkElement)

BorderBrush BorderBrush BorderBrush

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

(Inherited from Grid)

BorderBrushProperty BorderBrushProperty BorderBrushProperty

Identifies the BorderBrush dependency property.

(Inherited from Grid)

BorderThickness BorderThickness BorderThickness

Gets or sets the border thickness of the panel.

(Inherited from Grid)

BorderThicknessProperty BorderThicknessProperty BorderThicknessProperty

Identifies the BorderThickness dependency property.

(Inherited from Grid)

CacheMode CacheMode CacheMode

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

(Inherited from UIElement)

CacheModeProperty CacheModeProperty CacheModeProperty

Identifies the CacheMode dependency property.

(Inherited from UIElement)

CanDrag CanDrag CanDrag

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

(Inherited from UIElement)

CanDragProperty CanDragProperty CanDragProperty

Identifies the CanDrag dependency property.

(Inherited from UIElement)

CharacterReceivedEvent CharacterReceivedEvent CharacterReceivedEvent

Gets the identifier for the CharacterReceived routed event.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Children Children Children

Gets the collection of child elements of the panel.

(Inherited from Panel)

ChildrenTransitions ChildrenTransitions ChildrenTransitions

Gets or sets the collection of Transition style elements that apply to child content of a Panel subclass.

(Inherited from Panel)

ChildrenTransitionsProperty ChildrenTransitionsProperty ChildrenTransitionsProperty

Identifies the ChildrenTransitions dependency property.

(Inherited from Panel)

Clip Clip Clip

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

(Inherited from UIElement)

ClipProperty ClipProperty ClipProperty

Identifies the Clip dependency property.

(Inherited from UIElement)

ColumnDefinitions ColumnDefinitions ColumnDefinitions

Gets a list of ColumnDefinition objects defined on this instance of Grid.

(Inherited from Grid)

ColumnProperty ColumnProperty ColumnProperty

Identifies the Grid.Column XAML attached property.

(Inherited from Grid)

ColumnSpacing ColumnSpacing ColumnSpacing

Gets or sets the uniform distance (in pixels) between grid columns.

(Inherited from Grid)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

ColumnSpacingProperty ColumnSpacingProperty ColumnSpacingProperty

Identifies the ColumnSpacing dependency property.

(Inherited from Grid)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

ColumnSpanProperty ColumnSpanProperty ColumnSpanProperty

Identifies the Grid.ColumnSpan XAML attached property.

(Inherited from Grid)

CompositeMode CompositeMode 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.

(Inherited from UIElement)

CompositeModeProperty CompositeModeProperty CompositeModeProperty

Identifies the CompositeMode dependency property.

(Inherited from UIElement)

CompositionScaleX CompositionScaleX CompositionScaleX

Gets the x-axis scale factor of the SwapChainPanel.

public : float CompositionScaleX { get; }
public float CompositionScaleX { get; }
Public ReadOnly Property CompositionScaleX As float
Value
float float float

The x-axis scale factor of the SwapChainPanel. A value of 1.0 means no scaling is applied.

Remarks

The CompositionScaleX scale factor is applied to the swap chain content when it's rendered to the screen and composited into the XAML content. The scale factor is derived from calculating the render transformations (implicit or explicit) applied to the SwapChainPanel and its ancestors.

The scale factor will be an estimate if a Projection property value is present on the SwapChainPanel or one of its ancestors.

Check this property any time you are handling CompositionScaleChanged (CompositionScaleChanged doesn't have event data, but if it fires it means that CompositionScaleX, CompositionScaleY, or both have changed values on this SwapChainPanel ).

See Also

CompositionScaleXProperty CompositionScaleXProperty CompositionScaleXProperty

Identifies the CompositionScaleX dependency property.

public : static DependencyProperty CompositionScaleXProperty { get; }
public static DependencyProperty CompositionScaleXProperty { get; }
Public Static ReadOnly Property CompositionScaleXProperty As DependencyProperty
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the CompositionScaleX dependency property.

CompositionScaleY CompositionScaleY CompositionScaleY

Gets the y-axis scale factor of the SwapChainPanel.

public : float CompositionScaleY { get; }
public float CompositionScaleY { get; }
Public ReadOnly Property CompositionScaleY As float
Value
float float float

The y-axis scale factor of the SwapChainPanel. A value of 1.0 means no scaling is applied.

Remarks

The CompositionScaleY scale factor is applied to the swap chain content when it's rendered to the screen and composited into the XAML content. The scale factor is derived from calculating the render transformations (implicit or explicit) applied to the SwapChainPanel and its ancestors.

The scale factor will be an estimate if a Projection property value is present on the SwapChainPanel or one of its ancestors.

Check this property any time you are handling CompositionScaleChanged (CompositionScaleChanged doesn't have event data, but if it fires it means that CompositionScaleX, CompositionScaleY, or both have changed values on this SwapChainPanel ).

See Also

CompositionScaleYProperty CompositionScaleYProperty CompositionScaleYProperty

Identifies the CompositionScaleY dependency property.

public : static DependencyProperty CompositionScaleYProperty { get; }
public static DependencyProperty CompositionScaleYProperty { get; }
Public Static ReadOnly Property CompositionScaleYProperty As DependencyProperty
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the CompositionScaleY dependency property.

ContextFlyout ContextFlyout ContextFlyout

Gets or sets the flyout associated with this element.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

ContextFlyoutProperty ContextFlyoutProperty ContextFlyoutProperty

Identifies for the ContextFlyout dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

CornerRadius CornerRadius CornerRadius

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

(Inherited from Grid)

CornerRadiusProperty CornerRadiusProperty CornerRadiusProperty

Identifies the CornerRadius dependency property.

(Inherited from Grid)

DataContext DataContext DataContext

Gets or sets the data context for a FrameworkElement when it participates in data binding.

(Inherited from FrameworkElement)

DataContextProperty DataContextProperty DataContextProperty

Identifies the DataContext dependency property.

(Inherited from FrameworkElement)

DesiredSize DesiredSize DesiredSize

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

(Inherited from UIElement)

Dispatcher Dispatcher 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.

(Inherited from DependencyObject)

DoubleTappedEvent DoubleTappedEvent DoubleTappedEvent

Gets the identifier for the DoubleTapped routed event.

(Inherited from UIElement)

DragEnterEvent DragEnterEvent DragEnterEvent

Gets the identifier for the DragEnter routed event.

(Inherited from UIElement)

DragLeaveEvent DragLeaveEvent DragLeaveEvent

Gets the identifier for the DragLeave routed event.

(Inherited from UIElement)

DragOverEvent DragOverEvent DragOverEvent

Gets the identifier for the DragOver routed event.

(Inherited from UIElement)

DropEvent DropEvent DropEvent

Gets the identifier for the Drop routed event.

(Inherited from UIElement)

ExitDisplayModeOnAccessKeyInvoked ExitDisplayModeOnAccessKeyInvoked ExitDisplayModeOnAccessKeyInvoked

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

ExitDisplayModeOnAccessKeyInvokedProperty ExitDisplayModeOnAccessKeyInvokedProperty ExitDisplayModeOnAccessKeyInvokedProperty

Identifies the ExitDisplayModeOnAccessKeyInvoked dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FlowDirection FlowDirection 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.

(Inherited from FrameworkElement)

FlowDirectionProperty FlowDirectionProperty FlowDirectionProperty

Identifies the FlowDirection dependency property.

(Inherited from FrameworkElement)

FocusVisualMargin FocusVisualMargin FocusVisualMargin

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

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusVisualMarginProperty FocusVisualMarginProperty FocusVisualMarginProperty

Identifies the FocusVisualMargin dependency property.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusVisualPrimaryBrush FocusVisualPrimaryBrush FocusVisualPrimaryBrush

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

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusVisualPrimaryBrushProperty FocusVisualPrimaryBrushProperty FocusVisualPrimaryBrushProperty

Identifies the FocusVisualPrimaryBrush dependency property.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusVisualPrimaryThickness FocusVisualPrimaryThickness FocusVisualPrimaryThickness

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

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusVisualPrimaryThicknessProperty FocusVisualPrimaryThicknessProperty FocusVisualPrimaryThicknessProperty

Identifies the FocusVisualPrimaryThickness dependency property.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusVisualSecondaryBrush FocusVisualSecondaryBrush FocusVisualSecondaryBrush

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

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusVisualSecondaryBrushProperty FocusVisualSecondaryBrushProperty FocusVisualSecondaryBrushProperty

Identifies the FocusVisualSecondaryBrush dependency property.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusVisualSecondaryThickness FocusVisualSecondaryThickness FocusVisualSecondaryThickness

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

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusVisualSecondaryThicknessProperty FocusVisualSecondaryThicknessProperty FocusVisualSecondaryThicknessProperty

Identifies the FocusVisualSecondaryThickness dependency property.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

GettingFocusEvent GettingFocusEvent GettingFocusEvent

Gets the identifier for the GettingFocus routed event.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Height Height Height

Gets or sets the suggested height of a FrameworkElement.

(Inherited from FrameworkElement)

HeightProperty HeightProperty HeightProperty

Identifies the Height dependency property.

(Inherited from FrameworkElement)

HighContrastAdjustment HighContrastAdjustment HighContrastAdjustment

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

HighContrastAdjustmentProperty HighContrastAdjustmentProperty HighContrastAdjustmentProperty

Identifies the HighContrastAdjustment dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

HoldingEvent HoldingEvent HoldingEvent

Gets the identifier for the Holding routed event.

(Inherited from UIElement)

HorizontalAlignment HorizontalAlignment 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.

(Inherited from FrameworkElement)

HorizontalAlignmentProperty HorizontalAlignmentProperty HorizontalAlignmentProperty

Identifies the HorizontalAlignment dependency property.

(Inherited from FrameworkElement)

IsAccessKeyScope IsAccessKeyScope IsAccessKeyScope

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

IsAccessKeyScopeProperty IsAccessKeyScopeProperty IsAccessKeyScopeProperty

Identifies for the IsAccessKeyScope dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

IsDoubleTapEnabled IsDoubleTapEnabled IsDoubleTapEnabled

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

(Inherited from UIElement)

IsDoubleTapEnabledProperty IsDoubleTapEnabledProperty IsDoubleTapEnabledProperty

Identifies the IsDoubleTapEnabled dependency property.

(Inherited from UIElement)

IsHitTestVisible IsHitTestVisible IsHitTestVisible

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

(Inherited from UIElement)

IsHitTestVisibleProperty IsHitTestVisibleProperty IsHitTestVisibleProperty

Identifies the IsHitTestVisible dependency property.

(Inherited from UIElement)

IsHoldingEnabled IsHoldingEnabled IsHoldingEnabled

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

(Inherited from UIElement)

IsHoldingEnabledProperty IsHoldingEnabledProperty IsHoldingEnabledProperty

Identifies the IsHoldingEnabled dependency property.

(Inherited from UIElement)

IsItemsHost IsItemsHost IsItemsHost

Gets a value that indicates whether this Panel is a container for UI items that are generated by an ItemsControl.

(Inherited from Panel)

IsItemsHostProperty IsItemsHostProperty IsItemsHostProperty

Identifies the IsItemsHost dependency property.

(Inherited from Panel)

IsRightTapEnabled IsRightTapEnabled IsRightTapEnabled

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

(Inherited from UIElement)

IsRightTapEnabledProperty IsRightTapEnabledProperty IsRightTapEnabledProperty

Identifies the IsRightTapEnabled dependency property.

(Inherited from UIElement)

IsTapEnabled IsTapEnabled IsTapEnabled

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

(Inherited from UIElement)

IsTapEnabledProperty IsTapEnabledProperty IsTapEnabledProperty

Identifies the IsTapEnabled dependency property.

(Inherited from UIElement)

KeyDownEvent KeyDownEvent KeyDownEvent

Gets the identifier for the KeyDown routed event.

(Inherited from UIElement)

KeyTipHorizontalOffset KeyTipHorizontalOffset KeyTipHorizontalOffset

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

KeyTipHorizontalOffsetProperty KeyTipHorizontalOffsetProperty KeyTipHorizontalOffsetProperty

Identifies the KeyTipHorizontalOffset dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

KeyTipPlacementMode KeyTipPlacementMode KeyTipPlacementMode

Gets or sets a value that indicates where the KeyTip is placed in relation to the UIElement.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

KeyTipPlacementModeProperty KeyTipPlacementModeProperty KeyTipPlacementModeProperty

Identifies the KeyTipPlacementMode dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

KeyTipVerticalOffset KeyTipVerticalOffset KeyTipVerticalOffset

Gets or sets a value that indicates how far up or down the keytip is placed in relation to the UIElement.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

KeyTipVerticalOffsetProperty KeyTipVerticalOffsetProperty KeyTipVerticalOffsetProperty

Identifies the KeyTipVerticalOffset dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

KeyUpEvent KeyUpEvent KeyUpEvent

Gets the identifier for the KeyUp routed event.

(Inherited from UIElement)

KeyboardAccelerators KeyboardAccelerators KeyboardAccelerators

Gets the keyboard shortcuts (or accelerators) that lets a user perform an action using the keyboard instead of navigating the app UI (directly or through access keys).

Accelerators are typically assigned to buttons or menu items.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Language Language 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.

(Inherited from FrameworkElement)

LanguageProperty LanguageProperty LanguageProperty

Identifies the Language dependency property.

(Inherited from FrameworkElement)

Lights Lights Lights

Gets the collection of XamlLight objects attached to this element.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

LightsProperty LightsProperty LightsProperty

Identifies the Lights dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

LosingFocusEvent LosingFocusEvent LosingFocusEvent

Gets the identifier for the LosingFocus routed event.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

ManipulationCompletedEvent ManipulationCompletedEvent ManipulationCompletedEvent

Gets the identifier for the ManipulationCompleted routed event.

(Inherited from UIElement)

ManipulationDeltaEvent ManipulationDeltaEvent ManipulationDeltaEvent

Gets the identifier for the ManipulationDelta routed event.

(Inherited from UIElement)

ManipulationInertiaStartingEvent ManipulationInertiaStartingEvent ManipulationInertiaStartingEvent

Gets the identifier for the ManipulationInertiaStarting routed event.

(Inherited from UIElement)

ManipulationMode ManipulationMode 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.

(Inherited from UIElement)

ManipulationModeProperty ManipulationModeProperty ManipulationModeProperty

Identifies the ManipulationMode dependency property.

(Inherited from UIElement)

ManipulationStartedEvent ManipulationStartedEvent ManipulationStartedEvent

Gets the identifier for the ManipulationStarted routed event.

(Inherited from UIElement)

ManipulationStartingEvent ManipulationStartingEvent ManipulationStartingEvent

Gets the identifier for the ManipulationStarting routed event.

(Inherited from UIElement)

Margin Margin Margin

Gets or sets the outer margin of a FrameworkElement.

(Inherited from FrameworkElement)

MarginProperty MarginProperty MarginProperty

Identifies the Margin dependency property.

(Inherited from FrameworkElement)

MaxHeight MaxHeight MaxHeight

Gets or sets the maximum height constraint of a FrameworkElement.

(Inherited from FrameworkElement)

MaxHeightProperty MaxHeightProperty MaxHeightProperty

Identifies the MaxHeight dependency property.

(Inherited from FrameworkElement)

MaxWidth MaxWidth MaxWidth

Gets or sets the maximum width constraint of a FrameworkElement.

(Inherited from FrameworkElement)

MaxWidthProperty MaxWidthProperty MaxWidthProperty

Identifies the MaxWidth dependency property.

(Inherited from FrameworkElement)

MinHeight MinHeight MinHeight

Gets or sets the minimum height constraint of a FrameworkElement.

(Inherited from FrameworkElement)

MinHeightProperty MinHeightProperty MinHeightProperty

Identifies the MinHeight dependency property.

(Inherited from FrameworkElement)

MinWidth MinWidth MinWidth

Gets or sets the minimum width constraint of a FrameworkElement.

(Inherited from FrameworkElement)

MinWidthProperty MinWidthProperty MinWidthProperty

Identifies the MinWidth dependency property.

(Inherited from FrameworkElement)

Name Name 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.

(Inherited from FrameworkElement)

NameProperty NameProperty NameProperty

Identifies the Name dependency property.

(Inherited from FrameworkElement)

NoFocusCandidateFoundEvent NoFocusCandidateFoundEvent NoFocusCandidateFoundEvent

Gets the identifier for the NoFocusCandidateFound routed event.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Opacity Opacity Opacity

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

(Inherited from UIElement)

OpacityProperty OpacityProperty OpacityProperty

Identifies the IsHitTestVisible dependency property.

(Inherited from UIElement)

Padding Padding Padding

Gets or sets the distance between the border and its child object.

(Inherited from Grid)

PaddingProperty PaddingProperty PaddingProperty

Identifies the Padding dependency property.

(Inherited from Grid)

Parent Parent Parent

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

(Inherited from FrameworkElement)

PointerCanceledEvent PointerCanceledEvent PointerCanceledEvent

Gets the identifier for the PointerCanceled routed event.

(Inherited from UIElement)

PointerCaptureLostEvent PointerCaptureLostEvent PointerCaptureLostEvent

Gets the identifier for the PointerCaptureLost routed event.

(Inherited from UIElement)

PointerCaptures PointerCaptures PointerCaptures

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

(Inherited from UIElement)

PointerCapturesProperty PointerCapturesProperty PointerCapturesProperty

Identifies the PointerCaptures dependency property.

(Inherited from UIElement)

PointerEnteredEvent PointerEnteredEvent PointerEnteredEvent

Gets the identifier for the PointerEntered routed event.

(Inherited from UIElement)

PointerExitedEvent PointerExitedEvent PointerExitedEvent

Gets the identifier for the PointerExited routed event.

(Inherited from UIElement)

PointerMovedEvent PointerMovedEvent PointerMovedEvent

Gets the identifier for the PointerMoved routed event.

(Inherited from UIElement)

PointerPressedEvent PointerPressedEvent PointerPressedEvent

Gets the identifier for the PointerPressed routed event.

(Inherited from UIElement)

PointerReleasedEvent PointerReleasedEvent PointerReleasedEvent

Gets the identifier for the PointerReleased routed event.

(Inherited from UIElement)

PointerWheelChangedEvent PointerWheelChangedEvent PointerWheelChangedEvent

Gets the identifier for the PointerWheelChanged routed event.

(Inherited from UIElement)

PreviewKeyDownEvent PreviewKeyDownEvent PreviewKeyDownEvent

Gets the identifier for the PreviewKeyDown routed event.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

PreviewKeyUpEvent PreviewKeyUpEvent PreviewKeyUpEvent

Gets the identifier for the PreviewKeyUp routed event.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Projection Projection Projection

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

(Inherited from UIElement)

ProjectionProperty ProjectionProperty ProjectionProperty

Identifies the Projection dependency property.

(Inherited from UIElement)

RenderSize RenderSize RenderSize

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

(Inherited from UIElement)

RenderTransform RenderTransform RenderTransform

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

(Inherited from UIElement)

RenderTransformOrigin RenderTransformOrigin RenderTransformOrigin

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

(Inherited from UIElement)

RenderTransformOriginProperty RenderTransformOriginProperty RenderTransformOriginProperty

Identifies the RenderTransformOrigin dependency property.

(Inherited from UIElement)

RenderTransformProperty RenderTransformProperty RenderTransformProperty

Identifies the RenderTransform dependency property.

(Inherited from UIElement)

RequestedTheme RequestedTheme 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.

(Inherited from FrameworkElement)

RequestedThemeProperty RequestedThemeProperty RequestedThemeProperty

Identifies the RequestedTheme dependency property.

(Inherited from FrameworkElement)

Resources Resources 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.

(Inherited from FrameworkElement)

RightTappedEvent RightTappedEvent RightTappedEvent

Gets the identifier for the RightTapped routed event.

(Inherited from UIElement)

RowDefinitions RowDefinitions RowDefinitions

Gets a list of RowDefinition objects defined on this instance of Grid.

(Inherited from Grid)

RowProperty RowProperty RowProperty

Identifies the Grid.Row XAML attached property.

(Inherited from Grid)

RowSpacing RowSpacing RowSpacing

Gets or sets the uniform distance (in pixels) between grid rows.

(Inherited from Grid)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

RowSpacingProperty RowSpacingProperty RowSpacingProperty

Identifies the RowSpacing dependency property.

(Inherited from Grid)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

RowSpanProperty RowSpanProperty RowSpanProperty

Identifies the Grid.RowSpan XAML attached property.

(Inherited from Grid)

Style Style Style

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

(Inherited from FrameworkElement)

StyleProperty StyleProperty StyleProperty

Identifies the Style dependency property.

(Inherited from FrameworkElement)

TabFocusNavigation TabFocusNavigation TabFocusNavigation

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, use this property of the UIElement base class instead of the TabNavigation property of a Control object.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

TabFocusNavigationProperty TabFocusNavigationProperty TabFocusNavigationProperty

Identifies the TabFocusNavigation dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Tag Tag Tag

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

(Inherited from FrameworkElement)

TagProperty TagProperty TagProperty

Identifies the Tag dependency property.

(Inherited from FrameworkElement)

TappedEvent TappedEvent TappedEvent

Gets the identifier for the Tapped routed event.

(Inherited from UIElement)

Transform3D Transform3D Transform3D

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

(Inherited from UIElement)

Transform3DProperty Transform3DProperty Transform3DProperty

Identifies the Transform3D dependency property.

(Inherited from UIElement)

Transitions Transitions Transitions

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

(Inherited from UIElement)

TransitionsProperty TransitionsProperty TransitionsProperty

Identifies the Transitions dependency property.

(Inherited from UIElement)

Triggers Triggers Triggers

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

(Inherited from FrameworkElement)

UseLayoutRounding UseLayoutRounding 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.

(Inherited from UIElement)

UseLayoutRoundingProperty UseLayoutRoundingProperty UseLayoutRoundingProperty

Identifies the UseLayoutRounding dependency property.

(Inherited from UIElement)

VerticalAlignment VerticalAlignment 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.

(Inherited from FrameworkElement)

VerticalAlignmentProperty VerticalAlignmentProperty VerticalAlignmentProperty

Identifies the VerticalAlignment dependency property.

(Inherited from FrameworkElement)

Visibility Visibility 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.

(Inherited from UIElement)

VisibilityProperty VisibilityProperty VisibilityProperty

Identifies the Visibility dependency property.

(Inherited from UIElement)

Width Width Width

Gets or sets the width of a FrameworkElement.

(Inherited from FrameworkElement)

WidthProperty WidthProperty WidthProperty

Identifies the Width dependency property.

(Inherited from FrameworkElement)

XYFocusDownNavigationStrategy XYFocusDownNavigationStrategy XYFocusDownNavigationStrategy

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusDownNavigationStrategyProperty XYFocusDownNavigationStrategyProperty XYFocusDownNavigationStrategyProperty

Identifies the XYFocusDownNavigationStrategy dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusKeyboardNavigation XYFocusKeyboardNavigation XYFocusKeyboardNavigation

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusKeyboardNavigationProperty XYFocusKeyboardNavigationProperty XYFocusKeyboardNavigationProperty

Identifies the XYFocusKeyboardNavigation dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusLeftNavigationStrategy XYFocusLeftNavigationStrategy XYFocusLeftNavigationStrategy

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusLeftNavigationStrategyProperty XYFocusLeftNavigationStrategyProperty XYFocusLeftNavigationStrategyProperty

Identifies the XYFocusLeftNavigationStrategy dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusRightNavigationStrategy XYFocusRightNavigationStrategy XYFocusRightNavigationStrategy

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusRightNavigationStrategyProperty XYFocusRightNavigationStrategyProperty XYFocusRightNavigationStrategyProperty

Identifies the XYFocusRightNavigationStrategy dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusUpNavigationStrategy XYFocusUpNavigationStrategy XYFocusUpNavigationStrategy

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusUpNavigationStrategyProperty XYFocusUpNavigationStrategyProperty XYFocusUpNavigationStrategyProperty

Identifies the XYFocusUpNavigationStrategy dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Methods

AddHandler(RoutedEvent,Object,Boolean) AddHandler(RoutedEvent,Object,Boolean) 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.

(Inherited from UIElement)

Arrange(Rect) Arrange(Rect) 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.

(Inherited from UIElement)

ArrangeOverride(Size) ArrangeOverride(Size) ArrangeOverride(Size)

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

(Inherited from FrameworkElement)

CancelDirectManipulations CancelDirectManipulations CancelDirectManipulations

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

(Inherited from UIElement)

CapturePointer(Pointer) CapturePointer(Pointer) CapturePointer(Pointer)

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

(Inherited from UIElement)

ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Clears the local value of a dependency property.

(Inherited from DependencyObject)

CreateCoreIndependentInputSource(CoreInputDeviceTypes) CreateCoreIndependentInputSource(CoreInputDeviceTypes) CreateCoreIndependentInputSource(CoreInputDeviceTypes)

Creates a core input object that handles the input types as specified by the deviceTypes parameter. This core input object can process input events on a background thread.

public : CoreIndependentInputSource CreateCoreIndependentInputSource(CoreInputDeviceTypes deviceTypes)
public CoreIndependentInputSource CreateCoreIndependentInputSource(CoreInputDeviceTypes deviceTypes)
Public Function CreateCoreIndependentInputSource(deviceTypes As CoreInputDeviceTypes) As CoreIndependentInputSource
Parameters
deviceTypes
CoreInputDeviceTypes CoreInputDeviceTypes CoreInputDeviceTypes

A combined value of the enumeration.

Returns

An object that represents the input subsystem for interoperation purposes and can be used for input event connection points.

Remarks

This method enables an app that includes a SwapChainPanel to handle input and rendering independent of the XAML UI thread, because you're deliberately providing the input processing logic on a background thread. You must call CreateCoreIndependentInputSource from a non-UI thread, otherwise this method will fail.

Use the CreateCoreIndependentInputSource method to create a core input object and associate it with your SwapChainPanel. Upon successful creation, user input of the specified device types that accesses SwapChainPanel contents will be redirected to the thread that CreateCoreIndependentInputSource was called from. Your app can handle this input by registering for input events and processing those events on a background thread. In order to receive input messages through the CoreIndependentInputSource object, the app code must set a swap chain on the SwapChainPanel, and render (at a Microsoft DirectX level) from this swap chain at least once. That provides the rendering that makes hit testing possible.

You typically use CoreDispatcher::ProcessEvents as part of the event handling. Get a CoreDispatcher reference from CoreIndependentInputSource::Dispatcher. For more info on how to use background threads, see ThreadPool or Threading and async programming.

You can call CreateCoreIndependentInputSource multiple times. Each time CreateCoreIndependentInputSource is called, the previous CoreIndependentInputSource object is disassociated with the SwapChainPanel. In other words, only one CoreIndependentInputSource object can get events at a time.

For example code of how to use CreateCoreIndependentInputSource, see the DrawingPanel class definition that is part of the XAML SwapChainPanel DirectX interop sample.

CreateCoreIndependentInputSource d can return null if deviceTypes was passed as CoreInputDeviceTypes.None (that's not a typical way to call CreateCoreIndependentInputSource though).

See Also

DeferTree(DependencyObject) DeferTree(DependencyObject) DeferTree(DependencyObject)

Removes the specified element from the XAML visual tree in a way that it can be undeferred later.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

FindName(String) FindName(String) FindName(String)

Retrieves an object that has the specified identifier name.

(Inherited from FrameworkElement)

FindSubElementsForTouchTargeting(Point,Rect) FindSubElementsForTouchTargeting(Point,Rect) FindSubElementsForTouchTargeting(Point,Rect)

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

(Inherited from UIElement)

GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty)

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

(Inherited from DependencyObject)

GetBindingExpression(DependencyProperty) GetBindingExpression(DependencyProperty) GetBindingExpression(DependencyProperty)

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

(Inherited from FrameworkElement)

GetChildrenInTabFocusOrder GetChildrenInTabFocusOrder GetChildrenInTabFocusOrder

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

GetColumn(FrameworkElement) GetColumn(FrameworkElement) GetColumn(FrameworkElement)

Gets the value of the Grid.Column XAML attached property from the specified FrameworkElement.

(Inherited from Grid)

GetColumnSpan(FrameworkElement) GetColumnSpan(FrameworkElement) GetColumnSpan(FrameworkElement)

Gets the value of the Grid.ColumnSpan XAML attached property from the specified FrameworkElement.

(Inherited from Grid)

GetRow(FrameworkElement) GetRow(FrameworkElement) GetRow(FrameworkElement)

Gets the value of the Grid.Row XAML attached property from the specified FrameworkElement.

(Inherited from Grid)

GetRowSpan(FrameworkElement) GetRowSpan(FrameworkElement) GetRowSpan(FrameworkElement)

Gets the value of the Grid.RowSpan XAML attached property from the specified FrameworkElement.

(Inherited from Grid)

GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

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

(Inherited from DependencyObject)

GoToElementStateCore(String,Boolean) GoToElementStateCore(String,Boolean) 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.

(Inherited from FrameworkElement)

InvalidateArrange InvalidateArrange InvalidateArrange

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

(Inherited from UIElement)

InvalidateMeasure InvalidateMeasure InvalidateMeasure

Invalidates the measurement state (layout) for a UIElement.

(Inherited from UIElement)

Measure(Size) Measure(Size) 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.

(Inherited from UIElement)

MeasureOverride(Size) MeasureOverride(Size) 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.

(Inherited from FrameworkElement)

OnApplyTemplate OnApplyTemplate 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.

(Inherited from FrameworkElement)

OnCreateAutomationPeer OnCreateAutomationPeer OnCreateAutomationPeer

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

(Inherited from UIElement)

OnDisconnectVisualChildren OnDisconnectVisualChildren OnDisconnectVisualChildren

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

(Inherited from UIElement)

OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs)

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

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

(Inherited from DependencyObject)

RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback)

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

(Inherited from DependencyObject)

ReleasePointerCapture(Pointer) ReleasePointerCapture(Pointer) ReleasePointerCapture(Pointer)

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

(Inherited from UIElement)

ReleasePointerCaptures ReleasePointerCaptures ReleasePointerCaptures

Releases all pointer captures held by this element.

(Inherited from UIElement)

RemoveHandler(RoutedEvent,Object) RemoveHandler(RoutedEvent,Object) RemoveHandler(RoutedEvent,Object)

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

(Inherited from UIElement)

SetBinding(DependencyProperty,BindingBase) SetBinding(DependencyProperty,BindingBase) SetBinding(DependencyProperty,BindingBase)

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

.

(Inherited from FrameworkElement)

SetColumn(FrameworkElement,Int32) SetColumn(FrameworkElement,Int32) SetColumn(FrameworkElement,Int32)

Sets the value of the Grid.Column XAML attached property on the specified FrameworkElement.

(Inherited from Grid)

SetColumnSpan(FrameworkElement,Int32) SetColumnSpan(FrameworkElement,Int32) SetColumnSpan(FrameworkElement,Int32)

Sets the value of the Grid.ColumnSpan XAML attached property on the specified FrameworkElement.

(Inherited from Grid)

SetRow(FrameworkElement,Int32) SetRow(FrameworkElement,Int32) SetRow(FrameworkElement,Int32)

Sets the value of the Grid.Row XAML attached property on the specified FrameworkElement.

(Inherited from Grid)

SetRowSpan(FrameworkElement,Int32) SetRowSpan(FrameworkElement,Int32) SetRowSpan(FrameworkElement,Int32)

Sets the value of the Grid.RowSpan XAML attached property on the specified FrameworkElement.

(Inherited from Grid)

SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object)

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

(Inherited from DependencyObject)

StartBringIntoView StartBringIntoView StartBringIntoView

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

StartBringIntoView(BringIntoViewOptions) StartBringIntoView(BringIntoViewOptions) StartBringIntoView(BringIntoViewOptions)

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

StartDragAsync(PointerPoint) StartDragAsync(PointerPoint) StartDragAsync(PointerPoint)

Initiates a drag-and-drop operation.

(Inherited from UIElement)

TransformToVisual(UIElement) TransformToVisual(UIElement) TransformToVisual(UIElement)

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

(Inherited from UIElement)

TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs)

Attempts to invoke a keyboard shortcut (accelerator).

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

TryStartDirectManipulation(Pointer) TryStartDirectManipulation(Pointer) TryStartDirectManipulation(Pointer)

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

(Inherited from UIElement)

UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64)

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

(Inherited from DependencyObject)

UpdateLayout UpdateLayout UpdateLayout

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

(Inherited from UIElement)

Events

AccessKeyDisplayDismissed AccessKeyDisplayDismissed AccessKeyDisplayDismissed

Occurs when the access key sequence is complete to notify controls that they should hide access key visuals.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AccessKeyDisplayRequested AccessKeyDisplayRequested AccessKeyDisplayRequested

Occurs when the access key sequence is started to notify controls that they should show access key visuals.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AccessKeyInvoked AccessKeyInvoked AccessKeyInvoked

Occurs when a user completes an access key sequence to notify the element that the access key action should be invoked.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

ActualThemeChanged ActualThemeChanged ActualThemeChanged

Occurs when the ActualTheme property value has changed.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

CharacterReceived CharacterReceived CharacterReceived

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

CompositionScaleChanged CompositionScaleChanged CompositionScaleChanged

Occurs when the composition scale factor of the SwapChainPanel has changed.

public : event TypedEventHandler CompositionScaleChanged<SwapChainPanel, object>
public event TypedEventHandler CompositionScaleChanged<SwapChainPanel, object>
Public Event TypedEventHandler CompositionScaleChanged( Of ( Of SwapChainPanel ), ( Of object ))
<SwapChainPanel CompositionScaleChanged="eventhandler"/>

Remarks

The supplier of the swap chain content might need to resize their content if a layout pass determines a new size for the panel or containers it's within, or if a RenderTransform is applied on the SwapChainPanel or any of its ancestors. Changes of this nature aren't always originated by app logic that's easy to detect from other events (for example the user might change a device orientation or a view state that causes layout to rerun), so this event provides a notification specifically for the scenario of changing the swap chain content size, which would typically invert the scale factors applied.

Check CompositionScaleX and CompositionScaleY any time you are handling CompositionScaleChanged (CompositionScaleChanged doesn't have event data, but if it fires it means that one or both properties have changed values on this SwapChainPanel ).

This event fires asynchronously versus the originating change. For example, dynamic animations or manipulations might affect the scale factor, and the event is raised when those dynamic changes are completed.

ContextCanceled ContextCanceled ContextCanceled

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

ContextRequested ContextRequested ContextRequested

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

DataContextChanged DataContextChanged DataContextChanged

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

(Inherited from FrameworkElement)

DoubleTapped DoubleTapped DoubleTapped

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

(Inherited from UIElement)

DragEnter DragEnter DragEnter

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

(Inherited from UIElement)

DragLeave DragLeave DragLeave

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

(Inherited from UIElement)

DragOver DragOver DragOver

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

(Inherited from UIElement)

DragStarting DragStarting DragStarting

Occurs when a drag operation is initiated.

(Inherited from UIElement)

Drop Drop Drop

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

(Inherited from UIElement)

DropCompleted DropCompleted DropCompleted

Occurs when a drag-and-drop operation is ended.

(Inherited from UIElement)

GettingFocus GettingFocus GettingFocus

Occurs before a UIElement receives focus.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

GotFocus GotFocus GotFocus

Occurs when a UIElement receives focus.

(Inherited from UIElement)

Holding Holding Holding

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

(Inherited from UIElement)

KeyDown KeyDown KeyDown

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

(Inherited from UIElement)

KeyUp KeyUp KeyUp

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

(Inherited from UIElement)

LayoutUpdated LayoutUpdated 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.

(Inherited from FrameworkElement)

Loaded Loaded Loaded

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

(Inherited from FrameworkElement)

Loading Loading Loading

Occurs when a FrameworkElement begins to load.

(Inherited from FrameworkElement)

LosingFocus LosingFocus LosingFocus

Occurs before a UIElement loses focus.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

LostFocus LostFocus LostFocus

Occurs when a UIElement loses focus.

(Inherited from UIElement)

ManipulationCompleted ManipulationCompleted ManipulationCompleted

Occurs when a manipulation on the UIElement is complete.

(Inherited from UIElement)

ManipulationDelta ManipulationDelta ManipulationDelta

Occurs when the input device changes position during a manipulation.

(Inherited from UIElement)

ManipulationInertiaStarting ManipulationInertiaStarting ManipulationInertiaStarting

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

(Inherited from UIElement)

ManipulationStarted ManipulationStarted ManipulationStarted

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

(Inherited from UIElement)

ManipulationStarting ManipulationStarting ManipulationStarting

Occurs when the manipulation processor is first created.

(Inherited from UIElement)

NoFocusCandidateFound NoFocusCandidateFound 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.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

PointerCanceled PointerCanceled PointerCanceled

Occurs when a pointer that made contact abnormally loses contact.

(Inherited from UIElement)

PointerCaptureLost PointerCaptureLost PointerCaptureLost

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

(Inherited from UIElement)

PointerEntered PointerEntered PointerEntered

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

(Inherited from UIElement)

PointerExited PointerExited PointerExited

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

(Inherited from UIElement)

PointerMoved PointerMoved PointerMoved

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

(Inherited from UIElement)

PointerPressed PointerPressed PointerPressed

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

(Inherited from UIElement)

PointerReleased PointerReleased 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.

(Inherited from UIElement)

PointerWheelChanged PointerWheelChanged PointerWheelChanged

Occurs when the delta value of a pointer wheel changes.

(Inherited from UIElement)

PreviewKeyDown PreviewKeyDown PreviewKeyDown

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

PreviewKeyUp PreviewKeyUp PreviewKeyUp

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

ProcessKeyboardAccelerators ProcessKeyboardAccelerators ProcessKeyboardAccelerators

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

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

RightTapped RightTapped RightTapped

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

(Inherited from UIElement)

SizeChanged SizeChanged SizeChanged

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

(Inherited from FrameworkElement)

Tapped Tapped Tapped

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

(Inherited from UIElement)

Unloaded Unloaded Unloaded

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

(Inherited from FrameworkElement)

See Also