Share via

UIElement Class

  • Article

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Provides programming components you can use to lay out and render graphical user interface (GUI) items such as shapes, images, and controls on a particular region of a display device's screen.

Inheritance Hierarchy

System. . :: . .Object
  Microsoft.SPOT. . :: . .DispatcherObject
    Microsoft.SPOT.Presentation..::..UIElement
      Microsoft.SPOT.Ink. . :: . .InkCanvas
      Microsoft.SPOT.Presentation.Controls. . :: . .Control
      Microsoft.SPOT.Presentation.Controls. . :: . .Image
      Microsoft.SPOT.Presentation.Controls. . :: . .Panel
      Microsoft.SPOT.Presentation.Controls. . :: . .Text
      Microsoft.SPOT.Presentation.Controls. . :: . .TextFlow
      Microsoft.SPOT.Presentation.Shapes. . :: . .Shape

Namespace:  Microsoft.SPOT.Presentation
Assembly:  Microsoft.SPOT.TinyCore (in Microsoft.SPOT.TinyCore.dll)

Syntax

'Declaration
Public MustInherit Class UIElement _
    Inherits DispatcherObject

public abstract class UIElement : DispatcherObject

public ref class UIElement abstract : public DispatcherObject

[<AbstractClass>]
type UIElement =  
    class
        inherit DispatcherObject
    end

public abstract class UIElement extends DispatcherObject

The UIElement type exposes the following members.

Constructors

  Name Description
Protected method UIElement Initializes a new instance of the UIElement class.

Top

Properties

  Name Description
Public property ActualHeight Gets the rendered height of this element.
Public property ActualWidth Gets the rendered width of this element.
Public property Height Gets or sets the suggested height of this element.
Public property HorizontalAlignment Gets or sets the horizontal alignment characteristics that are applied to this element when it is composed within a parent element, such as a Panel.
Protected property InstanceEventHandlersStore Gets the event-handler store for this element.
Public property IsArrangeValid Gets a value indicating whether the computed size and position of child elements in this element's layout are valid.
Public property IsEnabled Gets or sets a value indicating whether this element is enabled in the user interface (UI).
Public property IsFocused Gets a value that determines whether this element has logical focus.
Public property IsMeasureValid Gets a value indicating whether the current size returned by layout measure is valid.
Public property IsVisible Gets a value indicating whether this element is visible in the user interface (UI).
Protected property LogicalChildren Gets an enumerator for this element's logical child elements.
Public property Parent Gets the logical parent element of this element.
Public property RootUIElement Gets the logical root element of this element.
Public property VerticalAlignment Gets or sets the vertical alignment characteristics that are applied to this element when it is composed within a parent element, such as a Panel.
Public property Visibility Gets or sets the user interface (UI) visibility of this element.
Public property Width Gets or sets the suggested width of this element.

Top

Methods

  Name Description
Public method AddHandler Adds a routed-event handler for a specified routed event, adding the handler to the current element's event handler collection.
Public method AddToEventRoute Adds handlers to the specified event route for the current element's event handler collection.
Public method Arrange Positions child elements in a particular region on the screen.
Protected method ArrangeOverride Positions child elements and determines a size for a UIElement-derived class when implemented in a derived class.
Public method CheckAccess Determines whether the calling thread has access to the current DispatcherObject object. (Inherited from DispatcherObject.)
Public method ChildElementFromPoint Returns the most recently created child control that is located at a specified point on the display.
Public method ContainsPoint Determines whether a specified point is contained by this UIElement.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetDesiredSize Gets the current element's size, as computed during the measure pass of the layout process.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLayoutOffset Gets the current element's offset, relative to the upper-left corner of the screen.
Public method GetMargin Gets the width of the current element's margins.
Public method GetPointerTarget Returns the visible child of this UIElement that contains a specified screen point.
Public method GetRenderSize Gets the final render size of the current element.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetUnclippedSize Returns the unclipped size of this element.
Public method Invalidate Invalidates the rendering of the current element and forces a complete new layout pass.
Public method InvalidateArrange Invalidates the arrange state of the current element's layout.
Public method InvalidateMeasure Invalidates the measurement state of the current element's layout.
Public method InvalidateRect Invalidates the specified rectangle.
Public method Measure Determines the size requirements for the layout of a child element.
Protected method MeasureOverride Determines the custom size requirements for the layout of a child element when implemented in a derived class.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnButtonDown Adds class handling for an unhandled ButtonDownEvent attached event when that event reaches, by way of its route, an element that is derived from the UIElement class.
Protected method OnButtonUp Adds class handling for an unhandled ButtonUpEvent attached event when that event reaches, by way of its route, an element that is derived from the UIElement class.
Protected method OnChildDesiredSizeChanged Supports the layout system when a child element is resized.
Protected method OnChildrenChanged Called when the UIElementCollection of this UIElement is edited.
Protected method OnGenericEvent Called when this UIElement generates a generic event.
Protected method OnGotFocus Adds class handling for an unhandled GotFocusEvent attached event when that event reaches, by way of its route, an element that is derived from the UIElement class.
Protected method OnLostFocus Adds class handling for an unhandled LostFocusEvent attached event when that event reaches, by way of its route, an element that is derived from the UIElement class.
Protected method OnPreviewButtonDown Adds class handling for an unhandled PreviewButtonDownEvent attached event when that event reaches, by way of its route, an element that is derived from the UIElement class.
Protected method OnPreviewButtonUp Adds class handling for an unhandled PreviewButtonUpEvent attached event when that event reaches, by way of its route, an element that is derived from the UIElement class.
Public method OnRender Participates in rendering operations that are directed by the layout system when implemented in a derived class.
Protected method OnTouchDown Handles a touch down (or stylus down) event.
Protected method OnTouchGestureChanged Handles a TouchGestureChanged event.
Protected method OnTouchGestureEnded Handles a TouchGestureEnd event.
Protected method OnTouchGestureStarted Handles a TouchGestureStart event.
Protected method OnTouchMove Invoked when an unhandled TouchMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.
Protected method OnTouchUp Invoked when an unhandled TouchUp attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.
Public method PointToClient Returns the client UIElement that is the top-level ancestor of this UIElement object, and expresses the given point in the coordinate space of that ancestor.
Public method PointToScreen Converts a point expressed in the coordinate space of this UIElement into screen coordinates.
Public method RaiseEvent Raises a specific routed event.
Protected method RenderRecursive Renders this element and all its child elements.
Public method SetMargin(Int32) Sets the size of the current element's margin, using the same (specified) width for each of the four sides of the element.
Public method SetMargin(Int32, Int32, Int32, Int32) Sets the size of the current element's margin, using a specified width for each of the four sides of the element.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method UpdateLayout Ensures that all visual child elements of the current element are properly updated for layout.
Public method VerifyAccess Determines whether the calling thread has access to the current DispatcherObject object. (Inherited from DispatcherObject.)

Top

Events

  Name Description
Public event IsEnabledChanged Occurs when the value of the IsEnabled property changes for the current element.
Public event IsVisibleChanged Occurs when the value of the IsVisible property changes for the current element.
Public event TouchDown Occurs when the user initially touches the tablet screen or puts the tip of the stylus onto the tablet screen.
Public event TouchGestureChanged Indicates that a touch or stylus gesture changed.
Public event TouchGestureEnd Indicates that a touch or stylus gesture ended.
Public event TouchGestureStart Indicates that a touch or stylus gesture started.
Public event TouchMove Occurs when the user's finger or stylus moves while it is touching the tablet.
Public event TouchUp Occurs when the user raises their finger or stylus from the touch screen.

Top

Fields

  Name Description
Protected field _horizontalAlignment Specifies the horizontal alignment characteristics that are applied to the current element when it is composed within a parent element, such as a Panel object.
Protected field _verticalAlignment Specifies the vertical alignment characteristics that are applied to the current element when it is composed within a parent element, such as a Panel object.
Public field Dispatcher Contains the Dispatcher object that the current DispatcherObject object is associated with. (Inherited from DispatcherObject.)

Top

Remarks

The UIElement class is the base class — or the basic Windows Presentation Foundation (WPF) element — from which all display elements derive.

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.

See Also

Reference

Microsoft.SPOT.Presentation Namespace