Aracılığıyla paylaş


Control Class

Definition

Represents the base class for UI elements that use a ControlTemplate to define their appearance. Parent class for ContentControl, UserControl, ItemsControl and several practical controls.

public ref class Control : FrameworkElement
/// [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 Control : FrameworkElement
[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 class Control : FrameworkElement
Public Class Control
Inherits FrameworkElement
Inheritance
Object Platform::Object IInspectable DependencyObject UIElement FrameworkElement Control
Derived
Attributes

Windows requirements

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

Remarks

The Control class is the base class for many of the controls you add to an app and its UI. The Control class defines very little behavior; you can add an actual Control element to XAML for UI but you typically add something that inherits from Control directly or indirectly, such as a Button or ListBox. For a list of controls you can use, see Controls by function.

The Template property, which uses the type ControlTemplate, specifies the visual appearance of a control. If you want to change the appearance of a control but retain its functionality, you should consider creating a new ControlTemplate instead of defining a new Control-based class. For more info, see Control templates.

Control is the parent of UserControl. UserControl is the intended base class for lightweight controls that don't need visual states. Although the UserControl technically inherits the Template property, you cannot apply a template to a UserControl.

Implicit styles for controls

Each practical control that's defined for XAML has a default style that contains its default control template. Controls can have an implicit style, meaning that the FrameworkElement.Style property isn't set explicitly. Once that implicit style is available, almost all other properties of a control can be set with Setter elements in that Style. The Style can initialize the control separately from the rest of the control logic, and can set values that aren't the code-based defaults for each property.

The implicit style exists as a keyed resource that's part of the Windows Runtime, stored internally as a binary representation of XAML. You can get a copy of either a particular control's style or of the full set of styles to look at how the styles and control templates are defined.

The association between a particular control type and the key/name of the implicit style it uses by default is established by the value of the DefaultStyleKey property. The DefaultStyleKey property is protected, so only someone that subclasses a control class can change the value. If you're just creating a control instance, for example declaring controls in a XAML UI, then the default style is the implicit style that's based on the control's type. For more info, see Remarks in DefaultStyleKey. You don't need to change the DefaultStyleKey value to use a different style, you just need to define your own XAML Style that has the same TargetType that matches the implicit style lookup and exists as a XAML resource. For more info, see Control templates.

The visual state model

The visual state model is a technique where you modify just a few of the properties defined in a control's template. You change property values in order to provide visual feedback to the user that indicates what the control is doing and hints at further UI interactions that are possible. The controls are modified by applying zero-duration or short-duration storyboarded animations to some of the properties in the template. You also can define short-duration animations that apply for the transitions between states.

The visual states themselves are defined as part of the control template. Each visual state has a name, so that the control logic can invoke the GoToState method that loads up each visual state when it's needed for a particular logic state. Visual states are declared within visual state groups, so that visual states that are exclusive to each other can ensure that only one such state is active at a time. As soon as another visual state from the same group is loaded, the animations for the previous state stop being applied, but animations in another group might still be running and applying their changes and visual behavior. For example, a control might have a visual indicator for keyboard focus and a visual indicator for pointer-over. Because these are UI modes that can be adjusted independently of each other and can happen at the same time, they're each defined in a different visual state group.

Because it's defined in XAML as part of the control template, you can change the visual state behavior for any XAML control that you use in your UI. However, the logic is still based on the control expecting to find certain visual state groups and named visual states within. So you have to be very careful that you're providing the correctly named and structured visual states that are showing all aspects of a control's behavior to the user. For more info, see Storyboarded animations for visual states. Visual states are also briefly introduced in Control templates.

Default visual states for controls sometimes use the library animations. You should try to preserve the library animations when you replace control templates or visual states because these animations are an important part of the control's look and feel in the UI. For more info, see Animations overview.

Controls and focus

The Control class defines several API that influence the keyboard focus behavior for a UI: the Focus method, the FocusState property, and the IsEnabled and IsTabStop properties. Enabling keyboard focus is an important part of assuring that a UI is accessible, because each focusable element becomes part of the tab order for the UI. Only UI elements that are interactive are typically enabled to receive keyboard focus. For example, a TextBox is interactive because the user can type text, whereas a TextBlock is not interactive because the text is read-only. Most of the classes that derive from Control are legitimately interactive and so it makes sense that they can be focused and should be in the tab order.

In order to be focusable, each of these must be true:

  • Visibility is Visible
  • IsEnabled is true
  • IsTabStop is true
  • The control must be instantiated with its template loaded (Loaded fired, control connected to app's root visual) If you want a control to not be focusable, you can set IsTabStop to false. However, if the reason you don't want the control to have focus is because it's not interactive in your UI, you might want to set IsEnabled to false to make the lack of interaction obvious to everyone. Many controls have predefined visual states that are invoked for IsEnabled =false, such as "graying out" text in labels.

Focus changes can fire GotFocus or LostFocus events. Although the "FocusedElement" value (exposed via GetFocusedElement method) is updated immediately, the change notifications of GotFocus or LostFocus occur asynchronously. This asynchronous focusing design is intended to avoid flickering on visual state transitions when control logic reacts to focus change too quickly.

The Focus method enables bringing keyboard focus to a control programmatically. Be judicious when calling this method, it can be intrusive to move the keyboard focus when the user doesn't expect it. The main scenarios for Focus are either setting the very first keyboard focus point when an entire page of UI is loaded, or setting focus to a specific part of a control once the parent control container has received top-level focus (like focusing the textbox in a combobox). For more info, see Focus. FocusState tracks whether focus is programmatic or user-driven, which makes a difference for visual states, notably the visual focus indicator for keyboard focus that all controls should have.

OnEvent event handler overrides

Each OnEvent method represents a prewired event handler for the corresponding UIElement event. Practical controls that derive from Control can override the OnEvent method and use this to provide control-specific handling and behavior for that input event. The most common scenario is to use the event handler to mark the event as Handled in the event data. The control code has first chance to handle this event, before any event handlers that are wired on a control instance are invoked. When the event data is marked Handled, then other handlers like those on the control instance won't be called. Also, the event won't bubble.

As it's implemented directly on Control, the OnEvent method has an empty implementation. But each ancestor in a control's hierarchy may have provided an implementation. You won't be able to see this implementation because it's internal native code. In some cases a control will already have existing OnEvent overrides that mark the event Handled. Once you've provided an initial OnEvent override for a control, then any controls that you further derive from your own control class would also inherit the OnEvent overrides you define. Any instances you use have that behavior too.

Note

App code can still handle events that may have been marked Handled by a control's OnEvent method logic, but they need to use the handledEventsToo parameter for the UIElement.AddHandler method. For more info, see UIElement.AddHandler or Events and routed events overview.

The Control class defines several protected virtual methods that are each associated with a framework-level input event. These methods are intended to provide a pre-wired event handler for input events such that a control can enforce that certain input behaviors are used by that control and all instances of it. For example, there's a PointerPressed event defined by UIElement. Control defines the OnPointerPressed method, with an empty definition. Within the base Control constructor, event wiring for all the relevant input events includes the OnEvent method as a listener/handler, which initially does nothing. But all it takes now for you as the control author to change the behavior for an input event is to give a new override definition for an OnEvent method (also, make sure your constructor calls base). That behavior gets inherited to all instances or subclasses, unless another subclasser overrides it again. Because the OnEvent events are first in sequence, before any UI definition XAML, they can adjust the event data and potentially change the conditions that other listeners see about the event.

The existing OnEvent definitions in a particular control class can affect you as the consumer of the control even if you haven't overridden any OnEvent methods yourself. This is because the existing OnEvent definitions may have provided handling for an event that sets a Handled property value to true in some event's event data. That will prevent your instance-based event handling from even seeing the event, and will prevent your handler from being invoked. What's happening here is that there's an intentional control design that is enforcing that certain events shouldn't matter to the control, either because they're low-level events that clash with control logic or because the control has replacement logic. A prominent example of this is the ButtonBase class. The ButtonBase class has two behaviors that it enforces through a native override of OnPointerPressed and OnKeyDown. It's doing this because it's combining various input modes at a low level and reporting them instead as the control-specific Click event. In the case of a PointerPressed event handler, if you tried to handle this on a Button instance, your handler doesn't get invoked. That's because the native OnPointerPressed set Handled to true and that prevented PointerPressed from propagating to your instance and app code. For OnKeyDown, the logic was just looking for certain keys (Ctrl and Enter) so an instance handler can still invoke as long as it isn't also looking for those keys.

Note

There's actually a way to get around native handling of OnEvent methods for input, for some of the input events. To do this you need to wire your handlers using the AddHandler method with handledEventsToo. For more info see AddHandler or Events and routed events overview.

Text properties that inherit to text element parts

Control defines several properties that are relevant to presentation of text. These are:

Obviously, not every control is intended to display text within it. For example, setting FontFamily on an AppBarSeparator is legal but has absolutely no effect. The reason that Control defines these properties at the base class level is to make it easy for control templates to use {TemplateBinding} markup extension to apply top-level text properties to one or more text element parts that exist within the template. For example, if you look at the control template for a DatePicker, you'll see that the root is a container and more deeply within that container are several ComboBox parts that actually take the text input. Each of these uses statements like FontWeight="{TemplateBinding FontWeight}" to have the top-level FontWeight as set on a DatePicker be used by various parts within.

Text properties on Control also inherit implicitly for a control that has a ContentPresenter within it that displays text. For example, if you set FontSize on a Button, there's no explicit {TemplateBinding} markup extension in its template or ContentPresenter part that controls what the template does with a top-level FontSize value. But the Control.FontSize value is implicitly inherited by ContentPresenter.FontSize based on the context within the template's definition, so the text within the Button will be presented using the Control.FontSize you set.

XAML attached properties

Control is the host service class for several XAML attached properties.

In order to support XAML processor access to the attached properties, and also to expose equivalent get and set operations to code, each XAML attached property has a pair of Get and Set accessor methods. Another way to get or set the value in code is to use the dependency property system, calling either GetValue or SetValue and passing the identifier field as the dependency property identifier.

Attached property Description
IsTemplateFocusTarget Gets or sets a value that indicates whether this element is the part of a control template that has the focus visual.
IsTemplateKeyTipTarget Gets or sets a value that indicates whether this element is the part of a control template where the KeyTip is placed.

Version history

Windows version SDK version Value added
1607 14393 ElementSoundMode
1607 14393 FocusDisengaged
1607 14393 FocusEngaged
1607 14393 IsFocusEngaged
1607 14393 IsFocusEngagementEnabled
1607 14393 RemoveFocusEngagement
1607 14393 RequiresPointer
1607 14393 XYFocusDown
1607 14393 XYFocusLeft
1607 14393 XYFocusRight
1607 14393 XYFocusUp
1703 15063 DefaultStyleResourceUri
1703 15063 GetIsTemplateKeyTipTarget
1703 15063 SetIsTemplateKeyTipTarget
1709 16299 OnCharacterReceived
1709 16299 OnPreviewKeyDown
1709 16299 OnPreviewKeyUp
1809 17763 BackgroundSizing
1809 17763 CornerRadius

Constructors

Control()

Provides base class initialization behavior for Control derived classes.

Properties

AccessKey

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

(Inherited from UIElement)
AccessKeyScopeOwner

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

(Inherited from UIElement)
ActualHeight

Gets the rendered height of a FrameworkElement. See Remarks.

(Inherited from FrameworkElement)
ActualOffset

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

(Inherited from UIElement)
ActualSize

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

(Inherited from UIElement)
ActualTheme

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

(Inherited from FrameworkElement)
ActualWidth

Gets the rendered width of a FrameworkElement. See Remarks.

(Inherited from FrameworkElement)
AllowDrop

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

(Inherited from UIElement)
AllowFocusOnInteraction

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

(Inherited from FrameworkElement)
AllowFocusWhenDisabled

Gets or sets whether a disabled control can receive focus.

(Inherited from FrameworkElement)
Background

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

BackgroundProperty

Identifies the Background dependency property.

BackgroundSizing

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

BackgroundSizingProperty

Identifies the BackgroundSizing dependency property.

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

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

BorderBrushProperty

Identifies the BorderBrush dependency property.

BorderThickness

Gets or sets the border thickness of a control.

BorderThicknessProperty

Identifies the BorderThickness dependency property.

CacheMode

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

(Inherited from UIElement)
CanBeScrollAnchor

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

(Inherited from UIElement)
CanDrag

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

(Inherited from UIElement)
CenterPoint

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

(Inherited from UIElement)
CharacterSpacing

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

CharacterSpacingProperty

Identifies the CharacterSpacing dependency property.

Clip

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

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

Gets or sets the flyout associated with this element.

(Inherited from UIElement)
CornerRadius

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

CornerRadiusProperty

Identifies the CornerRadius dependency property.

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

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.

DefaultStyleKeyProperty

Identifies the DefaultStyleKey dependency property.

DefaultStyleResourceUri

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

DefaultStyleResourceUriProperty

Identifies the DefaultStyleResourceUri dependency property.

DesiredSize

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

(Inherited from UIElement)
Dispatcher

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

(Inherited from DependencyObject)
ElementSoundMode

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

ElementSoundModeProperty

Identifies the ElementSoundMode dependency property.

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

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

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

FocusStateProperty

Identifies the FocusState dependency property.

FocusVisualMargin

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

(Inherited from FrameworkElement)
FocusVisualPrimaryBrush

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

(Inherited from FrameworkElement)
FocusVisualPrimaryThickness

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

(Inherited from FrameworkElement)
FocusVisualSecondaryBrush

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

(Inherited from FrameworkElement)
FocusVisualSecondaryThickness

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

(Inherited from FrameworkElement)
FontFamily

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

FontFamilyProperty

Identifies the FontFamily dependency property.

FontSize

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

FontSizeProperty

Identifies the FontSize dependency property.

FontStretch

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

FontStretchProperty

Identifies the FontStretch dependency property.

FontStyle

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

FontStyleProperty

Identifies the FontStyle dependency property.

FontWeight

Gets or sets the thickness of the specified font.

FontWeightProperty

Identifies the FontWeight dependency property.

Foreground

Gets or sets a brush that describes the foreground color.

ForegroundProperty

Identifies the Foreground dependency property.

Height

Gets or sets the suggested height of a FrameworkElement.

(Inherited from FrameworkElement)
HighContrastAdjustment

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

(Inherited from UIElement)
HorizontalAlignment

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

(Inherited from FrameworkElement)
HorizontalContentAlignment

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

HorizontalContentAlignmentProperty

Identifies the HorizontalContentAlignment dependency property.

IsAccessKeyScope

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

(Inherited from UIElement)
IsDoubleTapEnabled

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

(Inherited from UIElement)
IsEnabled

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

IsEnabledProperty

Identifies the IsEnabled dependency property.

IsFocusEngaged

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

IsFocusEngagedProperty

Identifies the IsFocusEngaged dependency property.

IsFocusEngagementEnabled

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

IsFocusEngagementEnabledProperty

Identifies the IsFocusEngagementEnabled dependency property.

IsHitTestVisible

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

(Inherited from UIElement)
IsHoldingEnabled

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

(Inherited from UIElement)
IsLoaded

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

(Inherited from FrameworkElement)
IsRightTapEnabled

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

(Inherited from UIElement)
IsTabStop

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

IsTabStopProperty

Identifies the IsTabStop  dependency property.

IsTapEnabled

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

(Inherited from UIElement)
IsTemplateFocusTargetProperty

Identifies the Control.IsTemplateFocusTarget XAML attached property.

IsTemplateKeyTipTargetProperty

Identifies the Control.IsTemplateKeyTipTarget XAML attached property.

IsTextScaleFactorEnabled

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

IsTextScaleFactorEnabledProperty

Identifies the IsTextScaleFactorEnabled  dependency property.

KeyboardAcceleratorPlacementMode

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

(Inherited from UIElement)
KeyboardAcceleratorPlacementTarget

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

(Inherited from UIElement)
KeyboardAccelerators

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

Accelerators are typically assigned to buttons or menu items.

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

(Inherited from UIElement)
KeyTipHorizontalOffset

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

(Inherited from UIElement)
KeyTipPlacementMode

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

(Inherited from UIElement)
KeyTipTarget

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

(Inherited from UIElement)
KeyTipVerticalOffset

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

(Inherited from UIElement)
Language

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

(Inherited from FrameworkElement)
Lights

Gets the collection of XamlLight objects attached to this element.

(Inherited from UIElement)
ManipulationMode

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

(Inherited from UIElement)
Margin

Gets or sets the outer margin of a FrameworkElement.

(Inherited from FrameworkElement)
MaxHeight

Gets or sets the maximum height constraint of a FrameworkElement.

(Inherited from FrameworkElement)
MaxWidth

Gets or sets the maximum width constraint of a FrameworkElement.

(Inherited from FrameworkElement)
MinHeight

Gets or sets the minimum height constraint of a FrameworkElement.

(Inherited from FrameworkElement)
MinWidth

Gets or sets the minimum width constraint of a FrameworkElement.

(Inherited from FrameworkElement)
Name

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

(Inherited from FrameworkElement)
Opacity

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

(Inherited from UIElement)
OpacityTransition

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

(Inherited from UIElement)
Padding

Gets or sets the padding inside a control.

PaddingProperty

Identifies the Padding dependency property.

Parent

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

(Inherited from FrameworkElement)
PointerCaptures

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

(Inherited from UIElement)
Projection

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

(Inherited from UIElement)
RenderSize

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

(Inherited from UIElement)
RenderTransform

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

(Inherited from UIElement)
RenderTransformOrigin

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

(Inherited from UIElement)
RequestedTheme

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

(Inherited from FrameworkElement)
RequiresPointer

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

RequiresPointerProperty

Identifies the RequiresPointer dependency property.

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

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

Gets or sets the axis to rotate the element around.

(Inherited from UIElement)
RotationTransition

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

(Inherited from UIElement)
Scale

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

(Inherited from UIElement)
ScaleTransition

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

(Inherited from UIElement)
Shadow

Gets or sets the shadow effect cast by the element.

(Inherited from UIElement)
Style

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

(Inherited from FrameworkElement)
TabFocusNavigation

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

(Inherited from UIElement)
TabIndex

Gets or sets a value that indicates the order in which elements receive focus when the user navigates through the app UI using the Tab key.

TabIndexProperty

Identifies the TabIndex  dependency property.

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.

TabNavigationProperty

Identifies the TabNavigation  dependency property.

Tag

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

(Inherited from FrameworkElement)
Template

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

TemplateProperty

Identifies the Template  dependency property.

Transform3D

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

(Inherited from UIElement)
TransformMatrix

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

(Inherited from UIElement)
Transitions

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

(Inherited from UIElement)
Translation

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

(Inherited from UIElement)
TranslationTransition

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

(Inherited from UIElement)
Triggers

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

(Inherited from FrameworkElement)
UIContext

Gets the context identifier for the element.

(Inherited from UIElement)
UseLayoutRounding

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

(Inherited from UIElement)
UseSystemFocusVisuals

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

UseSystemFocusVisualsProperty

Identifies the UseSystemFocusVisuals dependency property.

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

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

VerticalContentAlignmentProperty

Identifies the VerticalContentAlignment dependency property.

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

Gets or sets the width of a FrameworkElement.

(Inherited from FrameworkElement)
XamlRoot

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

(Inherited from UIElement)
XYFocusDown

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

XYFocusDownNavigationStrategy

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

(Inherited from UIElement)
XYFocusDownProperty

Identifies the XYFocusDown dependency property.

XYFocusKeyboardNavigation

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

(Inherited from UIElement)
XYFocusLeft

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

XYFocusLeftNavigationStrategy

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

(Inherited from UIElement)
XYFocusLeftProperty

Identifies the XYFocusLeft dependency property.

XYFocusRight

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

XYFocusRightNavigationStrategy

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

(Inherited from UIElement)
XYFocusRightProperty

Identifies the XYFocusRight dependency property.

XYFocusUp

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

XYFocusUpNavigationStrategy

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

(Inherited from UIElement)
XYFocusUpProperty

Identifies the XYFocusUp dependency property.

Attached Properties

IsTemplateFocusTarget

Gets or sets a value that indicates whether this element is the part of a control template that has the focus visual.

IsTemplateKeyTipTarget

Gets or sets a value that indicates whether this element is the part of a control template where the KeyTip is placed.

Methods

AddHandler(RoutedEvent, Object, Boolean)

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

(Inherited from UIElement)
ApplyTemplate()

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

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)

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

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

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

Clears the local value of a dependency property.

(Inherited from DependencyObject)
FindName(String)

Retrieves an object that has the specified identifier name.

(Inherited from FrameworkElement)
FindSubElementsForTouchTargeting(Point, Rect)

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

(Inherited from UIElement)
Focus(FocusState)

Attempts to set the focus on the control.

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)

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

