Поделиться через

  • Статья

FrameworkElement Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public MustInherit Class FrameworkElement _
    Inherits UIElement

public abstract class FrameworkElement : UIElement

The FrameworkElement type exposes the following members.

Constructors

  Name Description
Protected methodSupported by Silverlight for Windows Phone FrameworkElement Initializes a new instance of the FrameworkElement class.

Top

Properties

  Name Description
Public propertySupported by Silverlight for Windows Phone ActualHeight Gets the rendered height of a FrameworkElement.
Public propertySupported by Silverlight for Windows Phone ActualWidth Gets the rendered width of a FrameworkElement.
Public propertySupported by Silverlight for Windows Phone AllowDrop Gets or sets a value that determines whether this UIElement can be a drop target for purposes of Silverlight drag-and-drop operations. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone CacheMode Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone Clip Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone Cursor Gets or sets the cursor image that displays while the mouse pointer is over a FrameworkElement.
Public propertySupported by Silverlight for Windows Phone DataContext Gets or sets the data context for a FrameworkElement when it participates in data binding.
Public propertySupported by Silverlight for Windows Phone DesiredSize Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone Dispatcher Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public property Effect Gets or sets the pixel shader effect to use for rendering this UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone FlowDirection Gets or sets the direction that text and other user interface elements flow within any parent element that controls their layout.
Public propertySupported by Silverlight for Windows Phone Height Gets or sets the suggested height of a FrameworkElement.
Public propertySupported by Silverlight for Windows Phone 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.
Public propertySupported by Silverlight for Windows Phone IsHitTestVisible Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone Language Gets or sets localization/globalization language information that applies to a FrameworkElement.
Public propertySupported by Silverlight for Windows Phone Margin Gets or sets the outer margin of a FrameworkElement.
Public propertySupported by Silverlight for Windows Phone MaxHeight Gets or sets the maximum height constraint of a FrameworkElement.
Public propertySupported by Silverlight for Windows Phone MaxWidth Gets or sets the maximum width constraint of a FrameworkElement.
Public propertySupported by Silverlight for Windows Phone MinHeight Gets or sets the minimum height constraint of a FrameworkElement.
Public propertySupported by Silverlight for Windows Phone MinWidth Gets or sets the minimum width constraint of a FrameworkElement.
Public propertySupported by Silverlight for Windows Phone 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.
Public propertySupported by Silverlight for Windows Phone Opacity Gets or sets the degree of the object's opacity. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone OpacityMask Gets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone Parent Gets the parent object of this FrameworkElement in the object tree.
Public propertySupported by Silverlight for Windows Phone Projection Gets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone RenderSize Gets the final render size of a UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone RenderTransform Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone 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.)
Public propertySupported by Silverlight for Windows Phone 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.
Public propertySupported by Silverlight for Windows Phone Style Gets or sets an instance Style that is applied for this object during rendering.
Public propertySupported by Silverlight for Windows Phone Tag Gets or sets an arbitrary object value that can be used to store custom information about this object.
Public propertySupported by Silverlight for Windows Phone Triggers Gets the collection of triggers for animations that are defined for a FrameworkElement.
Public propertySupported by Silverlight for Windows Phone 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.)
Public propertySupported by Silverlight for Windows Phone 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.
Public propertySupported by Silverlight for Windows Phone Visibility Gets 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 propertySupported by Silverlight for Windows Phone Width Gets or sets the width of a FrameworkElement.

Top

Methods

  Name Description
Public methodSupported by Silverlight for Windows Phone 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 for routed event that had already been marked as handled by another element along the event route. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows Phone 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.)
Protected methodSupported by Silverlight for Windows Phone ArrangeOverride Provides the behavior for the Arrange pass of Silverlight layout. Classes can override this method to define their own Arrange pass behavior.
Public methodSupported by Silverlight for Windows Phone CaptureMouse Sets mouse capture to a UIElement. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows Phone CheckAccess Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows Phone Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone FindName Retrieves an object that has the specified identifier name.
Public methodSupported by Silverlight for Windows Phone GetAnimationBaseValue Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone GetBindingExpression Retrieves the BindingExpression for a dependency property where a binding is established.
Public methodSupported by Silverlight for Windows Phone GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetType Gets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone 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.)
Public methodSupported by Silverlight for Windows Phone InvalidateMeasure Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows Phone 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.)
Protected methodSupported by Silverlight for Windows Phone MeasureOverride Provides the behavior for the Measure pass of Silverlight layout. Classes can override this method to define their own Measure pass behavior.
Protected methodSupported by Silverlight for Windows Phone MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone OnApplyTemplate When 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 methodSupported by Silverlight for Windows Phone OnCreateAutomationPeer When implemented in a derived class, returns class-specific AutomationPeer implementations for the Silverlight automation infrastructure. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows Phone ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone ReleaseMouseCapture Removes mouse capture from a UIElement. After this call, typically no object holds mouse capture. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows Phone RemoveHandler Removes the specified routed event handler from this UIElement. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows Phone SetBinding Attaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use.
Public methodSupported by Silverlight for Windows Phone SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone ToString Returns a string that represents the current object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone TransformToVisual Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows Phone UpdateLayout Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.)

