Frame Frame Frame Class

Definition

Displays Page instances, supports navigation to new pages, and maintains a navigation history to support forward and backward navigation.

class Frame : ContentControl, INavigate
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.IFrameFactory), Windows.Foundation.Metadata.CompositionType.Public, 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.IFrameStatics2), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.IFrameStatics), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.IFrameFactory), Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.IFrameStatics2), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.IFrameStatics), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.IFrameStatics5), 458752, "Windows.Foundation.UniversalApiContract")]
public class Frame : ContentControl, INavigate
Public Class Frame
Inherits ContentControl
Implements INavigate
<Frame .../>
Inheritance
Attributes
Implements

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1.0)

Examples

The following code example is from the Blank App template in Microsoft Visual Studio. This code shows how an OnLaunched method override initializes the app window. If the app is resuming after being suspended, then the window might already be initialized. If not, this code sets the app window to a new Frame, then navigates the frame to the default initial page.

protected override void OnLaunched(LaunchActivatedEventArgs e)
{
    Frame rootFrame = Window.Current.Content as Frame;

    // Do not repeat app initialization when the Window already has content,
    // just ensure that the window is active.
    if (rootFrame == null)
    {
        // Create a Frame to act as the navigation context and navigate to the first page.
        rootFrame = new Frame();

        rootFrame.NavigationFailed += OnNavigationFailed;

        if (e.PreviousExecutionState == ApplicationExecutionState.Terminated)
        {
            //TODO: Load state from previously suspended application.
        }

        // Place the frame in the current Window.
        Window.Current.Content = rootFrame;
    }

    if (rootFrame.Content == null)
    {
        // When the navigation stack isn't restored navigate to the first page,
        // configuring the new page by passing required information as a navigation
        // parameter.
        rootFrame.Navigate(typeof(MainPage), e.Arguments);
    }

    // Ensure the current window is active.
    Window.Current.Activate();
}

void OnNavigationFailed(object sender, NavigationFailedEventArgs e)
{
    throw new Exception("Failed to load Page " + e.SourcePageType.FullName);
}
void App::OnLaunched(LaunchActivatedEventArgs const& e)
{
    Frame rootFrame{ nullptr };
    auto content = Window::Current().Content();
    if (content)
    {
        rootFrame = content.try_as<Frame>();
    }

    // Do not repeat app initialization when the Window already has content,
    // just ensure that the window is active
    if (rootFrame == nullptr)
    {
        // Create a Frame to act as the navigation context and associate it with
        // a SuspensionManager key
        rootFrame = Frame();

        rootFrame.NavigationFailed({ this, &App::OnNavigationFailed });

        if (e.PreviousExecutionState() == ApplicationExecutionState::Terminated)
        {
            // Restore the saved session state only when appropriate, scheduling the
            // final launch steps after the restore is complete
        }

        if (e.PrelaunchActivated() == false)
        {
            if (rootFrame.Content() == nullptr)
            {
                // When the navigation stack isn't restored navigate to the first page,
                // configuring the new page by passing required information as a navigation
                // parameter
                rootFrame.Navigate(xaml_typename<BlankApp1::MainPage>(), box_value(e.Arguments()));
            }
            // Place the frame in the current Window
            Window::Current().Content(rootFrame);
            // Ensure the current window is active
            Window::Current().Activate();
        }
    }
    else
    {
        if (e.PrelaunchActivated() == false)
        {
            if (rootFrame.Content() == nullptr)
            {
                // When the navigation stack isn't restored navigate to the first page,
                // configuring the new page by passing required information as a navigation
                // parameter
                rootFrame.Navigate(xaml_typename<BlankApp1::MainPage>(), box_value(e.Arguments()));
            }
            // Ensure the current window is active
            Window::Current().Activate();
        }
    }
}