(Inherited from FrameworkElement)
GetChildrenInTabFocusOrder()

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

(Inherited from UIElement)
GetIsTemplateFocusTarget(FrameworkElement)

Gets the value of the Control.IsTemplateFocusTarget XAML attached property for the target element.

GetIsTemplateKeyTipTarget(DependencyObject)

Gets the value of the Control.IsTemplateKeyTipTarget XAML attached property for the target element.

GetTemplateChild(String)

Retrieves the named element in the instantiated ControlTemplate visual tree.

GetValue(DependencyProperty)

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

(Inherited from DependencyObject)
GoToElementStateCore(String, Boolean)

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

(Inherited from FrameworkElement)
InvalidateArrange()

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

(Inherited from UIElement)
InvalidateMeasure()

Invalidates the measurement state (layout) for a UIElement.

(Inherited from UIElement)
InvalidateViewport()

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

(Inherited from FrameworkElement)
Measure(Size)

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

(Inherited from UIElement)
MeasureOverride(Size)

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

(Inherited from FrameworkElement)
OnApplyTemplate()

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

(Inherited from FrameworkElement)
OnBringIntoViewRequested(BringIntoViewRequestedEventArgs)

Called before the BringIntoViewRequested event occurs.

(Inherited from UIElement)
OnCharacterReceived(CharacterReceivedRoutedEventArgs)

