This documentation is archived and is not being maintained.

VisualTreeHelper.GetChildrenCount Method

Returns the number of children that the specified visual object contains.

Namespace:  System.Windows.Media
Assembly:  PresentationCore (in PresentationCore.dll)

public static int GetChildrenCount(
	DependencyObject reference
)
You cannot use methods in XAML.

Parameters

reference
Type: System.Windows.DependencyObject

The parent visual that is referenced as a DependencyObject.

Return Value

Type: System.Int32
The number of child visuals that the parent visual contains.

Use the GetChild method to retrieve a specified child of a parent visual.

The value of reference can represent either a Visual or Visual3D object, which is why the common base type DependencyObject is used here as a parameter type.

The following example shows how to enumerate all the descendants of a visual object. This is a technique you might use if you are interested in serializing all the rendering information of a visual object hierarchy or are performing analysis or alternative rendering.

// Enumerate all the descendants of the visual object. 
static public void EnumVisual(Visual myVisual)
{
    for (int i = 0; i < VisualTreeHelper.GetChildrenCount(myVisual); i++)
    {
        // Retrieve child visual at specified index value.
        Visual childVisual = (Visual)VisualTreeHelper.GetChild(myVisual, i);

        // Do processing of the child visual object. 

        // Enumerate children of the child visual object.
        EnumVisual(childVisual);
    }
}

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0
Show: