Canvas.GetZIndex Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Gets the value of the ZIndex attached property for a given object.

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

Syntax

'Declaration
Public Shared Function GetZIndex ( _
    element As UIElement _
) As Integer
public static int GetZIndex(
    UIElement element
)

Parameters

Return Value

Type: System.Int32
The ZIndex value of the requested object. The maximum allowed value for ZIndex is Int16.MaxValue – 1 = 32766.

Remarks

Objects with higher values for Canvas.ZIndex render on top of objects with a lower Canvas.ZIndex. The general effect of Canvas.ZIndex is to potentially override the default rendering order that is determined by the order of objects in a Canvas child collection.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

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

Platforms

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