void App::OnNavigationFailed(IInspectable const&, NavigationFailedEventArgs const& e)
{
    throw hresult_error(E_FAIL, hstring(L"Failed to load Page ") + e.SourcePageType().Name);
}
void App::OnLaunched(LaunchActivatedEventArgs^ e)
{
 auto rootFrame = dynamic_cast<Frame^>(Window::Current->Content);
 
 // Do not repeat app initialization when the Window already has content,
 // just ensure that the window is active
 if (rootFrame == nullptr)
 {
  // Create a Frame to act as the navigation context and associate it with
  // a SuspensionManager key
  rootFrame = ref new Frame();

  rootFrame->NavigationFailed += ref new Windows::UI::Xaml::Navigation::NavigationFailedEventHandler(this, &App::OnNavigationFailed);

  if (e->PreviousExecutionState == ApplicationExecutionState::Terminated)
  {
   // TODO: Restore the saved session state only when appropriate, scheduling the
   // final launch steps after the restore is complete
  }

  if (rootFrame->Content == nullptr)
  {
   // When the navigation stack isn't restored navigate to the first page,
   // configuring the new page by passing required information as a navigation
   // parameter
   rootFrame->Navigate(TypeName(MainPage::typeid), e->Arguments);
  }
  // Place the frame in the current Window
  Window::Current->Content = rootFrame;
  // Ensure the current window is active
  Window::Current->Activate();
 }
 else
 {
  if (rootFrame->Content == nullptr)
  {
   // When the navigation stack isn't restored navigate to the first page,
   // configuring the new page by passing required information as a navigation
   // parameter
   rootFrame->Navigate(TypeName(MainPage::typeid), e->Arguments);
  }
  // Ensure the current window is active
  Window::Current->Activate();
 }
}

void App::OnNavigationFailed(Platform::Object ^sender, Windows::UI::Xaml::Navigation::NavigationFailedEventArgs ^e)
{
 throw ref new FailureException("Failed to load Page " + e->SourcePageType.Name);
}
Protected Overrides Sub OnLaunched(e As LaunchActivatedEventArgs)
    Dim rootFrame As Frame = TryCast(Window.Current.Content, Frame)

    ' Do not repeat app initialization when the Window already has content,
    ' just ensure that the window is active.

    If rootFrame Is Nothing Then
        ' Create a Frame to act as the navigation context and navigate to the first page.
        rootFrame = New Frame()

        AddHandler rootFrame.NavigationFailed, AddressOf OnNavigationFailed

        If e.PreviousExecutionState = ApplicationExecutionState.Terminated Then
            ' TODO: Load state from previously suspended application.
        End If
        ' Place the frame in the current Window.
        Window.Current.Content = rootFrame
    End If
    If rootFrame.Content Is Nothing Then
        ' When the navigation stack isn't restored navigate to the first page,
        ' configuring the new page by passing required information as a navigation
        ' parameter.
        rootFrame.Navigate(GetType(MainPage), e.Arguments)
    End If

    ' Ensure the current window is active.
    Window.Current.Activate()
End Sub

Private Sub OnNavigationFailed(sender As Object, e As NavigationFailedEventArgs)
    Throw New Exception("Failed to load Page " + e.SourcePageType.FullName)
End Sub

For a complete sample that uses many of the Page and Frame features together, see XAML Navigation sample.

Remarks

You use the Frame control to support navigation to Page instances. You create as many different page types as needed to present the content in your app, and then navigate to those pages by calling the Navigate method and passing in the type of the page to navigate to. You can also pass in a parameter object to initialize the page to a particular state.

The frame maintains a history of pages it has navigated to. You can get the type of the current page through the CurrentSourcePageType property, and navigate forward or backward with the GoBack and GoForward methods. The CanGoBack and CanGoForward properties indicate whether a page is available in the desired direction. One common practice is to bind the IsEnabled properties of navigation buttons to CanGoBack and CanGoForward so that users can't navigate to a page that doesn't exist.

You can handle the Navigating, Navigated, NavigationStopped, and NavigationFailed events to perform high-level tasks such as starting and stopping a "navigation in progress" animation or displaying an error message. For page-level tasks, override the page OnNavigatedTo, OnNavigatingFrom, and OnNavigatedFrom methods. This is useful to perform tasks such as initializing and saving the page state.

By default, each navigation creates a new instance of the specific Page subclass requested, and disposes the previous page instance. This happens even when navigating back to a previously visited page or when the new page type is the same as the previous page type. Apps that involve frequent navigation to the same pages can cache and reuse the page instances to make navigation more efficient. To do this, set the CacheSize property to specify how many pages to cache. For each page type that you want to cache, you must also set the Page.NavigationCacheMode property to either Enabled or Required. Pages with a Required cache mode are cached regardless of the CacheSize value, and do not count against the CacheSize total.

INavigate

The INavigate interface is mainly infrastructure. It's not expected that typical app will implement this interface.

Version history

Windows version SDK version Value added
1703 15063 SetNavigationState(String,Boolean)
1809 17763 IsNavigationStackEnabled
1809 17763 NavigateToType

Constructors

Frame() Frame() Frame()

Initializes a new instance of the Frame class.

Properties

AccessKey AccessKey AccessKey

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

(Inherited from UIElement)
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)
ActualHeight ActualHeight ActualHeight

Gets the rendered height of a FrameworkElement. See Remarks.

(Inherited from FrameworkElement)
ActualOffset ActualOffset ActualOffset

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

(Inherited from UIElement)
ActualSize ActualSize ActualSize

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

(Inherited from UIElement)
ActualTheme ActualTheme ActualTheme

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

(Inherited from FrameworkElement)
ActualWidth ActualWidth ActualWidth

Gets the rendered width of a FrameworkElement. 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)
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)
AllowFocusWhenDisabled AllowFocusWhenDisabled AllowFocusWhenDisabled

Gets or sets whether a disabled control can receive focus.

(Inherited from FrameworkElement)
Background Background Background

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

(Inherited from Control)
BackgroundSizing BackgroundSizing BackgroundSizing

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

(Inherited from Control)
BackStack BackStack BackStack

Gets a collection of PageStackEntry instances representing the backward navigation history of the Frame.

BackStackDepth BackStackDepth BackStackDepth

Gets the number of entries in the navigation back stack.

BackStackDepthProperty BackStackDepthProperty BackStackDepthProperty

Identifies the BackStackDepth dependency property.

BackStackProperty BackStackProperty BackStackProperty

Identifies the BackStack dependency property.

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 a control.

(Inherited from Control)
BorderThickness BorderThickness BorderThickness

Gets or sets the border thickness of a control.

(Inherited from Control)
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)
CacheSize CacheSize CacheSize

Gets or sets the number of pages in the navigation history that can be cached for the frame.

CacheSizeProperty CacheSizeProperty CacheSizeProperty

Identifies the CacheSize dependency property.

CanBeScrollAnchor CanBeScrollAnchor CanBeScrollAnchor

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

(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)
CanGoBack CanGoBack CanGoBack

Gets a value that indicates whether there is at least one entry in back navigation history.

CanGoBackProperty CanGoBackProperty CanGoBackProperty

Identifies the CanGoBack dependency property.

CanGoForward CanGoForward CanGoForward

Gets a value that indicates whether there is at least one entry in forward navigation history.

CanGoForwardProperty CanGoForwardProperty CanGoForwardProperty

Identifies the CanGoForward dependency property.

CenterPoint CenterPoint CenterPoint

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

(Inherited from UIElement)
CharacterSpacing CharacterSpacing CharacterSpacing

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

(Inherited from Control)
Clip Clip Clip

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

(Inherited from UIElement)
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)
Content Content Content

Gets or sets the content of a ContentControl.

(Inherited from ContentControl)
ContentTemplate ContentTemplate ContentTemplate

Gets or sets the data template that is used to display the content of the ContentControl.

(Inherited from ContentControl)
ContentTemplateRoot ContentTemplateRoot ContentTemplateRoot

Gets the root element of the data template specified by the ContentTemplate property.

(Inherited from ContentControl)
ContentTemplateSelector ContentTemplateSelector ContentTemplateSelector

Gets or sets a selection object that changes the DataTemplate to apply for content, based on processing information about the content item or its container at run time.

(Inherited from ContentControl)
ContentTransitions ContentTransitions ContentTransitions

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

(Inherited from ContentControl)
ContextFlyout ContextFlyout ContextFlyout

Gets or sets the flyout associated with this element.

(Inherited from UIElement)
CornerRadius CornerRadius CornerRadius

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

(Inherited from Control)
CurrentSourcePageType CurrentSourcePageType CurrentSourcePageType

Gets a type reference for the content that is currently displayed.

CurrentSourcePageTypeProperty CurrentSourcePageTypeProperty CurrentSourcePageTypeProperty

Identifies the CurrentSourcePageType dependency property.

DataContext DataContext DataContext

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

(Inherited from FrameworkElement)
DefaultStyleKey DefaultStyleKey DefaultStyleKey

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

(Inherited from Control)
DefaultStyleResourceUri DefaultStyleResourceUri DefaultStyleResourceUri

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

(Inherited from Control)
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)
ElementSoundMode ElementSoundMode ElementSoundMode

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

(Inherited from Control)
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)
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)
FocusState FocusState FocusState

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

(Inherited from Control)
FocusVisualMargin FocusVisualMargin FocusVisualMargin

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

(Inherited from FrameworkElement)
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)
FocusVisualPrimaryThickness FocusVisualPrimaryThickness FocusVisualPrimaryThickness

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

(Inherited from FrameworkElement)
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)
FocusVisualSecondaryThickness FocusVisualSecondaryThickness FocusVisualSecondaryThickness

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

(Inherited from FrameworkElement)
FontFamily FontFamily FontFamily

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

(Inherited from Control)
FontSize FontSize FontSize

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

(Inherited from Control)
FontStretch FontStretch FontStretch

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

(Inherited from Control)
FontStyle FontStyle FontStyle

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

(Inherited from Control)
FontWeight FontWeight FontWeight

Gets or sets the thickness of the specified font.

(Inherited from Control)
Foreground Foreground Foreground

Gets or sets a brush that describes the foreground color.

(Inherited from Control)
ForwardStack ForwardStack ForwardStack

Gets a collection of PageStackEntry instances representing the forward navigation history of the Frame.

ForwardStackProperty ForwardStackProperty ForwardStackProperty

Identifies the ForwardStack dependency property.

Height Height Height

Gets or sets the suggested height of a FrameworkElement.

(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)
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)
HorizontalContentAlignment HorizontalContentAlignment HorizontalContentAlignment

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

(Inherited from Control)
IsAccessKeyScope IsAccessKeyScope IsAccessKeyScope

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

(Inherited from UIElement)
IsDoubleTapEnabled IsDoubleTapEnabled IsDoubleTapEnabled

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

(Inherited from UIElement)
IsEnabled IsEnabled IsEnabled

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

(Inherited from Control)
IsFocusEngaged IsFocusEngaged IsFocusEngaged

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

(Inherited from Control)
IsFocusEngagementEnabled IsFocusEngagementEnabled IsFocusEngagementEnabled

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

(Inherited from Control)
IsHitTestVisible IsHitTestVisible IsHitTestVisible

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

(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)
IsLoaded IsLoaded IsLoaded

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

(Inherited from FrameworkElement)
IsNavigationStackEnabled IsNavigationStackEnabled IsNavigationStackEnabled

Gets or sets a value that indicates whether navigation is recorded in the Frame's ForwardStack or BackStack.

IsNavigationStackEnabledProperty IsNavigationStackEnabledProperty IsNavigationStackEnabledProperty

Identifies the IsNavigationStackEnabled dependency property.

IsRightTapEnabled IsRightTapEnabled IsRightTapEnabled

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

(Inherited from UIElement)
IsTabStop IsTabStop IsTabStop

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

(Inherited from Control)
IsTapEnabled IsTapEnabled IsTapEnabled

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

(Inherited from UIElement)
IsTextScaleFactorEnabled IsTextScaleFactorEnabled IsTextScaleFactorEnabled

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

(Inherited from Control)
KeyboardAcceleratorPlacementMode KeyboardAcceleratorPlacementMode KeyboardAcceleratorPlacementMode

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

(Inherited from UIElement)
KeyboardAcceleratorPlacementTarget KeyboardAcceleratorPlacementTarget KeyboardAcceleratorPlacementTarget

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

(Inherited from UIElement)
KeyboardAccelerators KeyboardAccelerators KeyboardAccelerators

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

Accelerators are typically assigned to buttons or menu items.

Example of a menu showing keyboard accelerators for various menu items

Example of a menu showing keyboard accelerators for various menu items

(Inherited from UIElement)
KeyTipHorizontalOffset KeyTipHorizontalOffset KeyTipHorizontalOffset

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

(Inherited from UIElement)
KeyTipPlacementMode KeyTipPlacementMode KeyTipPlacementMode

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

(Inherited from UIElement)
KeyTipTarget KeyTipTarget KeyTipTarget

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

(Inherited from UIElement)
KeyTipVerticalOffset KeyTipVerticalOffset KeyTipVerticalOffset

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

(Inherited from UIElement)
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)
Lights Lights Lights

Gets the collection of XamlLight objects attached to this element.

(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)
Margin Margin Margin

Gets or sets the outer margin of a FrameworkElement.

(Inherited from FrameworkElement)
MaxHeight MaxHeight MaxHeight

Gets or sets the maximum height constraint of a FrameworkElement.

(Inherited from FrameworkElement)
MaxWidth MaxWidth MaxWidth

Gets or sets the maximum width constraint of a FrameworkElement.

(Inherited from FrameworkElement)
MinHeight MinHeight MinHeight

Gets or sets the minimum height constraint of a FrameworkElement.

(Inherited from FrameworkElement)
MinWidth MinWidth MinWidth