Called before the CharacterReceived event occurs.

OnCreateAutomationPeer()

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

(Inherited from UIElement)
OnDisconnectVisualChildren()

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

(Inherited from UIElement)
OnDoubleTapped(DoubleTappedRoutedEventArgs)

Called before the DoubleTapped event occurs.

OnDragEnter(DragEventArgs)

Called before the DragEnter event occurs.

OnDragLeave(DragEventArgs)

Called before the DragLeave event occurs.

OnDragOver(DragEventArgs)

Called before the DragOver event occurs.

OnDrop(DragEventArgs)

Called before the Drop event occurs.

OnGotFocus(RoutedEventArgs)

Called before the GotFocus event occurs.

OnHolding(HoldingRoutedEventArgs)

Called before the Holding event occurs.

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)

Called before the KeyDown event occurs.

OnKeyUp(KeyRoutedEventArgs)

Called before the KeyUp event occurs.

OnLostFocus(RoutedEventArgs)

Called before the LostFocus event occurs.

OnManipulationCompleted(ManipulationCompletedRoutedEventArgs)

Called before the ManipulationCompleted event occurs.

OnManipulationDelta(ManipulationDeltaRoutedEventArgs)

Called before the ManipulationDelta event occurs.

OnManipulationInertiaStarting(ManipulationInertiaStartingRoutedEventArgs)

