FrameworkElement class

Applies to Windows and Windows Phone

Provides a base element class for Windows Runtime UI objects. FrameworkElement defines common APIs that support UI interaction and the automatic layout system. FrameworkElement also defines APIs related to data binding, defining and examining the object tree, and tracking object lifetime.

Inheritance

Object
  DependencyObject
    UIElement
      FrameworkElement

Syntax


public class FrameworkElement : UIElement

Attributes

[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06020000)]
[WebHostHidden()]

Members

The FrameworkElement class has these types of members:

Constructors

The FrameworkElement class has these constructors.

ConstructorDescription
FrameworkElement Provides base class initialization behavior for FrameworkElement-derived classes.

 

Events

The FrameworkElement class has these events.

EventDescription
DataContextChanged Occurs when the value of the FrameworkElement.DataContext property changes.
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, due to layout-relevant properties changing value or some other action that refreshes the layout.
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.

MethodDescription
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.
CancelDirectManipulations Cancels ongoing direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement. (Inherited from UIElement)
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)
GetBindingExpression Returns the BindingExpression that represents the binding on the specified property.
GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
GoToElementStateCore 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.
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.

PropertyAccess typeDescription

ActualHeight

Read-onlyGets the rendered height of a FrameworkElement.

ActualHeightProperty

Read-onlyIdentifies the ActualHeight dependency property.

ActualWidth

Read-onlyGets the rendered width of a FrameworkElement.

ActualWidthProperty

Read-onlyIdentifies the ActualWidth dependency property.

AllowDrop

Read/writeGets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations. (Inherited from UIElement)

BaseUri

Read-onlyGets 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.

CacheMode

Read/writeGets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible. (Inherited from UIElement)

Clip

Read/writeGets or sets the RectangleGeometry used to define the outline of the contents of a UIElement. (Inherited from UIElement)

CompositeMode

Read/writeGets 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)

DataContext

Read/writeGets or sets the data context for a FrameworkElement when it participates in data binding.

DataContextProperty

Read-onlyIdentifies the DataContext dependency property.

DesiredSize

Read-onlyGets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement)

Dispatcher

Read-onlyGets the CoreDispatcher that this object is associated with. (Inherited from DependencyObject)

FlowDirection

Read/writeGets 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.

FlowDirectionProperty

Read-onlyIdentifies the FlowDirection dependency property.

Height

Read/writeGets or sets the suggested height of a FrameworkElement.

HeightProperty

Read-onlyIdentifies the Height dependency property.

HorizontalAlignment

Read/writeGets 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.

HorizontalAlignmentProperty

Read-onlyIdentifies the HorizontalAlignment dependency property.

IsDoubleTapEnabled

Read/writeGets or sets a value that determines whether the DoubleTapped event can originate from that element. (Inherited from UIElement)

IsHitTestVisible

Read/writeGets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement)

IsHoldingEnabled

Read/writeGets or sets a value that determines whether the Holding event can originate from that element. (Inherited from UIElement)

IsRightTapEnabled

Read/writeGets or sets a value that determines whether the RightTapped event can originate from that element. (Inherited from UIElement)

IsTapEnabled

Read/writeGets or sets a value that determines whether the Tapped event can originate from that element. (Inherited from UIElement)

Language

Read/writeGets 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.

LanguageProperty

Read-onlyIdentifies the Language dependency property.

ManipulationMode

Read/writeGets 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

Read/writeGets or sets the outer margin of a FrameworkElement.

MarginProperty

Read-onlyIdentifies the Margin dependency property.

MaxHeight

Read/writeGets or sets the maximum height constraint of a FrameworkElement.

MaxHeightProperty

Read-onlyIdentifies the MaxHeight dependency property.

MaxWidth

Read/writeGets or sets the maximum width constraint of a FrameworkElement.

MaxWidthProperty

Read-onlyIdentifies the MaxWidth dependency property.

MinHeight

Read/writeGets or sets the minimum height constraint of a FrameworkElement.

MinHeightProperty

Read-onlyIdentifies the MinHeight dependency property.

MinWidth

Read/writeGets or sets the minimum width constraint of a FrameworkElement.

MinWidthProperty

Read-onlyIdentifies the MinWidth dependency property.

Name

Read/writeGets 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.

NameProperty

Read-onlyIdentifies the Name dependency property.

Opacity

Read/writeGets or sets the degree of the object's opacity. (Inherited from UIElement)

Parent

Read-onlyGets the parent object of this FrameworkElement in the object tree.

PointerCaptures

Read-onlyGets the set of all captured pointers, represented as Pointer values. (Inherited from UIElement)

Projection

Read/writeGets or sets the perspective projection (3-D effect) to apply when rendering this element. (Inherited from UIElement)

RenderSize

Read-onlyGets the final render size of a UIElement. (Inherited from UIElement)

RenderTransform

Read/writeGets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement)

RenderTransformOrigin

Read/writeGets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement)

RequestedTheme

Read/writeGets 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.

RequestedThemeProperty

Read-onlyIdentifies the RequestedTheme dependency property.

Resources

Read/writeGets 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.

Style

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

StyleProperty

Read-onlyIdentifies the Style dependency property.

Tag

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

TagProperty

Read-onlyIdentifies the Tag dependency property.

Transitions

Read/writeGets or sets the collection of Transition style elements that apply to a UIElement. (Inherited from UIElement)

Triggers

Read-onlyGets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used.

UseLayoutRounding

Read/writeGets 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)

VerticalAlignment

Read/writeGets 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.

VerticalAlignmentProperty

Read-onlyIdentifies the VerticalAlignment dependency property.

Visibility

Read/writeGets 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

Read/writeGets or sets the width of a FrameworkElement.

WidthProperty

Read-onlyIdentifies the Width dependency property.

 

Remarks

FrameworkElement is a base element: it's a class that many other Windows Runtime classes inherit from in order to support the XAML UI element model. Properties, methods and events that FrameworkElement defines are inherited by hundreds of other Windows Runtime classes.

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:

FrameworkElement API and features

FrameworkElement extends UIElement, which is another base element, and adds support for various Windows Runtime feature areas.

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. Most UI elements use the FrameworkElement-defined Width and Height for their basic sizing information. FrameworkElement provides extensible methods for specialized layout behavior that panels and controls with content can override in their class implementations. For more info, see Quickstart: Defining layouts.

Prominent APIs of FrameworkElement that support layout: Height, Width, ActualHeight, ActualWidth, Margin, MeasureOverride, ArrangeOverride, HorizontalAlignment, VerticalAlignment, LayoutUpdated.

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. For example you need object lifetime info to add child objects to a collection or set properties on child objects just prior to use, with assurance that the necessary objects in the object tree have already been instantiated from XAML markup. For more info, see Events and routed events overview.

Prominent APIs of FrameworkElement that support object lifetime events: Loaded, SizeChanged, Unloaded, OnApplyTemplate.

Data binding

The ability to set a value for a potentially inherited data context for a data binding is implemented by FrameworkElement. FrameworkElement also has APIs for establishing data binding in code rather than in XAML. For more info, see Data binding overview.

Prominent APIs of FrameworkElement that support data binding: DataContext, DataContextChanged, SetBinding, GetBindingExpression.

XAML language and programming model integration

Usually your app's element structure resembles the XAML markup that you defined to create the UI, but sometimes that structure changes after the XAML was parsed. FrameworkElement defines the Name property and related APIs, which are useful for finding elements and element relationships at run-time. For more info, see XAML namescopes.

Prominent APIs of FrameworkElement that support XAML and programming model: Name, FindName, Parent, BaseUri, OnApplyTemplate.

Globalization

The FrameworkElement class defines the Language property and the FlowDirection property. For more info, see Globalizing your app.

Style and theme support

The FrameworkElement class defines the Style property and the RequestedTheme property. Also, the Resources property is used to define the page-level XAML resource dictionaries that typically define styles and templates, as well as other shared resources. For more info, see Quickstart: Styling controls and ResourceDictionary and XAML resource references.

FrameworkElement dependency properties

Many of the read-write properties of the FrameworkElement base element class are dependency properties. Dependency properties support some of the basic programming model features for a Windows Store app using C++, C#, or Visual Basic, such as styles and templates, data binding, XAML resource references, and property-changed logic. For more info on dependency properties and the features they support, see Dependency properties overview.

FrameworkElement derived classes

FrameworkElement is the parent class for several immediately derived classes that distinguish several broad classifications of UI elements. Here are some of the notable derived classes:

Requirements

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml
Windows::UI::Xaml [C++]

Metadata

Windows.winmd

See also

UIElement
Creating a UI
Dependency properties overview

 

 

Show:
© 2014 Microsoft. All rights reserved.