OverlayControl Methods

Adds a specified object as the child of a ContentControl.

Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element.

Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as to have the provided handler be invoked for routed event that had already been marked as handled by another element along the event route.

Adds the provided object to the logical tree of this element.

Adds a specified text string to a ContentControl.

Adds handlers to the specified EventRoute for the current UIElement event handler collection.

Defines the parent-child relationship between two visuals.

Applies an animation to a specified dependency property on this element. Any existing animations are stopped and replaced with the new animation.

Applies an animation to a specified dependency property on this element, with the ability to specify what happens if the property already has a running animation.

Builds the current template's visual tree if necessary, and returns a value that indicates whether the visual tree was rebuilt by this call.

Positions child elements and determines a size for a UIElement. Parent elements call this method from their ArrangeCore(Rect) implementation (or a WPF framework-level equivalent) to form a recursive layout update. This method constitutes the second pass of a layout update.

Implements ArrangeCore(Rect) (defined as virtual in UIElement) and seals the implementation.

Called to arrange and size the content of a Control object.

Starts an animation for a specified animated property on this element.

Starts a specific animation for a specified animated property on this element, with the option of specifying what happens if the property already has a running animation.

Starts the initialization process for this element.

Begins the sequence of actions that are contained in the provided storyboard.

Begins the sequence of actions contained in the provided storyboard, with options specified for what should happen if the property is already animated.

Begins the sequence of actions contained in the provided storyboard, with specified state for control of the animation after it is started.

Attempts to bring this element into view, within any scrollable regions it is contained within.

Attempts to bring the provided region size of this element into view, within any scrollable regions it is contained within.

Attempts to force capture of the mouse to this element.

Attempts to force capture of the stylus to this element.

Attempts to force capture of a touch to this element.

Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier.

Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey.

Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.

Indicates that the initialization process for the element is complete.

Determines whether a provided DependencyObject is equivalent to the current DependencyObject.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Returns the common ancestor of two visual objects.

Finds an element that has the provided identifier name.

Searches for a resource with the specified key, and throws an exception if the requested resource is not found.

Attempts to set focus to this element.

Returns the base property value for the specified property on this element, disregarding any possible animated value from a running or stopped animation.

Returns the BindingExpression that represents the binding on the specified property.

Gets a hash code for this DependencyObject.

Returns a geometry for a clipping mask. The mask applies if the layout system attempts to arrange an element that is larger than the available display space.

Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.

Returns the named element in the visual tree of an instantiated ControlTemplate.

Gets the Type of the current instance.

Returns an alternative logical parent for this element if there is no visual parent.

Returns the current effective value of a dependency property on this instance of a DependencyObject.

Overrides GetVisualChild(Int32), and returns a child at the specified index from a collection of child elements.

Implements HitTestCore(PointHitTestParameters) to supply base element hit testing behavior (returning HitTestResult).

Implements HitTestCore(GeometryHitTestParameters) to supply base element hit testing behavior (returning GeometryHitTestResult).

Returns the input element within the current element that is at the specified coordinates, relative to the current element's origin.

Invalidates the arrange state (layout) for the element. After the invalidation, the element will have its layout updated, which will occur asynchronously unless subsequently forced by UpdateLayout.

Invalidates the measurement state (layout) for the element.

Re-evaluates the effective value for the specified dependency property

Invalidates the rendering of the element, and forces a complete new layout pass. OnRender(DrawingContext) is called after the layout cycle is completed.

Determines whether the visual object is an ancestor of the descendant visual object.

Determines whether the visual object is a descendant of the ancestor visual object.

Updates the DesiredSize of a UIElement. Parent elements call this method from their own MeasureCore(Size) implementations to form a recursive layout update. Calling this method constitutes the first pass (the "Measure" pass) of a layout update.

Implements basic measure-pass layout system behavior for FrameworkElement.

Called to remeasure a control.

Creates a shallow copy of the current Object.

Moves the keyboard focus away from this element and to another element in a provided traversal direction.

Provides class handling for when an access key that is meaningful for this element is invoked.

Supports layout behavior when a child element is resized.

Called when the Content property changes.

Occurs when the ContentStringFormat property changes.