Called before the ManipulationInertiaStarting event occurs.

OnManipulationStarted(ManipulationStartedRoutedEventArgs)

Called before the ManipulationStarted event occurs.

OnManipulationStarting(ManipulationStartingRoutedEventArgs)

Called before the ManipulationStarting event occurs.

OnPointerCanceled(PointerRoutedEventArgs)

Called before the PointerCanceled event occurs.

OnPointerCaptureLost(PointerRoutedEventArgs)

Called before the PointerCaptureLost event occurs.

OnPointerEntered(PointerRoutedEventArgs)

Called before the PointerEntered event occurs.

OnPointerExited(PointerRoutedEventArgs)

Called before the PointerExited event occurs.

OnPointerMoved(PointerRoutedEventArgs)

Called before the PointerMoved event occurs.

OnPointerPressed(PointerRoutedEventArgs)

Called before the PointerPressed event occurs.

OnPointerReleased(PointerRoutedEventArgs)

Called before the PointerReleased event occurs.

OnPointerWheelChanged(PointerRoutedEventArgs)

Called before the PointerWheelChanged event occurs.

OnPreviewKeyDown(KeyRoutedEventArgs)

Called before the PreviewKeyDown event occurs.

OnPreviewKeyUp(KeyRoutedEventArgs)

Called before the PreviewKeyUp event occurs.

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)

