Visual.GetVisualChild Method

.NET Framework 4.6 and 4.5

Returns the specified Visual in the parent VisualCollection.

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

Syntax

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.

Remarks

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.

Examples

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];
}

Visual.GetVisualChild Method

Syntax

Parameters

Return Value

Remarks

Examples

Version Information

.NET Framework

.NET Framework Client Profile

See Also

Reference