Panel.SetZIndex Method

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

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

static member SetZIndex : 
        element:UIElement * 
        value:int -> unit

Parameters

element
Type: System.Windows.UIElement

The element on which to apply the property value.

value
Type: System.Int32

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

ExceptionCondition
ArgumentNullException

The element is a null reference (Nothing in Visual Basic).

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.

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

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft