Panel.SetZIndex(UIElement, Int32) Panel.SetZIndex(UIElement, Int32) Panel.SetZIndex(UIElement, Int32) Panel.SetZIndex(UIElement, Int32) Method

Definition

Sets the value of the ZIndex attached property for a given element.

public:
 static void SetZIndex(System::Windows::UIElement ^ element, int value);
public static void SetZIndex (System.Windows.UIElement element, int value);
static member SetZIndex : System.Windows.UIElement * int -> unit
Public Shared Sub SetZIndex (element As UIElement, value As Integer)
Parameters
element
UIElement UIElement UIElement UIElement

The element on which to apply the property value.

value
Int32 Int32 Int32 Int32

The order on the z-plane in which this element appears.

Exceptions

Examples

The following example demonstrates in code how to set the value of the ZIndex property (by using the SetZIndex method).

Canvas::SetTop(myRectangle2, 150);
Canvas::SetLeft(myRectangle2, 150);
Canvas::SetZIndex(myRectangle2, 1);
myRectangle2->Fill = Brushes::Yellow;
myRectangle2->Width = 100;
myRectangle2->Height = 100;
Canvas.SetTop(myRectangle2, 150);
Canvas.SetLeft(myRectangle2, 150);
Canvas.SetZIndex(myRectangle2, 1);
myRectangle2.Fill = Brushes.Yellow;
myRectangle2.Width = 100;
myRectangle2.Height = 100;
Canvas.SetTop(myRectangle2, 150)
Canvas.SetLeft(myRectangle2, 150)
Canvas.SetZIndex(myRectangle2, 1)
myRectangle2.Fill = Brushes.Yellow
myRectangle2.Width = 100
myRectangle2.Height = 100

Remarks

The greater the value of a given element, the more likely the element is to appear in the foreground. Likewise, if an element has a relatively low value, the element will likely appear in the background. For example, an element that has a value of 5 will appear above an element that has a value of 4, which in turn will appear above an element that has a value of 3, and so on. Negative values are allowed, and they continue this precedence pattern.

Members of a Children collection that have equal ZIndex values are rendered in the order in which they appear in the visual tree. You can determine the index position of a child by iterating the members of the Children collection.

Applies to