Provides a framework of common APIs for objects that participate in UI and programmatic layout. FrameworkElement also defines APIs related to data binding, object tree, and object lifetime feature areas.
Inheritance
- Object
- DependencyObject
- UIElement
- FrameworkElement
Syntax
Attributes
- MarshalingBehaviorAttribute(Agile)
- StaticAttribute(Windows.UI.Xaml.IFrameworkElementStatics, NTDDI_WIN8)
- ThreadingAttribute(Both)
- VersionAttribute(NTDDI_WIN8)
- WebHostHiddenAttribute()
Members
The FrameworkElement class has these types of members:
Constructors
The FrameworkElement class has these constructors.
| Constructor | Description |
|---|---|
| FrameworkElement | Provides base class initialization behavior for FrameworkElement-derived classes. |
Events
The FrameworkElement class has these events.
| Event | Description |
|---|---|
| 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) |
| Drop | Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement) |
| GotFocus | Occurs when a UIElement receives focus. (Inherited from UIElement) |
| Holding | Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element. (Inherited from UIElement) |
| 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. |
| Loaded | Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction. |
| LostFocus | Occurs when a UIElement loses focus. (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) |
| 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. (Inherited from UIElement) |
| PointerWheelChanged | Occurs when the delta value of a pointer wheel changes. (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. |
| 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. |
Methods
The FrameworkElement class has these methods. It also inherits methods from the Object class.
| Method | Description |
|---|---|
| AddHandler | Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked even if the event is handled elsewhere. (Inherited from UIElement) |
| Arrange | 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 | Provides the behavior for the Arrange pass of layout. Classes can override this method to define their own Arrange pass behavior. |
| CapturePointer | Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events. (Inherited from UIElement) |
| ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject) |
| FindName | Retrieves an object that has the specified identifier name. |
| FindSubElementsForTouchTargeting | Enables a UIElement subclass to expose child elements that assist with resolving touch targeting. (Inherited from UIElement) |
| GetAnimationBaseValue | Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject) |
| GetValue | Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject) |
| 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) |
| Measure | 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 | Provides the behavior for the Measure pass of the layout cycle. Classes can override this method to define their own Measure pass behavior. |
| 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. |
| 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) |
| ReadLocalValue | Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject) |
| ReleasePointerCapture | 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) |
| RemoveHandler | Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler. (Inherited from UIElement) |
| SetBinding | Attaches a binding to a FrameworkElement, using the provided binding object. |
| SetValue | Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject) |
| TransformToVisual | Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement) |
| UpdateLayout | Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement) |
Properties
The FrameworkElement class has these properties.
| Property | Access type | Description |
|---|---|---|
| Read-only | Gets the rendered height of a FrameworkElement. | |
| Read-only | Identifies the ActualHeight dependency property. | |
| Read-only | Gets the rendered width of a FrameworkElement. | |
| Read-only | Identifies the ActualWidth dependency property. | |
| Read/write | 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) | |
| Read-only | 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. | |
| Read/write | Gets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible. (Inherited from UIElement) | |
| Read/write | Gets or sets the RectangleGeometry used to define the outline of the contents of a UIElement. (Inherited from UIElement) | |
| Read/write | Gets or sets the data context for a FrameworkElement when it participates in data binding. | |
| Read-only | Identifies the DataContext dependency property. | |
| Read-only | Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement) | |
| Read-only | Gets the CoreDispatcher that this object is associated with. (Inherited from DependencyObject) | |
| Read/write | 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. | |
| Read-only | Identifies the FlowDirection dependency property. | |
| Read/write | Gets or sets the suggested height of a FrameworkElement. | |
| Read-only | Identifies the Height dependency property. | |
| Read/write | 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. | |
| Read-only | Identifies the HorizontalAlignment dependency property. | |
| Read/write | Gets or sets a value that determines whether the DoubleTapped event can originate from that element. (Inherited from UIElement) | |
| Read/write | Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement) | |
| Read/write | Gets or sets a value that determines whether the Holding event can originate from that element. (Inherited from UIElement) | |
| Read/write | Gets or sets a value that determines whether the RightTapped event can originate from that element. (Inherited from UIElement) | |
| Read/write | Gets or sets a value that determines whether the Tapped event can originate from that element. (Inherited from UIElement) | |
| Read/write | 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. | |
| Read-only | Identifies the Language dependency property. | |
| Read/write | Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. (Inherited from UIElement) | |
| Read/write | Gets or sets the outer margin of a FrameworkElement. | |
| Read-only | Identifies the Margin dependency property. | |
| Read/write | Gets or sets the maximum height constraint of a FrameworkElement. | |
| Read-only | Identifies the MaxHeight dependency property. | |
| Read/write | Gets or sets the maximum width constraint of a FrameworkElement. | |
| Read-only | Identifies the MaxWidth dependency property. | |
| Read/write | Gets or sets the minimum height constraint of a FrameworkElement. | |
| Read-only | Identifies the MinHeight dependency property. | |
| Read/write | Gets or sets the minimum width constraint of a FrameworkElement. | |
| Read-only | Identifies the MinWidth dependency property. | |
| Read/write | 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. | |
| Read-only | Identifies the Name dependency property. | |
| Read/write | Gets or sets the degree of the object's opacity. (Inherited from UIElement) | |
| Read-only | Gets the parent object of this FrameworkElement in the object tree. | |
| Read-only | Gets the set of all captured pointers, represented as Pointer values. (Inherited from UIElement) | |
| Read/write | Gets or sets the perspective projection (3-D effect) to apply when rendering this element. (Inherited from UIElement) | |
| Read-only | Gets the final render size of a UIElement. (Inherited from UIElement) | |
| Read/write | Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement) | |
| Read/write | Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement) | |
| Read/write | 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. | |
| Read/write | Gets or sets an instance Style that is applied for this object during layout and rendering. | |
| Read-only | Identifies the Style dependency property. | |
| Read/write | Gets or sets an arbitrary object value that can be used to store custom information about this object. | |
| Read-only | Identifies the Tag dependency property. | |
| Read/write | Gets or sets the collection of Transition style elements that apply to a UIElement. (Inherited from UIElement) | |
| Read-only | Gets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. | |
| Read/write | 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) | |
| Read/write | 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. | |
| Read-only | Identifies the VerticalAlignment dependency property. | |
| Read/write | 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) | |
| Read/write | Gets or sets the width of a FrameworkElement. | |
| Read-only | Identifies the Width dependency property. |
Remarks
FrameworkElement extends UIElement and adds these capabilities:
- Layout. The layout system recognizes all objects that derive from FrameworkElement to be elements that potentially participate in layout and should have a display area in the app UI. The layout system reads various properties that are defined at FrameworkElement level, such as MinWidth. FrameworkElement provides extensible methods for specialized layout behavior that panels and controls with content can override in their class implementations.
- Object lifetime events. You often want to know when an object is first loaded (loaded is defined as when an object becomes attached to an object tree that connects to the root visual). FrameworkElement defines events related to object lifetime that provide useful hooks for code-behind operations, such as adding child objects to a collection or setting properties on child objects just prior to use, with assurance that the necessary objects in the object tree have been instantiated from markup.
- Support for data context of a data binding. The ability to set a value for a potentially inherited data context is implemented by FrameworkElement.
Many common XAML UI classes derive from FrameworkElement, either directly or through intermediate base classes such as Panel or Control. Typically, you don't derive classes directly from FrameworkElement, because certain expected services for a class that is intended for a UI representation (such as template support) are not fully implemented there. More commonly used base classes for derived custom classes are:
- Specific controls that are not sealed (for example, TextBox).
- Control base classes (Control, ContentControl, UserControl).
- Navigation elements (Page, Frame).
- Panel classes (the base class Panel, or specific non-sealed implementations such as Grid).
Requirements
|
Minimum supported client | Windows 8 [Windows Store apps only] |
|---|---|
|
Minimum supported server | Windows Server 2012 [Windows Store apps only] |
|
Namespace |
|
|
Metadata |
|
See also
Build date: 1/31/2013