Gets or sets the minimum width constraint of a FrameworkElement.

(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)
Opacity Opacity Opacity

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

(Inherited from UIElement)
OpacityTransition OpacityTransition OpacityTransition

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

(Inherited from UIElement)
Padding Padding Padding

Gets or sets the padding inside a control.

(Inherited from Control)
Parent Parent Parent

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

(Inherited from FrameworkElement)
PointerCaptures PointerCaptures PointerCaptures

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

(Inherited from UIElement)
Projection Projection Projection

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

(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)
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)
RequiresPointer RequiresPointer RequiresPointer

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

(Inherited from Control)
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)
Rotation Rotation Rotation

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

(Inherited from UIElement)
RotationAxis RotationAxis RotationAxis

Gets or sets the axis to rotate the element around.

(Inherited from UIElement)
RotationTransition RotationTransition RotationTransition

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

(Inherited from UIElement)
Scale Scale Scale

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

(Inherited from UIElement)
ScaleTransition ScaleTransition ScaleTransition

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

(Inherited from UIElement)
Shadow Shadow Shadow

Gets or sets the shadow effect cast by the element.

(Inherited from UIElement)
SourcePageType SourcePageType SourcePageType

Gets or sets a type reference of the current content, or the content that should be navigated to.

SourcePageTypeProperty SourcePageTypeProperty SourcePageTypeProperty

Identifies the SourcePageType dependency property.

Style Style Style

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

(Inherited from FrameworkElement)
TabFocusNavigation TabFocusNavigation TabFocusNavigation

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

(Inherited from UIElement)
TabIndex TabIndex TabIndex

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

(Inherited from Control)
TabNavigation TabNavigation TabNavigation

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

Note

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

(Inherited from Control)
Tag Tag Tag

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

(Inherited from FrameworkElement)
Template Template Template

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

(Inherited from Control)
Transform3D Transform3D Transform3D

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

(Inherited from UIElement)
TransformMatrix TransformMatrix TransformMatrix

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

(Inherited from UIElement)
Transitions Transitions Transitions

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

(Inherited from UIElement)
Translation Translation Translation

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

(Inherited from UIElement)
TranslationTransition TranslationTransition TranslationTransition

Gets or sets the Vector3Transition that animates changes to the Translation 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)
UIContext UIContext UIContext

Gets the context identifier for the element.

(Inherited from UIElement)
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)
UseSystemFocusVisuals UseSystemFocusVisuals UseSystemFocusVisuals

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

(Inherited from Control)
VerticalAlignment 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)
VerticalContentAlignment VerticalContentAlignment VerticalContentAlignment

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

(Inherited from Control)
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)
Width Width Width

Gets or sets the width of a FrameworkElement.

(Inherited from FrameworkElement)
XamlRoot XamlRoot XamlRoot

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

(Inherited from UIElement)
XYFocusDown XYFocusDown XYFocusDown

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

(Inherited from Control)
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)
XYFocusKeyboardNavigation XYFocusKeyboardNavigation XYFocusKeyboardNavigation

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

(Inherited from UIElement)
XYFocusLeft XYFocusLeft XYFocusLeft

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

(Inherited from Control)
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)
XYFocusRight XYFocusRight XYFocusRight

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

(Inherited from Control)
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)
XYFocusUp XYFocusUp XYFocusUp

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

(Inherited from Control)
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)

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)
ApplyTemplate() ApplyTemplate() ApplyTemplate()

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

(Inherited from Control)
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)
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)
Focus(FocusState) Focus(FocusState) Focus(FocusState)

Attempts to set the focus on the control.

(Inherited from Control)
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)
GetNavigationState() GetNavigationState() GetNavigationState()

Serializes the Frame navigation history into a string.

GetTemplateChild(String) GetTemplateChild(String) GetTemplateChild(String)

Retrieves the named element in the instantiated ControlTemplate visual tree.

(Inherited from Control)
GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

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

(Inherited from DependencyObject)
GoBack() GoBack() GoBack()

Navigates to the most recent item in back navigation history, if a Frame manages its own navigation history.

GoBack(NavigationTransitionInfo) GoBack(NavigationTransitionInfo) GoBack(NavigationTransitionInfo)

Navigates to the most recent item in back navigation history, if a Frame manages its own navigation history, and specifies the animated transition to use.

GoForward() GoForward() GoForward()

Navigates to the most recent item in forward navigation history, if a Frame manages its own navigation history.

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)
InvalidateViewport() InvalidateViewport() InvalidateViewport()

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