Called before the RightTapped event occurs.

OnTapped(TappedRoutedEventArgs)

Called before the Tapped event occurs.

PopulatePropertyInfo(String, AnimationPropertyInfo)

Defines a property that can be animated.

(Inherited from UIElement)
PopulatePropertyInfoOverride(String, AnimationPropertyInfo)

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

(Inherited from UIElement)
ReadLocalValue(DependencyProperty)

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

(Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)

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

(Inherited from DependencyObject)
ReleasePointerCapture(Pointer)

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

(Inherited from UIElement)
ReleasePointerCaptures()

Releases all pointer captures held by this element.

(Inherited from UIElement)
RemoveFocusEngagement()

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

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)

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

(Inherited from FrameworkElement)
SetIsTemplateFocusTarget(FrameworkElement, Boolean)

Sets the value of the Control.IsTemplateFocusTarget XAML attached property for a target element.

SetIsTemplateKeyTipTarget(DependencyObject, Boolean)

Sets the value of the Control.IsTemplateKeyTipTarget XAML attached property for a target element.

SetValue(DependencyProperty, Object)

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

(Inherited from DependencyObject)
StartAnimation(ICompositionAnimationBase)

Begins the specified animation on the element.

(Inherited from UIElement)
StartBringIntoView()

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

(Inherited from UIElement)
StartBringIntoView(BringIntoViewOptions)

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