Called when the ContentTemplate property changes.

Called when the ContentTemplateSelector property changes.

Invoked whenever an unhandled ContextMenuClosing routed event reaches this class in its route. Implement this method to add class handling for this event.

Invoked whenever an unhandled ContextMenuOpening routed event reaches this class in its route. Implement this method to add class handling for this event.

Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

Invoked when an unhandled DragEnter attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled DragLeave attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled DragOver attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled DragEnter attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled GiveFeedback attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked whenever an unhandled GotFocus event reaches this element in its route.

Invoked when an unhandled GotKeyboardFocus attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled GotMouseCapture attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled GotStylusCapture attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Provides class handling for the GotTouchCapture routed event that occurs when a touch is captured to this element.

Raises the Initialized event. This method is invoked whenever IsInitialized is set to true internally.

Invoked when an unhandled IsKeyboardFocusedChanged event is raised on this element. Implement this method to add class handling for this event.

Invoked just before the IsKeyboardFocusWithinChanged event is raised by this element. Implement this method to add class handling for this event.

Invoked when an unhandled IsMouseCapturedChanged event is raised on this element. Implement this method to add class handling for this event.

Invoked when an unhandled IsMouseCaptureWithinChanged event is raised on this element. Implement this method to add class handling for this event.

Invoked when an unhandled IsMouseDirectlyOverChanged event is raised on this element. Implement this method to add class handling for this event.

Invoked when an unhandled IsStylusCapturedChanged event is raised on this element. Implement this method to add class handling for this event.

Invoked when an unhandled IsStylusCaptureWithinChanged event is raised on this element. Implement this method to add class handling for this event.

Invoked when an unhandled IsStylusDirectlyOverChanged event is raised on this element. Implement this method to add class handling for this event.

Invoked when an unhandled KeyDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled KeyUp attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Raises the LostFocus routed event by using the event data that is provided.

Invoked when an unhandled LostKeyboardFocus attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled LostMouseCapture attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled LostStylusCapture attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Provides class handling for the LostTouchCapture routed event that occurs when this element loses a touch capture.

Called when the ManipulationBoundaryFeedback event occurs.

Called when the ManipulationCompleted event occurs.

Called when the ManipulationDelta event occurs.

Called when the ManipulationInertiaStarting event occurs.

Called when the ManipulationStarted event occurs.

Provides class handling for the ManipulationStarting routed event that occurs when the manipulation processor is first created.

Raises the MouseDoubleClick routed event.

Invoked when an unhandled MouseDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled MouseEnter attached event is raised on this element. Implement this method to add class handling for this event.

Invoked when an unhandled MouseLeave attached event is raised on this element. Implement this method to add class handling for this event.

Invoked when an unhandled MouseLeftButtonDown routed event is raised on this element. Implement this method to add class handling for this event.

Invoked when an unhandled MouseLeftButtonUp routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled MouseMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled MouseRightButtonDown routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled MouseRightButtonUp routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled MouseUp routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled MouseWheel attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewDragEnter attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewDragLeave attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewDragOver attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewDrop attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewGiveFeedback attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewGotKeyboardFocus attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewKeyDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewKeyUp attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewKeyDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Raises the PreviewMouseDoubleClick routed event.

Invoked when an unhandled PreviewMouseDown attached routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewMouseLeftButtonDown routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewMouseLeftButtonUp routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewMouseMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewMouseRightButtonDown routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewMouseRightButtonUp routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewMouseUp attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewMouseWheel attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewQueryContinueDrag attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewStylusButtonDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewStylusButtonUp attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewStylusDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewStylusInAirMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewStylusInRange attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewStylusMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewStylusOutOfRange attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewStylusSystemGesture attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewStylusUp attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled PreviewTextInput attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Provides class handling for the PreviewTouchDown routed event that occurs when a touch presses this element.

Provides class handling for the PreviewTouchMove routed event that occurs when a touch moves while inside this element.

Provides class handling for the PreviewTouchUp routed event that occurs when a touch is released inside this element.