(Inherited from FrameworkElement)
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)
Navigate(Type) Navigate(Type) Navigate(Type)

Causes the Frame to load content represented by the specified Page.

Navigate(Type, Object) Navigate(Type, Object) Navigate(Type, Object)

Causes the Frame to load content represented by the specified Page, also passing a parameter to be interpreted by the target of the navigation.

Navigate(Type, Object, NavigationTransitionInfo) Navigate(Type, Object, NavigationTransitionInfo) Navigate(Type, Object, NavigationTransitionInfo)

Causes the Frame to load content represented by the specified Page -derived data type, also passing a parameter to be interpreted by the target of the navigation, and a value indicating the animated transition to use.

NavigateToType(Type, Object, FrameNavigationOptions) NavigateToType(Type, Object, FrameNavigationOptions) NavigateToType(Type, Object, FrameNavigationOptions)

Causes the Frame to load content represented by the specified Page, also passing a parameter to be interpreted by the target of the navigation.

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)
OnBringIntoViewRequested(BringIntoViewRequestedEventArgs) OnBringIntoViewRequested(BringIntoViewRequestedEventArgs) OnBringIntoViewRequested(BringIntoViewRequestedEventArgs)

Called before the BringIntoViewRequested event occurs.

(Inherited from UIElement)
OnCharacterReceived(CharacterReceivedRoutedEventArgs) OnCharacterReceived(CharacterReceivedRoutedEventArgs) OnCharacterReceived(CharacterReceivedRoutedEventArgs)

Called before the CharacterReceived event occurs.

(Inherited from Control)
OnContentChanged(Object, Object) OnContentChanged(Object, Object) OnContentChanged(Object, Object)

Invoked when the value of the Content property changes.

(Inherited from ContentControl)
OnContentTemplateChanged(DataTemplate, DataTemplate) OnContentTemplateChanged(DataTemplate, DataTemplate) OnContentTemplateChanged(DataTemplate, DataTemplate)

Invoked when the value of the ContentTemplate property changes.

(Inherited from ContentControl)
OnContentTemplateSelectorChanged(DataTemplateSelector, DataTemplateSelector) OnContentTemplateSelectorChanged(DataTemplateSelector, DataTemplateSelector) OnContentTemplateSelectorChanged(DataTemplateSelector, DataTemplateSelector)

Invoked when the value of the ContentTemplateSelector property changes.

(Inherited from ContentControl)
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)
OnDoubleTapped(DoubleTappedRoutedEventArgs) OnDoubleTapped(DoubleTappedRoutedEventArgs) OnDoubleTapped(DoubleTappedRoutedEventArgs)

Called before the DoubleTapped event occurs.

(Inherited from Control)
OnDragEnter(DragEventArgs) OnDragEnter(DragEventArgs) OnDragEnter(DragEventArgs)

Called before the DragEnter event occurs.

(Inherited from Control)
OnDragLeave(DragEventArgs) OnDragLeave(DragEventArgs) OnDragLeave(DragEventArgs)

Called before the DragLeave event occurs.

(Inherited from Control)
OnDragOver(DragEventArgs) OnDragOver(DragEventArgs) OnDragOver(DragEventArgs)

Called before the DragOver event occurs.

(Inherited from Control)
OnDrop(DragEventArgs) OnDrop(DragEventArgs) OnDrop(DragEventArgs)

Called before the Drop event occurs.

(Inherited from Control)
OnGotFocus(RoutedEventArgs) OnGotFocus(RoutedEventArgs) OnGotFocus(RoutedEventArgs)

Called before the GotFocus event occurs.

(Inherited from Control)
OnHolding(HoldingRoutedEventArgs) OnHolding(HoldingRoutedEventArgs) OnHolding(HoldingRoutedEventArgs)

Called before the Holding event occurs.

(Inherited from Control)
OnKeyboardAcceleratorInvoked(KeyboardAcceleratorInvokedEventArgs) OnKeyboardAcceleratorInvoked(KeyboardAcceleratorInvokedEventArgs) OnKeyboardAcceleratorInvoked(KeyboardAcceleratorInvokedEventArgs)

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

(Inherited from UIElement)
OnKeyDown(KeyRoutedEventArgs) OnKeyDown(KeyRoutedEventArgs) OnKeyDown(KeyRoutedEventArgs)

Called before the KeyDown event occurs.

(Inherited from Control)
OnKeyUp(KeyRoutedEventArgs) OnKeyUp(KeyRoutedEventArgs) OnKeyUp(KeyRoutedEventArgs)

Called before the KeyUp event occurs.

(Inherited from Control)
OnLostFocus(RoutedEventArgs) OnLostFocus(RoutedEventArgs) OnLostFocus(RoutedEventArgs)

Called before the LostFocus event occurs.

(Inherited from Control)
OnManipulationCompleted(ManipulationCompletedRoutedEventArgs) OnManipulationCompleted(ManipulationCompletedRoutedEventArgs) OnManipulationCompleted(ManipulationCompletedRoutedEventArgs)

Called before the ManipulationCompleted event occurs.

(Inherited from Control)
OnManipulationDelta(ManipulationDeltaRoutedEventArgs) OnManipulationDelta(ManipulationDeltaRoutedEventArgs) OnManipulationDelta(ManipulationDeltaRoutedEventArgs)

Called before the ManipulationDelta event occurs.

(Inherited from Control)
OnManipulationInertiaStarting(ManipulationInertiaStartingRoutedEventArgs) OnManipulationInertiaStarting(ManipulationInertiaStartingRoutedEventArgs) OnManipulationInertiaStarting(ManipulationInertiaStartingRoutedEventArgs)

Called before the ManipulationInertiaStarting event occurs.

(Inherited from Control)
OnManipulationStarted(ManipulationStartedRoutedEventArgs) OnManipulationStarted(ManipulationStartedRoutedEventArgs) OnManipulationStarted(ManipulationStartedRoutedEventArgs)

Called before the ManipulationStarted event occurs.

(Inherited from Control)
OnManipulationStarting(ManipulationStartingRoutedEventArgs) OnManipulationStarting(ManipulationStartingRoutedEventArgs) OnManipulationStarting(ManipulationStartingRoutedEventArgs)

Called before the ManipulationStarting event occurs.

(Inherited from Control)
OnPointerCanceled(PointerRoutedEventArgs) OnPointerCanceled(PointerRoutedEventArgs) OnPointerCanceled(PointerRoutedEventArgs)

Called before the PointerCanceled event occurs.

(Inherited from Control)
OnPointerCaptureLost(PointerRoutedEventArgs) OnPointerCaptureLost(PointerRoutedEventArgs) OnPointerCaptureLost(PointerRoutedEventArgs)

Called before the PointerCaptureLost event occurs.

(Inherited from Control)
OnPointerEntered(PointerRoutedEventArgs) OnPointerEntered(PointerRoutedEventArgs) OnPointerEntered(PointerRoutedEventArgs)

Called before the PointerEntered event occurs.

(Inherited from Control)
OnPointerExited(PointerRoutedEventArgs) OnPointerExited(PointerRoutedEventArgs) OnPointerExited(PointerRoutedEventArgs)

Called before the PointerExited event occurs.

(Inherited from Control)
OnPointerMoved(PointerRoutedEventArgs) OnPointerMoved(PointerRoutedEventArgs) OnPointerMoved(PointerRoutedEventArgs)

Called before the PointerMoved event occurs.

(Inherited from Control)
OnPointerPressed(PointerRoutedEventArgs) OnPointerPressed(PointerRoutedEventArgs) OnPointerPressed(PointerRoutedEventArgs)

Called before the PointerPressed event occurs.

(Inherited from Control)
OnPointerReleased(PointerRoutedEventArgs) OnPointerReleased(PointerRoutedEventArgs) OnPointerReleased(PointerRoutedEventArgs)

Called before the PointerReleased event occurs.

(Inherited from Control)
OnPointerWheelChanged(PointerRoutedEventArgs) OnPointerWheelChanged(PointerRoutedEventArgs) OnPointerWheelChanged(PointerRoutedEventArgs)

Called before the PointerWheelChanged event occurs.

(Inherited from Control)
OnPreviewKeyDown(KeyRoutedEventArgs) OnPreviewKeyDown(KeyRoutedEventArgs) OnPreviewKeyDown(KeyRoutedEventArgs)

Called before the PreviewKeyDown event occurs.

(Inherited from Control)
OnPreviewKeyUp(KeyRoutedEventArgs) OnPreviewKeyUp(KeyRoutedEventArgs) OnPreviewKeyUp(KeyRoutedEventArgs)

Called before the PreviewKeyUp event occurs.

(Inherited from Control)
OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs)

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

(Inherited from UIElement)
OnRightTapped(RightTappedRoutedEventArgs) OnRightTapped(RightTappedRoutedEventArgs) OnRightTapped(RightTappedRoutedEventArgs)