(Inherited from UIElement)
StartDragAsync(PointerPoint)

Initiates a drag-and-drop operation.

(Inherited from UIElement)
StopAnimation(ICompositionAnimationBase)

Stops the specified animation on the element.

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

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)

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

(Inherited from DependencyObject)
UpdateLayout()

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

(Inherited from UIElement)

Events

AccessKeyDisplayDismissed

Occurs when access keys should no longer be displayed.

(Inherited from UIElement)
AccessKeyDisplayRequested

Occurs when the user requests that access keys be displayed.

(Inherited from UIElement)
AccessKeyInvoked

Occurs when a user completes an access key sequence.

(Inherited from UIElement)
ActualThemeChanged

Occurs when the ActualTheme property value has changed.

(Inherited from FrameworkElement)
BringIntoViewRequested

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

(Inherited from UIElement)
CharacterReceived

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

(Inherited from UIElement)
ContextCanceled

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

(Inherited from UIElement)
ContextRequested

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

(Inherited from UIElement)
DataContextChanged

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

(Inherited from FrameworkElement)
DoubleTapped

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

(Inherited from UIElement)
DragEnter

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

(Inherited from UIElement)
DragLeave

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

(Inherited from UIElement)
DragOver

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

(Inherited from UIElement)
DragStarting

