Microsoft.UI.Xaml Namespace
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.
Provides general framework APIs for the Windows UI Library (WinUI).
Classes
AdaptiveTrigger |
Represents a declarative rule that applies visual states based on window properties. |
Application |
Represents the current application and its available services. |
ApplicationInitializationCallbackParams |
Represents an object to pass information for a custom initialization sequence. (Obsolete) |
BindingFailedEventArgs |
Provides event data for the DebugSettings.BindingFailed event. |
BringIntoViewOptions |
Represents the options that can be applied when an element is brought into view. |
BringIntoViewRequestedEventArgs |
Provides data for the UIElement.BringIntoViewRequested event. |
BrushTransition |
Provides the animated transition behavior when an element's brush changes. Currently limited to changes between |
ColorPaletteResources |
Represents a specialized resource dictionary that contains color resources used by XAML elements. |
CornerRadiusHelper |
Provides basic utility methods for processing CornerRadius values. C# and Microsoft Visual Basic code should use methods of CornerRadius instead. |
DataContextChangedEventArgs |
Provides data for the DataContextChanged event. |
DataTemplate |
Describes the visual structure of a data object. Use data binding for specific elements in the template that display the data values. |
DataTemplateKey |
Represents the resource key for the DataTemplate class. |
DebugSettings |
Declares how certain aspects of the app behave when it is run in a debug environment |
DependencyObject |
Represents an object that participates in the dependency property system. |
DependencyObjectCollection |
Implements a practical collection class that can contain DependencyObject items. |
DependencyProperty |
Represents a dependency property that is registered with the dependency property system. Dependency properties provide support for value expressions, data binding, animation, and property change notification. For more info on how DependencyProperty values serve as identifiers for dependency properties, see Dependency properties overview. |
DependencyPropertyChangedEventArgs |
Provides data for a PropertyChangedCallback implementation that is invoked when a dependency property changes its value. Also provides event data for the Control.IsEnabledChanged event and any other event that uses the DependencyPropertyChangedEventHandler delegate. |
DispatcherTimer |
Provides a timer that is integrated into the Dispatcher queue, which is processed at a specified interval of time and at a specified priority. |
DragEventArgs |
Provides data for drag-and-drop events. |
DragOperationDeferral |
Enables you to drag-and-drop content with a target app asynchronously. |
DragStartingEventArgs |
Provides event data for the DragStarting event. |
DragUI |
Provides the visual representation of the data being dragged at the start of a drag-and-drop operation. |
DragUIOverride |
Provides the visual representation of the data being dragged during a drag-and-drop operation, including feedback from the drop target. |
DropCompletedEventArgs |
Provides event data for the DropCompleted event. |
DurationHelper |
Provides basic utility methods for processing Duration values. C# and Microsoft Visual Basic code should use methods of Duration instead. |
EffectiveViewportChangedEventArgs |
Provides data for the FrameworkElement.EffectiveViewportChanged event. |
ElementFactoryGetArgs |
Represents the optional arguments to use when calling an implementation of the IElementFactory's GetElement method. |
ElementFactoryRecycleArgs |
Represents the optional arguments to use when calling an implementation of the IElementFactory's RecycleElement method. |
ElementSoundPlayer |
Represents a player for XAML control sounds. |
EventTrigger |
Represents a trigger that applies a set of actions (animation storyboards) in response to an event. Not commonly used. See Remarks. |
ExceptionRoutedEventArgs |
Provides event data for exceptions that are raised as events by asynchronous operations, such as ImageFailed. |
FrameworkElement |
Provides a base element class for Windows Runtime UI objects. |
FrameworkTemplate |
Creates an element tree of elements. FrameworkTemplate is a base class for classes that have specific templating behavior, including ControlTemplate and DataTemplate. |
FrameworkView |
Represents the UI window of an application. |
FrameworkViewSource |
Creates views, specifically FrameworkView instances. This is infrastructure and does not need to be accessed in most app scenarios. |
GridLengthHelper |
Provides helper methods to evaluate or set GridLength values. C# code should use methods of GridLength instead. |
LaunchActivatedEventArgs |
Provides event information for the Application.OnLaunched event. |
MediaFailedRoutedEventArgs |
Provides event data for the MediaElement.MediaFailed event. |
PointHelper |
Provides helper methods to set Point values. C# code should use methods of Point instead. |
PropertyMetadata |
Defines behavior aspects of a dependency property, including conditions it was registered with. For more info on how |
PropertyPath |
Implements a data structure for describing a property as a path below another property, or below an owning type. Property paths are used in data binding to objects. |
RectHelper |
Provides helper methods to evaluate or set Rect values. C# code should use members of Rect instead. |
ResourceDictionary |
Defines a repository for XAML resources, such as styles, that your app uses. You define the resources in XAML and can then retrieve them in XAML using the {StaticResource} markup extension and {ThemeResource} markup extension. You can also access resources with code, but that is less common. |
ResourceManagerRequestedEventArgs |
Provides event data for the |
RoutedEvent |
Represents a routed event to the Windows Runtime event system. |
RoutedEventArgs |
Contains state information and event data associated with a routed event. |
ScalarTransition |
Provides the animated transition behavior when an element's Opacity or Rotation properties change. |
Setter |
Applies a value to a property in a Style or a VisualState. |
SetterBase |
Represents the base class for value setters. |
SetterBaseCollection |
Represents a collection of objects that inherit from SetterBase. |
SizeChangedEventArgs |
Provides data related to the FrameworkElement.SizeChanged event. |
SizeHelper |
Provides helper methods to evaluate or set Size values. C# code should use members of Size instead. |
StateTrigger |
Represents a trigger that applies visual states conditionally. |
StateTriggerBase |
Represents the base class for state triggers. |
Style |
Contains property setters that can be shared between instances of a type. A |
StyleTypedPropertyAttribute |
Represents an attribute that is applied to the class definition and determines the TargetTypes of the properties that are of type Style. |
TargetPropertyPath |
Represents the path to a property on a target element. |
TemplatePartAttribute |
Represents an attribute that is applied to the class definition to identify the types of the named parts that are used for templating. |
TemplateVisualStateAttribute |
Specifies that a control can be in a certain state and that a VisualState is expected in the control's ControlTemplate. |
ThicknessHelper |
Provides helper methods to evaluate or set Thickness values. C# code should use members of Thickness instead. |
TriggerAction |
Serves as the base class for BeginStoryboard. Not commonly used. See Remarks. |
TriggerActionCollection |
Represents a collection of BeginStoryboard objects. |
TriggerBase |
Serves as the base class for EventTrigger. Not commonly used. See Remarks. |
TriggerCollection |
Represents a collection of EventTrigger objects. |
UIElement |
|
UIElementWeakCollection |
Represents a collection of weak references to UIElement objects. |
UnhandledExceptionEventArgs |
Provides data for the UnhandledException event. |
Vector3Transition |
Provides the animated transition behavior when an element's Translation or Scale properties change. |
VisualState |
Represents the visual appearance of a UI element when it is in a specific state. Visual states use Setters or a Storyboard to set UI properties within pages or control templates where the |
VisualStateChangedEventArgs |
Provides data for the CurrentStateChanging and CurrentStateChanged events. |
VisualStateGroup |
Contains mutually exclusive VisualState objects and VisualTransition objects that are used to go from one state to another. |
VisualStateManager |
Manages visual states and the logic for transitions between visual states for controls. Also provides the attached property support for |
VisualTransition |
Represents the visual behavior that occurs when the control transitions from one visual state to another. |
Window |
Represents the window of the current Application. |
WindowActivatedEventArgs |
Contains the window's activation state information returned by the Microsoft.UI.Xaml.Window.Activated event. |
WindowEventArgs |
Contains the window's state information returned by the Window.Closed event. |
WindowSizeChangedEventArgs |
Contains the window's size state information returned by the Window.SizeChanged event. |
WindowVisibilityChangedEventArgs |
Contains the window's visibility state information returned by the Window.VisibilityChanged event. |
XamlResourceReferenceFailedEventArgs |
Provides event data for the |
XamlRoot |
Represents a tree of XAML content and information about the context in which it is hosted. |
XamlRootChangedEventArgs |
Provides data for the XamlRoot.Changed event. |
Structs
CornerRadius |
Describes the characteristics of a rounded corner, such as can be applied to a Border. |
Duration |
Represents the duration of time that a Timeline is active, or more generally represents a duration of time that also supports two special values |
GridLength |
Represents a measurement for control logic that explicitly supports Star (*) sizing and Auto sizing. |
Thickness |
Describes the thickness of a frame around a rectangle. Four Double values describe the Left, Top, Right, and Bottom sides of the rectangle, respectively. |
Interfaces
IDataTemplateExtension |
Defines helper methods for phased rendering of a data template. |
IElementFactory |
Supports the creation and recycling of UIElement objects. |
IXamlServiceProvider |
Defines a mechanism for retrieving a service object; that is, an object that provides custom support to other objects. |
Enums
ApplicationHighContrastAdjustment |
Defines constants that specify whether the framework automatically adjusts visual properties for the app when high contrast themes are enabled. |
ApplicationRequiresPointerMode |
Important Do not use. ApplicationRequiresPointerMode is not supported in the Windows App SDK. Specifies the interaction experiences for non-pointer devices such as a keyboard or game controller. |
ApplicationTheme |
Declares the theme preference for an app. |
AutomationTextAttributesEnum |
Defines constants that identify text attributes of a Microsoft UI Automation text range. |
DispatcherShutdownMode |
Defines constants that specify how an application will shut down. |
DurationType |
Declares whether a Duration has a special value of Automatic or Forever, or has valid information in its |
ElementHighContrastAdjustment |
Defines constants that specify whether the framework automatically adjusts visual properties for an element when high contrast themes are enabled. |
ElementSoundKind |
Defines constants that specify the sound played by the ElementSoundPlayer.Play method. |
ElementSoundMode |
Defines constants that specify a control's preference for whether sounds are played. |
ElementSoundPlayerState |
Defines constants that specify whether XAML controls play sounds. |
ElementSpatialAudioMode |
Defines constants that indicate whether spatial sound is on, off, or handled automatically. |
ElementTheme |
Specifies a UI theme that should be used for individual UIElement parts of an app UI. |
FlowDirection |
Defines constants that specify the content flow direction for text and UI elements. |
FocusState |
Describes how an element obtained focus. |
FocusVisualKind |
Specifies the visual feedback used to indicate the UI element with focus when navigating with a keyboard or game controller. |
FontCapitals |
Describes the capital letter style value for the Typography.Capitals attached property. |
FontEastAsianLanguage |
Provides a mechanism for selecting font-specific versions of glyphs for a specified East Asian writing system or language. |
FontEastAsianWidths |
Provides a mechanism for selecting glyphs of different width styles. |
FontFraction |
Describes a fraction style value for the Typography.Fraction attached property. |
FontNumeralAlignment |
Describes the numeral alignment value for the Typography.NumeralAlignment attached property. |
FontNumeralStyle |
Describes a numeral style value for the Typography.NumeralStyle attached property. |
FontVariants |
Describes a font variant value for the Typography.Variants attached property. |
GridUnitType |
Describes the kind of value that a GridLength object is holding. |
HorizontalAlignment |
Indicates where an element should be displayed on the horizontal axis relative to the allocated layout slot of the parent element. |
LayoutCycleDebugBreakLevel |
Defines constants that specify which level of layout cycle tracing events should trigger a debugger breakpoint when a layout cycle crash appears imminent. |
LayoutCycleTracingLevel |
Defines constants that specify whether layout cycle tracing information is written to the native debugger and the level of detail that is recorded. |
LineStackingStrategy |
Describes the mechanism by which a line box is determined for each line. |
OpticalMarginAlignment |
Specifies how side bearing values in per-character typography are handled when aligning to a text container boundary. |
TextAlignment |
Specifies whether text is centered, left-aligned, or right-aligned. |
TextLineBounds |
Influences how a line box height is calculated |
TextReadingOrder |
Provides a value for |
TextTrimming |
Describes how text is trimmed when it overflows the edge of its containing box. |
TextWrapping |
Specifies whether text wraps when it reaches the edge of its container. |
Vector3TransitionComponents |
Defines constants that specify which axes to animate during the Vector3Transition animation. |
VerticalAlignment |
Describes how a child element is vertically positioned or stretched within a parent's layout slot. |
Visibility |
Specifies the display state of an element. |
WindowActivationState |
Specifies the reasons for an Activated event to be raised on a Window. |
Delegates
ApplicationInitializationCallback |
Represents the callback that should be invoked during the initialization sequence. |
BindingFailedEventHandler |
Represents the method that will handle the DebugSettings.BindingFailed event. |
CreateDefaultValueCallback |
Represents the method that can be invoked as part of a PropertyMetadata constructor to defer definition of a dependency property default value. |
DependencyPropertyChangedCallback |
Represents the callback that is invoked when a property value changes, for property change notifications that are registered with the RegisterPropertyChangedCallback technique. |
DependencyPropertyChangedEventHandler |
Represents the method that will handle events that occur when a DependencyProperty is changed on a particular DependencyObject implementation. |
DragEventHandler |
Represents the method that will handle the DragEnter, DragLeave, DragOver, and Drop events of a UIElement. |
EnteredBackgroundEventHandler |
The handler for the Application.EnteredBackground event. |
ExceptionRoutedEventHandler |
Represents the method that will handle certain events that report exceptions. These exceptions generally come from asynchronous operations. |
LeavingBackgroundEventHandler |
The handler for the Application.LeavingBackground event. |
PropertyChangedCallback |
Represents the callback that is invoked when the effective property value of a dependency property changes. |
RoutedEventHandler |
Represents the method that will handle routed events. |
SizeChangedEventHandler |
Represents the method that will handle the SizeChanged event. |
SuspendingEventHandler |
The handler for the Application.Suspending event. |
UnhandledExceptionEventHandler |
Represents the method that will handle the UnhandledException event. |
VisualStateChangedEventHandler |
Represents the method that will handle the CurrentStateChanging and CurrentStateChanged events. |
Examples
The WinUI 3 Gallery app includes interactive examples of most WinUI 3 controls, features, and functionality. Get the app from the Microsoft Store or get the source code on GitHub.