Export (0) Print
Expand All

Popup Class

Displays content on top of existing Silverlight content, within the bounds of the Silverlight control.

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

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

The Popup type exposes the following members.

  NameDescription
Public methodSupported by Silverlight for Windows PhonePopupInitializes a new instance of the Popup class.
Top

  NameDescription
Public propertySupported by Silverlight for Windows PhoneActualHeightGets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneActualWidthGets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneAllowDropGets 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 PhoneCacheModeGets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneChildGets or sets the content to be hosted in the popup.
Public propertySupported by Silverlight for Windows PhoneClipGets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneCursorGets or sets the cursor image that displays while the mouse pointer is over a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneDataContextGets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneDesiredSizeGets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertyEffectGets or sets the pixel shader effect to use for rendering this UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneFlowDirectionGets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneHeightGets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneHorizontalAlignmentGets 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 propertySupported by Silverlight for Windows PhoneHorizontalOffsetGets or sets the distance between the left side of the Silverlight control and the left side of the popup. 
Public propertySupported by Silverlight for Windows PhoneIsHitTestVisibleGets 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 PhoneIsOpenGets or sets whether the popup is currently displaying on the screen.
Public propertySupported by Silverlight for Windows PhoneLanguageGets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneMarginGets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneMaxHeightGets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneMaxWidthGets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneMinHeightGets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneMinWidthGets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneNameGets 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 propertySupported by Silverlight for Windows PhoneOpacityGets or sets the degree of the object's opacity. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneOpacityMaskGets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneParentGets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneProjectionGets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneRenderSizeGets the final render size of a UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneRenderTransformGets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneRenderTransformOriginGets 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 PhoneResourcesGets 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 propertySupported by Silverlight for Windows PhoneStyleGets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneTagGets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneTriggersGets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneUseLayoutRoundingGets 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 PhoneVerticalAlignmentGets 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 propertySupported by Silverlight for Windows PhoneVerticalOffsetGets or sets the distance between the top of the Silverlight control and the top of the popup.
Public propertySupported by Silverlight for Windows PhoneVisibilityGets 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 PhoneWidthGets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.)
Top

  NameDescription
Public methodSupported by Silverlight for Windows PhoneAddHandlerAdds 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 PhoneArrangePositions 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 PhoneArrangeOverrideProvides the behavior for the Arrange pass of Silverlight layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement.)
Public methodSupported by Silverlight for Windows PhoneCaptureMouseSets mouse capture to a UIElement. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneFinalizeAllows 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 PhoneFindNameRetrieves an object that has the specified identifier name. (Inherited from FrameworkElement.)
Public methodSupported by Silverlight for Windows PhoneGetAnimationBaseValueReturns 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 PhoneGetBindingExpressionRetrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.)
Public methodSupported by Silverlight for Windows PhoneGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneInvalidateArrangeInvalidates 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 PhoneInvalidateMeasureInvalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneMeasureUpdates 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 PhoneMeasureOverrideProvides the behavior for the Measure pass of Silverlight layout. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement.)
Protected methodSupported by Silverlight for Windows PhoneMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneOnApplyTemplateWhen 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 methodSupported by Silverlight for Windows PhoneOnCreateAutomationPeerWhen implemented in a derived class, returns class-specific AutomationPeer implementations for the Silverlight automation infrastructure. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneReleaseMouseCaptureRemoves mouse capture from a UIElement. After this call, typically no object holds mouse capture. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneRemoveHandlerRemoves the specified routed event handler from this UIElement. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneSetBindingAttaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.)
Public methodSupported by Silverlight for Windows PhoneSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodSetWindowSets the window that is the parent of the Popup control.
Public methodSupported by Silverlight for Windows PhoneToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneTransformToVisualReturns 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 PhoneUpdateLayoutEnsures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.)
Top

  NameDescription
Public eventSupported by Silverlight for Windows PhoneBindingValidationErrorOccurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.)
Public eventSupported by Silverlight for Windows PhoneClosedOccurs when the IsOpen property is set to false.
Public eventDataContextChangedOccurs when the data context for this element changes. (Inherited from FrameworkElement.)
Public eventSupported by Silverlight for Windows PhoneDoubleTapOccurs when a DoubleTap gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventDragEnterOccurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement.)
Public eventDragLeaveOccurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement.)
Public eventDragOverOccurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement.)
Public eventDropOccurs 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 PhoneGotFocusOccurs when a UIElement receives focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneHoldOccurs when a Hold gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneKeyDownOccurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneKeyUpOccurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneLayoutUpdatedOccurs when the layout of the Silverlight visual tree changes. (Inherited from FrameworkElement.)
Public eventSupported by Silverlight for Windows PhoneLoadedOccurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.)
Public eventSupported by Silverlight for Windows PhoneLostFocusOccurs when a UIElement loses focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneLostMouseCaptureOccurs when the UIElement loses mouse capture. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneManipulationCompletedOccurs when a manipulation and inertia on the UIElement is complete. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneManipulationDeltaOccurs when the input device changes position during a manipulation. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneManipulationStartedOccurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement.)
Public eventMediaCommandOccurs when a button is pressed on a remote control. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneMouseEnterOccurs when the mouse (or a stylus) enters the bounding area of a UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneMouseLeaveOccurs when the mouse (or the stylus) leaves the bounding area of a UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneMouseLeftButtonDownOccurs 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 PhoneMouseLeftButtonUpOccurs 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 PhoneMouseMoveOccurs 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 eventMouseRightButtonDownOccurs when the right mouse button is pressed while the mouse pointer is over a UIElement. (Inherited from UIElement.)
Public eventMouseRightButtonUpOccurs 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 PhoneMouseWheelOccurs 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 PhoneOpenedOccurs when the IsOpen property is set to true.
Public eventSupported by Silverlight for Windows PhoneSizeChangedOccurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.)
Public eventSupported by Silverlight for Windows PhoneTapOccurs when a Tap gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneTextInputOccurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneTextInputStartOccurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneTextInputUpdateOccurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneUnloadedOccurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.)
Top

  NameDescription
Public fieldStatic memberSupported by Silverlight for Windows PhoneChildPropertyGets the identifier for the Child dependency property.
Public fieldStatic memberSupported by Silverlight for Windows PhoneHorizontalOffsetPropertyGets the identifier for the HorizontalOffset dependency property.
Public fieldStatic memberSupported by Silverlight for Windows PhoneIsOpenPropertyGets the identifier for the IsOpen dependency property.
Public fieldStatic memberSupported by Silverlight for Windows PhoneVerticalOffsetPropertyGets 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 when the user moves the mouse pointer over a particular control. The content of the Popup is set using its Child property, and can be any UIElement. Setting the Child property of Popup to a control with an x:Name attribute causes an exception when you create more than one instance of the Popup. This happens 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 Silverlight plug-in, 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 Silverlight plug-in, 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).

To show a ToolTip for a control, see ToolTip and ToolTipService. To create a custom dialog, see ChildWindow.

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 = 25;
    p.HorizontalOffset = 25;

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

}

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

}



<UserControl x:Class="Popup2.Page"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" 
    FontFamily="Trebuchet MS" FontSize="11"
    Width="200" Height="200">

        <StackPanel x:Name="LayoutRoot" Background="White">
            <Button Width="100" Height="50" x:Name="showPopup" 
            Click="showPopup_Click" Content="Show Popup" />
        </StackPanel>
</UserControl>


Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

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

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

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

Community Additions

ADD
Show:
© 2014 Microsoft