Called before the RightTapped event occurs.

(Inherited from Control)
OnTapped(TappedRoutedEventArgs) OnTapped(TappedRoutedEventArgs) OnTapped(TappedRoutedEventArgs)

Called before the Tapped event occurs.

(Inherited from Control)
PopulatePropertyInfo(String, AnimationPropertyInfo) PopulatePropertyInfo(String, AnimationPropertyInfo) PopulatePropertyInfo(String, AnimationPropertyInfo)

Defines a property that can be animated.

(Inherited from UIElement)
PopulatePropertyInfoOverride(String, AnimationPropertyInfo) PopulatePropertyInfoOverride(String, AnimationPropertyInfo) PopulatePropertyInfoOverride(String, AnimationPropertyInfo)

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

(Inherited from UIElement)
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)
RemoveFocusEngagement() RemoveFocusEngagement() RemoveFocusEngagement()

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

(Inherited from Control)
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)
SetNavigationState(String) SetNavigationState(String) SetNavigationState(String)

Reads and restores the navigation history of a Frame from a provided serialization string.

SetNavigationState(String, Boolean) SetNavigationState(String, Boolean) SetNavigationState(String, Boolean)

Reads and restores the navigation history of a Frame from a provided serialization string.

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

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

(Inherited from DependencyObject)
StartAnimation(ICompositionAnimationBase) StartAnimation(ICompositionAnimationBase) StartAnimation(ICompositionAnimationBase)

Begins the specified animation on the element.

(Inherited from UIElement)
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)
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)
StartDragAsync(PointerPoint) StartDragAsync(PointerPoint) StartDragAsync(PointerPoint)

Initiates a drag-and-drop operation.

(Inherited from UIElement)
StopAnimation(ICompositionAnimationBase) StopAnimation(ICompositionAnimationBase) StopAnimation(ICompositionAnimationBase)

Stops the specified animation on the element.

(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 (or accelerator) by searching the entire visual tree of the UIElement for the shortcut.

(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 access keys should no longer be displayed.

(Inherited from UIElement)
AccessKeyDisplayRequested AccessKeyDisplayRequested AccessKeyDisplayRequested

Occurs when the user requests that access keys be displayed.

(Inherited from UIElement)
AccessKeyInvoked AccessKeyInvoked AccessKeyInvoked

Occurs when a user completes an access key sequence.

(Inherited from UIElement)
ActualThemeChanged ActualThemeChanged ActualThemeChanged

Occurs when the ActualTheme property value has changed.

(Inherited from FrameworkElement)
BringIntoViewRequested BringIntoViewRequested BringIntoViewRequested

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

(Inherited from UIElement)
CharacterReceived CharacterReceived CharacterReceived

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

(Inherited from UIElement)
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)
ContextRequested ContextRequested ContextRequested

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

(Inherited from UIElement)
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 with this element as the source is ended.

(Inherited from UIElement)
EffectiveViewportChanged EffectiveViewportChanged EffectiveViewportChanged

Occurs when the FrameworkElement 's effective viewport changes.

(Inherited from FrameworkElement)
FocusDisengaged FocusDisengaged FocusDisengaged

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

(Inherited from Control)
FocusEngaged FocusEngaged FocusEngaged

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

(Inherited from Control)
GettingFocus GettingFocus GettingFocus

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

(Inherited from UIElement)
GotFocus GotFocus GotFocus

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

(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)
IsEnabledChanged IsEnabledChanged IsEnabledChanged

Occurs when the IsEnabled property changes.

(Inherited from Control)
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. This event is raised synchronously to ensure focus isn't moved while the event is bubbling.

(Inherited from UIElement)
LostFocus LostFocus LostFocus

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

(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)
Navigated Navigated Navigated

Occurs when the content that is being navigated to has been found and is available from the Content property, although it may not have completed loading.

Navigating Navigating Navigating

Occurs when a new navigation is requested.

NavigationFailed NavigationFailed NavigationFailed

Occurs when an error is raised while navigating to the requested content.

NavigationStopped NavigationStopped NavigationStopped

Occurs when

a new navigation is requested while a current navigation is in progress.

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)
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)
PreviewKeyUp PreviewKeyUp PreviewKeyUp

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

(Inherited from UIElement)
ProcessKeyboardAccelerators ProcessKeyboardAccelerators ProcessKeyboardAccelerators

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

(Inherited from UIElement)
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)

Applies to

See also