Share via


IXRPopup (Compact 2013)

3/28/2014

This class displays content over existing content.

Syntax

class IXRPopup : public IXRFrameworkElement

Inheritance Hierarchy

IXRDependencyObject

  IXRUIElement

    IXRFrameworkElement

      IXRPopup

Methods

In addition to the methods inherited from IXRFrameworkElement, this class exposes the following methods.

Name

Description

IXRPopup::AddClosedEventHandler

Attaches a delegate to the Closed event for this popup.

IXRPopup::AddOpenedEventHandler

Attaches a delegate to the Opened event for this popup.

IXRPopup::GetChild

Retrieves the content to be hosted in the popup.

IXRPopup::GetHorizontalOffset

Retrieves the distance between the left side of the parent control and the left side of the popup.

IXRPopup::GetIsOpen

Retrieves whether the popup is currently displaying on the screen.

IXRPopup::GetVerticalOffset

Retrieves the distance between the top of the parent control and the top of the popup.

IXRPopup::RemoveClosedEventHandler

Removes a delegate from the Closed event for this popup.

IXRPopup::RemoveOpenedEventHandler

Removes a delegate from the Opened event for this popup.

IXRPopup::SetChild

Sets the content to be hosted in the popup.

IXRPopup::SetHorizontalOffset

Sets the distance between the left side of the parent control and the left side of the popup.

IXRPopup::SetIsOpen

Sets whether the popup is to be displayed on the screen.

IXRPopup::SetVerticalOffset

Sets the distance between the top of the parent control and the top of the popup.

Thread Safety

Members of this class are thread-safe if you previously called IXRApplication::CreateHostFromXaml and supplied it with an XRWindowCreateParams structure that has AllowsMultipleThreadAccess set to true.

Remarks

You typically use the IXRPopup class to temporarily display content that performs a particular task. For example, you might use a popup to display help information when the user moves the mouse pointer over a particular control. The content of the IXRPopup is set by using its Child property, and can be any IXRUIElement.

You would typically create a user control to host the popup content, but this is not required. A popup will always appear over the existing content. This includes other popup controls. When you apply scaling or transforms to the parent control of an IXRPopup they are also applied to the popup.

When you create a class instance, use an IXRPopupPtr smart pointer instead of a raw interface pointer. For more information, see XRPtr<Interface>.

You can also define an IXRPopup object in Microsoft Silverlight 3 XAML. For information about the differences between XAML in XAML for Windows Embedded and Silverlight 3, see Differences Between Microsoft Silverlight 3 and XAML for Windows Embedded. For more information about how to define this element in the source XAML for your application, see the Popup Class on MSDN.

.NET Framework Equivalent

System.Windows.Controls.Primitives.Popup

Requirements

Header

XamlRuntime.h

sysgen

SYSGEN_XAML_RUNTIME

See Also

Reference

Classes for UI Element Management