Invoked whenever the effective value of any dependency property on this FrameworkElement has been updated. The specific dependency property that changed is reported in the arguments parameter. Overrides OnPropertyChanged(DependencyPropertyChangedEventArgs).

Invoked when an unhandled QueryContinueDrag attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled QueryCursor attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

When overridden in a derived class, participates in rendering operations that are directed by the layout system. The rendering instructions for this element are not used directly when this method is invoked, and are instead preserved for later asynchronous use by layout and drawing.

Raises the SizeChanged event, using the specified information as part of the eventual event data.

Invoked when the style in use on this element changes, which will invalidate the layout.

Invoked when an unhandled StylusButtonDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled StylusButtonUp attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled StylusDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled StylusEnter attached event is raised by this element. Implement this method to add class handling for this event.

Invoked when an unhandled StylusInAirMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled StylusInRange attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled StylusLeave attached event is raised by this element. Implement this method to add class handling for this event.

Invoked when an unhandled StylusMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled StylusOutOfRange attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled StylusSystemGesture attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked when an unhandled StylusUp attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Called whenever the control's template changes.

Invoked when an unhandled TextInput attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Invoked whenever an unhandled ToolTipClosing routed event reaches this class in its route. Implement this method to add class handling for this event.

Invoked whenever the ToolTipOpening routed event reaches this class in its route. Implement this method to add class handling for this event.

Provides class handling for the TouchDown routed event that occurs when a touch presses inside this element.

Provides class handling for the TouchEnter routed event that occurs when a touch moves from outside to inside the bounds of this element.

Provides class handling for the TouchLeave routed event that occurs when a touch moves from inside to outside the bounds of this UIElement.

Provides class handling for the TouchMove routed event that occurs when a touch moves while inside this element.

Provides class handling for the TouchUp routed event that occurs when a touch is released inside this element.

Called when the VisualCollection of the visual object is modified.

Invoked when the parent of this element in the visual tree is changed. Overrides OnVisualParentChanged(DependencyObject).

Supports incremental layout implementations in specialized subclasses of FrameworkElement. ParentLayoutInvalidated(UIElement) is invoked when a child element has invalidated a property that is marked in metadata as affecting the parent's measure or arrange passes during layout.

Converts a Point in screen coordinates into a Point that represents the current coordinate system of the Visual.

Converts a Point that represents the current coordinate system of the Visual into a Point in screen coordinates.

Determines the next element that would receive focus relative to this element for a provided focus movement direction, but does not actually move the focus.

Raises a specific routed event. The RoutedEvent to be raised is identified within the RoutedEventArgs instance that is provided (as the RoutedEvent property of that event data).

Returns the local value of a dependency property, if it exists.

Provides an accessor that simplifies access to the NameScope registration method.

Releases all captured touch devices from this element.

Releases the mouse capture, if this element held the capture.

Releases the stylus device capture, if this element held the capture.

Attempts to release the specified touch device from this element.

Removes the specified routed event handler from this element.

Removes the provided object from this element's logical tree. FrameworkElement updates the affected logical tree parent pointers to keep in sync with this deletion.

Removes the parent-child relationship between two visuals.

Attaches a binding to this element, based on the provided binding object.

Attaches a binding to this element, based on the provided source property name as a path qualification to the data source.

Sets the value of a dependency property without changing its value source.

Searches for a resource with the specified name and sets up a resource reference to it for the specified property.

Sets the local value of a dependency property, specified by its dependency property identifier.

Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property.

Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.

Returns the string representation of a Control object.

Returns a transform that can be used to transform coordinates from the Visual to the specified Visual ancestor of the visual object.

Returns a transform that can be used to transform coordinates from the Visual to the specified Visual3D ancestor of the visual object.

Returns a transform that can be used to transform coordinates from the Visual to the specified visual object descendant.

Returns a transform that can be used to transform coordinates from the Visual to the specified visual object.

Translates a point relative to this element to coordinates that are relative to the specified element.

Searches for a resource with the specified key, and returns that resource if found.

Simplifies access to the NameScope de-registration method.

Reapplies the default style to the current FrameworkElement.

Ensures that all visual child elements of this element are properly updated for layout.