Visual.GetVisualChild Method

Returns the specified Visual in the parent VisualCollection.

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

protected virtual Visual GetVisualChild(
	int index
)

Parameters

index
Type: System.Int32
The index of the visual object in the VisualCollection.

Return Value

Type: System.Windows.Media.Visual
The child in the VisualCollection at the specified index value.

By default, a Visual has no children. Therefore, the default implementation always throws an ArgumentOutOfRangeException.

Notes to Inheritors

A class that derives from Visual must override this method, and also the VisualChildrenCount property, for the visual tree to be enumerated correctly.

The following example defines an overridden implementation of GetVisualChild.


// Provide a required override for the GetVisualChild method.
protected override Visual GetVisualChild(int index)
{
    if (index < 0 || index >= _children.Count)
    {
        throw new ArgumentOutOfRangeException();
    }

    return _children[index];
}


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft