FrameworkElement Class

July 28, 2014

Provides a framework of common APIs for objects that participate in Windows Phone layout. FrameworkElement also defines APIs related to data binding, object tree, and object lifetime feature areas in Windows Phone.

System.Object
  System.Windows.DependencyObject
    System.Windows.UIElement
      System.Windows.FrameworkElement
        More...

Namespace:  System.Windows
Assembly:  System.Windows (in System.Windows.dll)

public abstract class FrameworkElement : UIElement

The FrameworkElement type exposes the following members.

  NameDescription
Protected methodFrameworkElementInitializes a new instance of the FrameworkElement class.
Top

  NameDescription
Public propertyActualHeightGets the rendered height of a FrameworkElement.
Public propertyActualWidthGets the rendered width of a FrameworkElement.
Public propertyAllowDropGets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations. (Inherited from UIElement.)
Public propertyCacheModeGets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
Public propertyClipGets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
Public propertyCursorInfrastructure. Gets or sets the cursor image that displays while the pointer is over a FrameworkElement.
Public propertyDataContextGets or sets the data context for a FrameworkElement when it participates in data binding.
Public propertyDesiredSizeGets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.)
Public propertyDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertyFlowDirectionGets or sets the direction that text and other user interface elements flow within any parent element that controls their layout.
Public propertyHeightGets or sets the suggested height of a FrameworkElement.
Public propertyHorizontalAlignmentGets 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.
Public propertyIsHitTestVisibleGets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.)
Public propertyLanguageGets or sets localization/globalization language information that applies to a FrameworkElement.
Public propertyMarginGets or sets the outer margin of a FrameworkElement.
Public propertyMaxHeightGets or sets the maximum height constraint of a FrameworkElement.
Public propertyMaxWidthGets or sets the maximum width constraint of a FrameworkElement.
Public propertyMinHeightGets or sets the minimum height constraint of a FrameworkElement.
Public propertyMinWidthGets or sets the minimum width constraint of a FrameworkElement.
Public propertyNameGets 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.
Public propertyOpacityGets or sets the degree of the object's opacity. (Inherited from UIElement.)
Public propertyOpacityMaskGets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.)
Public propertyParentGets the parent object of this FrameworkElement in the object tree.
Public propertyProjectionGets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.)
Public propertyRenderSizeGets the final render size of a UIElement. (Inherited from UIElement.)
Public propertyRenderTransformGets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.)
Public propertyRenderTransformOriginGets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement.)
Public propertyResourcesGets 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.
Public propertyStyleGets or sets an instance Style that is applied for this object during rendering.
Public propertyTagGets or sets an arbitrary object value that can be used to store custom information about this object.
Public propertyTriggersGets the collection of triggers for animations that are defined for a FrameworkElement.
Public propertyUseLayoutRoundingGets 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.)
Public propertyUseOptimizedManipulationRoutingGets or sets a value that indicates whether the system should handle input events or whether the FrameworkElement should handle input events.
Public propertyVerticalAlignmentGets 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.
Public propertyVisibilityGets or sets the visibility of a UIElement. A UIElement that is not visible does not render and does not communicate its desired size to layout. (Inherited from UIElement.)
Public propertyWidthGets or sets the width of a FrameworkElement.
Top

  NameDescription
Public methodAddHandlerAdds 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 for routed event that had already been marked as handled by another element along the event route. (Inherited from UIElement.)
Public methodArrangePositions 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.)
Protected methodArrangeOverrideProvides the behavior for the Arrange pass of Windows Phone layout. Classes can override this method to define their own Arrange pass behavior.
Public methodCaptureMouseSets touch capture to a UIElement. (Inherited from UIElement.)
Public methodCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodFindNameRetrieves an object that has the specified identifier name.
Public methodGetAnimationBaseValueReturns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodGetBindingExpressionRetrieves the BindingExpression for a dependency property where a binding is established.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Public methodInvalidateArrangeInvalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement.)
Public methodInvalidateMeasureInvalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.)
Public methodMeasureUpdates 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.)
Protected methodMeasureOverrideProvides the behavior for the Measure pass of Windows Phone layout. Classes can override this method to define their own Measure pass behavior.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodOnApplyTemplateWhen overridden in a derived class, is 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 an application. For more information, see Remarks.
Protected methodOnCreateAutomationPeerWhen implemented in a derived class, returns class-specific AutomationPeer implementations for the Windows Phone automation infrastructure. (Inherited from UIElement.)
Public methodReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodReleaseMouseCaptureRemoves touch capture from a UIElement. After this call, typically no object holds touch capture. (Inherited from UIElement.)
Public methodRemoveHandlerRemoves the specified routed event handler from this UIElement. (Inherited from UIElement.)
Public methodSetBindingAttaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use.
Public methodSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodTransformToVisualReturns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.)
Public methodUpdateLayoutEnsures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.)
Top

  NameDescription