Top

Events

  Name Description
Public eventSupported by Silverlight for Windows Phone BindingValidationError Occurs when a data validation error is reported by a binding source.
Public event DataContextChanged Occurs when the data context for this element changes.
Public eventSupported by Silverlight for Windows Phone DoubleTap Occurs when a DoubleTap gesture is committed while over this UIElement. (Inherited from UIElement.)
Public event DragEnter Occurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement.)
Public event DragLeave Occurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement.)
Public event DragOver Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement.)
Public event Drop Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone GotFocus Occurs when a UIElement receives focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone Hold Occurs when a Hold gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone KeyDown Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone KeyUp Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone LayoutUpdated Occurs when the layout of the Silverlight visual tree changes.
Public eventSupported by Silverlight for Windows Phone Loaded Occurs when a FrameworkElement has been constructed and added to the object tree.
Public eventSupported by Silverlight for Windows Phone LostFocus Occurs when a UIElement loses focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone LostMouseCapture Occurs when the UIElement loses mouse capture. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone ManipulationCompleted Occurs when a manipulation and inertia on the UIElement is complete. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone ManipulationDelta Occurs when the input device changes position during a manipulation. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone ManipulationStarted Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement.)
Public event MediaCommand Occurs when a button is pressed on a remote control. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone MouseEnter Occurs when the mouse (or a stylus) enters the bounding area of a UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone MouseLeave Occurs when the mouse (or the stylus) leaves the bounding area of a UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone MouseLeftButtonDown Occurs when the left mouse button is pressed (or when the tip of the stylus touches the tablet) while the mouse pointer is over a UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone MouseLeftButtonUp Occurs when the left mouse button is released (or the tip of the stylus is removed from the tablet) while the mouse (or the stylus) is over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone MouseMove Occurs when the coordinate position of the mouse (or stylus) changes while over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.)
Public event MouseRightButtonDown Occurs when the right mouse button is pressed while the mouse pointer is over a UIElement. (Inherited from UIElement.)
Public event MouseRightButtonUp Occurs when the right mouse button is released while the mouse pointer is over a UIElement. However, this event will only be raised if a caller marks the preceding MouseRightButtonDown event as handled; see Remarks. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone MouseWheel 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 eventSupported by Silverlight for Windows Phone SizeChanged Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement.
Public eventSupported by Silverlight for Windows Phone Tap Occurs when a Tap gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone TextInput Occurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone TextInputStart Occurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone TextInputUpdate Occurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone Unloaded Occurs when this object is no longer connected to the main object tree.

Top

Fields

  Name Description
Public fieldStatic memberSupported by Silverlight for Windows Phone ActualHeightProperty Identifies the ActualHeight dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone ActualWidthProperty Identifies the ActualWidth dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone CursorProperty Identifies the Cursor dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone DataContextProperty Identifies the DataContext dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone FlowDirectionProperty Identifies the FlowDirection dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone HeightProperty Identifies the Height dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone HorizontalAlignmentProperty Identifies the HorizontalAlignment dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone LanguageProperty Identifies the Language dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone LoadedEvent Identifies the Loaded routed event.
Public fieldStatic memberSupported by Silverlight for Windows Phone MarginProperty Identifies the Margin dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone MaxHeightProperty Identifies the MaxHeight dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone MaxWidthProperty Identifies the MaxWidth dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone MinHeightProperty Identifies the MinHeight dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone MinWidthProperty Identifies the MinWidth dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone NameProperty Identifies the Name dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone StyleProperty Identifies the Style dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone TagProperty Identifies the Tag dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone VerticalAlignmentProperty Identifies the VerticalAlignment dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone WidthProperty Identifies the Width dependency property.

Top

Remarks

FrameworkElement extends UIElement and adds the following capabilities:

  • Layout: Similar to WPF, Silverlight 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 Silverlight 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 Silverlight 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.

JavaScript API Note

In the JavaScript API for Silverlight, the UIElement object combines the members of UIElement and FrameworkElement.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

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

Inheritance Hierarchy

System.Object
  System.Windows.DependencyObject
    System.Windows.UIElement
      System.Windows.FrameworkElement
        Microsoft.Internal.Pivot.Controls.VisualTreeGraft
        System.Windows.Controls.Border
        System.Windows.Controls.ContentPresenter
        System.Windows.Controls.Control
        System.Windows.Controls.DrawingSurface
        System.Windows.Controls.Image
        System.Windows.Controls.ItemsPresenter
        System.Windows.Controls.MediaElement
        System.Windows.Controls.MultiScaleImage
        System.Windows.Controls.Panel
        System.Windows.Controls.Primitives.Popup
        System.Windows.Controls.RichTextBlock
        System.Windows.Controls.RichTextBlockOverflow
        System.Windows.Controls.TextBlock
        System.Windows.Controls.Viewbox
        System.Windows.Controls.WebBrowser
        System.Windows.Documents.Glyphs
        System.Windows.Shapes.Shape