ElementCompositionPreview Class

Reference

Definition

Namespace:: Windows.UI.Xaml.Hosting

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Enables access to composition visual objects that back XAML elements in the XAML composition tree.

public ref class ElementCompositionPreview sealed

/// [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)]
class ElementCompositionPreview final

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 131072)]
class ElementCompositionPreview final

[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)]
public sealed class ElementCompositionPreview

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 131072)]
public sealed class ElementCompositionPreview

Public NotInheritable Class ElementCompositionPreview

Inheritance: Object Platform::Object IInspectable ElementCompositionPreview

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

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

Remarks

ElementCompositionPreview allows access to the Windows.UI.Composition.Visual object backing a XAML element with the GetElementVisual method. Once the backing object has been retrieved it can be manipulated using the Windows.UI.Composition namespace. This allows properties of the object to be changed, like the orientation, or additional objects to be added to the XAML composition tree.

Version history

Windows version	SDK version	Value added
1703	15063	GetPointerPositionPropertySet
1703	15063	SetImplicitHideAnimation
1703	15063	SetImplicitShowAnimation
1703	15063	SetIsTranslationEnabled
1903	18362	GetAppWindowContent
1903	18362	SetAppWindowContent

Methods

GetAppWindowContent(AppWindow)	Retrieves the content root of an AppWindow.
GetContainerVisual(UIElement)	Retrieves the Windows.UI.Composition.Visual object that backs a XAML container in the XAML composition tree.
GetElementChildVisual(UIElement)	Retrieves a Windows.UI.Composition.Visual object previously set by a call to SetElementChildVisual.
GetElementVisual(UIElement)	Retrieves the Windows.UI.Composition.Visual object that backs a XAML element in the XAML composition tree.
GetPointerPositionPropertySet(UIElement)	Retrieves the pointer position relative to a UIElement.
GetScrollViewerManipulationPropertySet(ScrollViewer)	Retrieves the composition properties of a ScrollViewer element.
SetAppWindowContent(AppWindow, UIElement)	Sets a XAML UIElement as the content root of an AppWindow.
SetElementChildVisual(UIElement, Visual)	Sets a custom Windows.UI.Composition.Visual as the last child of the element’s visual tree.
SetImplicitHideAnimation(UIElement, ICompositionAnimationBase)	Associates the specified hide animation with a UIElement.
SetImplicitShowAnimation(UIElement, ICompositionAnimationBase)	Associates the specified show animation with a UIElement.
SetIsTranslationEnabled(UIElement, Boolean)	Toggles the ability to set, animate, and use a render-time post-layout translate transform to position XAML elements on screen using Composition APIs.

Applies to

Jaa