Occurs when a drag operation is initiated.

(Inherited from UIElement)
Drop

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

(Inherited from UIElement)
DropCompleted

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

(Inherited from UIElement)
EffectiveViewportChanged

Occurs when the FrameworkElement's effective viewport changes.

(Inherited from FrameworkElement)
FocusDisengaged

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

FocusEngaged

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

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

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

(Inherited from UIElement)
Holding

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

(Inherited from UIElement)
IsEnabledChanged

Occurs when the IsEnabled property changes.

KeyDown

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

(Inherited from UIElement)
KeyUp

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

(Inherited from UIElement)
LayoutUpdated

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

(Inherited from FrameworkElement)
Loaded

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

(Inherited from FrameworkElement)
Loading

Occurs when a FrameworkElement begins to load.

(Inherited from FrameworkElement)
LosingFocus

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

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

Occurs when a manipulation on the UIElement is complete.

(Inherited from UIElement)
ManipulationDelta

Occurs when the input device changes position during a manipulation.

(Inherited from UIElement)
ManipulationInertiaStarting

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

(Inherited from UIElement)
ManipulationStarted

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

(Inherited from UIElement)
ManipulationStarting

Occurs when the manipulation processor is first created.

(Inherited from UIElement)
NoFocusCandidateFound

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

(Inherited from UIElement)
PointerCanceled

Occurs when a pointer that made contact abnormally loses contact.

(Inherited from UIElement)
PointerCaptureLost

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

(Inherited from UIElement)
PointerEntered

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

(Inherited from UIElement)
PointerExited

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

(Inherited from UIElement)
PointerMoved

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

(Inherited from UIElement)
PointerPressed

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

(Inherited from UIElement)
PointerReleased

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

(Inherited from UIElement)
PointerWheelChanged

Occurs when the delta value of a pointer wheel changes.

(Inherited from UIElement)
PreviewKeyDown

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

(Inherited from UIElement)
PreviewKeyUp

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

(Inherited from UIElement)
ProcessKeyboardAccelerators

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

(Inherited from UIElement)
RightTapped

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

(Inherited from UIElement)
SizeChanged

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

(Inherited from FrameworkElement)
Tapped

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

(Inherited from UIElement)
Unloaded

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

(Inherited from FrameworkElement)

Applies to

See also