Popup Class

May 11, 2014

Displays content on top of existing application content.

System.Object
  System.Windows.DependencyObject
    System.Windows.UIElement
      System.Windows.FrameworkElement
        System.Windows.Controls.Primitives.Popup

Namespace:  System.Windows.Controls.Primitives
Assembly:  System.Windows (in System.Windows.dll)
XMLNS for XAML: Not mapped to an xmlns.

[ContentPropertyAttribute("Child", true)]
public sealed class Popup : FrameworkElement

The Popup type exposes the following members.

  NameDescription
Public methodPopupInitializes a new instance of the Popup class.
Top

  NameDescription
Public propertyActualHeightGets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyActualWidthGets the rendered width of a FrameworkElement. (Inherited from 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 propertyChildGets or sets the content to be hosted in the popup.
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. (Inherited from FrameworkElement.)
Public propertyDataContextGets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.)
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. (Inherited from FrameworkElement.)
Public propertyHeightGets or sets the suggested height of a FrameworkElement. (Inherited from 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. (Inherited from FrameworkElement.)
Public propertyHorizontalOffsetGets or sets the distance between the left side of the application and the left side of the popup. 
Public propertyIsHitTestVisibleGets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.)
Public propertyIsOpenGets or sets whether the popup is currently displaying on the screen.
Public propertyLanguageGets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMarginGets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMaxHeightGets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMaxWidthGets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMinHeightGets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMinWidthGets or sets the minimum width constraint of a FrameworkElement. (Inherited from 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. (Inherited from FrameworkElement.)
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. (Inherited from FrameworkElement.)
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. (Inherited from FrameworkElement.)
Public propertyStyleGets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
Public propertyTagGets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.)
Public propertyTriggersGets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from 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. (Inherited from FrameworkElement.)
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. (Inherited from FrameworkElement.)
Public propertyVerticalOffsetGets or sets the distance between the top of the application and the top of the popup.
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. (Inherited from 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. (Inherited from FrameworkElement.)
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. (Inherited from FrameworkElement.)
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. (Inherited from FrameworkElement.)
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. (Inherited from FrameworkElement.)
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. (Inherited from FrameworkElement.)
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. (Inherited from FrameworkElement.)
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. (Inherited from FrameworkElement.)
Public eventClosedOccurs when the IsOpen property is set to false.
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. (Inherited from FrameworkElement.)
Public eventLoadedOccurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.)
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 eventOpenedOccurs when the IsOpen property is set to true.
Public eventSizeChangedOccurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from 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. (Inherited from FrameworkElement.)
Top

  NameDescription
Public fieldStatic memberChildPropertyGets the identifier for the Child dependency property.
Public fieldStatic memberHorizontalOffsetPropertyGets the identifier for the HorizontalOffset dependency property.
Public fieldStatic memberIsOpenPropertyGets the identifier for the IsOpen dependency property.
Public fieldStatic memberVerticalOffsetPropertyGets the identifier for the VerticalOffset dependency property.
Top

You typically use the Popup class to temporarily display content that accomplishes a particular task. For example, you might use a popup to display help information or an error to the user. The content of the Popup is set using its Child property, and can be any UIElement. If the Child property is set to a control with its name attribute set, you cannot create more than one instance of the Popup or an exception will occur. This is because two items with the same name cannot exist in the visual tree.

You would typically create a user control to host the popup content, but this is not required. A popup will always appear within the bounds of the current application, but on top of the existing content, including other popup controls. 

You set the position of a Popup, relative to the upper left corner of the application, using the VerticalOffset and HorizontalOffset properties.

Scaling and transforms applied to the parent control of a Popup will be applied to the Popup as well.

NoteNote:

In some cases, declaring and adding controls in code to a Popup and making the Popup visible by setting the IsOpen property to true in code, will cause a runtime error. This happens because the children of the Popup are in the visual tree, but the Popup control is not. To avoid a runtime error, add the Popup to the visual tree by declaring it in XAML or by calling LayoutRoot.Children.Add(popupInstance).

XAML Usage of Popup

As mentioned earlier, typically you create a Popup as part of a user control's logic. However you can create a Popup in XAML. For example, you might define the visual appearance of the Popup as a resource in a XAML ResourceDictionary.

The following example shows how to use a Popup to display a border that contains a text block and a button. The popup content is created inline for conciseness, but you would typically create this content in a separate user control and use an instance of that control as the child of the popup.


// Create the popup object.
Popup p = new Popup();
private void showPopup_Click(object sender, RoutedEventArgs e)
{
    // Create some content to show in the popup. Typically you would 
    // create a user control.
    Border border = new Border();
    border.BorderBrush = new SolidColorBrush(Colors.Black);
    border.BorderThickness = new Thickness(5.0);

    StackPanel panel1 = new StackPanel();
    panel1.Background = new SolidColorBrush(Colors.LightGray);

    Button button1 = new Button();
    button1.Content = "Close";
    button1.Margin = new Thickness(5.0);
    button1.Click += new RoutedEventHandler(button1_Click);
    TextBlock textblock1 = new TextBlock();
    textblock1.Text = "The popup control";
    textblock1.Margin = new Thickness(5.0);
    panel1.Children.Add(textblock1);
    panel1.Children.Add(button1);
    border.Child = panel1;

    // Set the Child property of Popup to the border 
    // which contains a stackpanel, textblock and button.
    p.Child = border;

    // Set where the popup will show up on the screen.
    p.VerticalOffset = 150;
    p.HorizontalOffset = 150;

    // Open the popup.
    p.IsOpen = true;

}

void button1_Click(object sender, RoutedEventArgs e)
{
    // Close the popup.
    p.IsOpen = false;

}



<phone:PhoneApplicationPage x:Class="Popup2.Page"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:phone="clr-namespace:Microsoft.Phone.Controls;assembly=Microsoft.Phone"
xmlns:shell="clr-namespace:Microsoft.Phone.Shell;assembly=Microsoft.Phone" 
    FontFamily="Trebuchet MS" FontSize="11" mc:Ignorable="d" xmlns:d="http://schemas.microsoft.com/expression/blend/2008" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" d:DesignHeight="800" d:DesignWidth="480">

        <StackPanel x:Name="LayoutRoot" Background="Transparent">
            <Button x:Name="showPopup" 
            Click="showPopup_Click" Content="Show Popup" />
        </StackPanel>
</phone:PhoneApplicationPage>


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