Public eventBindingValidationErrorOccurs when a data validation error is reported by a binding source.
Public eventDoubleTapOccurs when a DoubleTap gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventGotFocusOccurs when a UIElement receives focus. (Inherited from UIElement.)
Public eventHoldOccurs when a Hold gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventKeyDownOccurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.)
Public eventKeyUpOccurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.)
Public eventLayoutUpdatedOccurs when the layout of the Windows Phone visual tree changes.
Public eventLoadedOccurs when a FrameworkElement has been constructed and added to the object tree.
Public eventLostFocusOccurs when a UIElement loses focus. (Inherited from UIElement.)
Public eventLostMouseCaptureOccurs when the UIElement loses touch capture. (Inherited from UIElement.)
Public eventManipulationCompletedOccurs when a manipulation and inertia on the UIElement is complete. (Inherited from UIElement.)
Public eventManipulationDeltaOccurs when the input device changes position during a manipulation. (Inherited from UIElement.)
Public eventManipulationStartedOccurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement.)
Public eventMouseEnterOccurs when a screen tap occurs within the bounding area of a UIElement. (Inherited from UIElement.)
Public eventMouseLeaveOccurs when a touch event occurs outside the bounding area of a UIElement. (Inherited from UIElement.)
Public eventMouseLeftButtonDownOccurs when a UIElement is tapped. (Inherited from UIElement.)
Public eventMouseLeftButtonUpOccurs when the finger is lifted off of a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.)
Public eventMouseMoveOccurs when the coordinate position of the finger on the screen while touching a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.)
Public eventMouseWheelInfrastructure. Occurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.)
Public eventSizeChangedOccurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement.
Public eventTapOccurs when a Tap gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventTextInputOccurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.)
Public eventTextInputStartOccurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.)
Public eventTextInputUpdateOccurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.)
Public eventUnloadedOccurs when this object is no longer connected to the main object tree.
Top

  NameDescription
Public fieldStatic memberActualHeightPropertyIdentifies the ActualHeight dependency property.
Public fieldStatic memberActualWidthPropertyIdentifies the ActualWidth dependency property.
Public fieldStatic memberCursorPropertyIdentifies the Cursor dependency property.
Public fieldStatic memberDataContextPropertyIdentifies the DataContext dependency property.
Public fieldStatic memberFlowDirectionPropertyIdentifies the FlowDirection dependency property.
Public fieldStatic memberHeightPropertyIdentifies the Height dependency property.
Public fieldStatic memberHorizontalAlignmentPropertyIdentifies the HorizontalAlignment dependency property.
Public fieldStatic memberLanguagePropertyIdentifies the Language dependency property.
Public fieldStatic memberLoadedEventIdentifies the Loaded routed event.
Public fieldStatic memberMarginPropertyIdentifies the Margin dependency property.
Public fieldStatic memberMaxHeightPropertyIdentifies the MaxHeight dependency property.
Public fieldStatic memberMaxWidthPropertyIdentifies the MaxWidth dependency property.
Public fieldStatic memberMinHeightPropertyIdentifies the MinHeight dependency property.
Public fieldStatic memberMinWidthPropertyIdentifies the MinWidth dependency property.
Public fieldStatic memberNamePropertyIdentifies the Name dependency property.
Public fieldStatic memberStylePropertyIdentifies the Style dependency property.
Public fieldStatic memberTagPropertyIdentifies the Tag dependency property.
Public fieldStatic memberUseOptimizedManipulationRoutingPropertyIdentifies the UseOptimizedManipulationRouting dependency property.
Public fieldStatic memberVerticalAlignmentPropertyIdentifies the VerticalAlignment dependency property.
Public fieldStatic memberWidthPropertyIdentifies the Width dependency property.
Top

FrameworkElement extends UIElement and adds the following capabilities:

  • Layout: Windows Phone implements its layout system to recognize objects that derive from FrameworkElement. The layout system reads various properties that are defined at FrameworkElement level, such as MinWidth, and provides extensible methods for specialized layout behavior that panels and controls with content can override in their class implementations. 

  • Object lifetime events: It is often useful to know when the object is first loaded ("loaded" is defined as when an object becomes attached to an object tree that connects to the Windows Phone RootVisual). 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 property-level support for data binding and resources is implemented by the DependencyProperty class, and any DependencyObject can have a DependencyProperty, but the ability to set a value for a potentially inherited data context is implemented by FrameworkElement.

Many common Windows Phone classes derive from FrameworkElement, either directly or through intermediate base classes such as Panel or Control.

It is not common to derive 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 at that level. More commonly used base classes for derived custom classes are:

FrameworkElement provides support for a number of basic scenarios, but also lacks a number of features that are desirable for a "UI element" in the sense of a building block that you use to create UI in XAML. Many of these features are instead implemented on Control, or other immediate subclasses of FrameworkElement.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2014 Microsoft