Visual.GetVisualChild(Int32) Method

Definition

Namespace:

System.Windows.Media

Assembly:

PresentationCore.dll

Returns the specified Visual in the parent VisualCollection.

protected:
 virtual System::Windows::Media::Visual ^ GetVisualChild(int index);

protected virtual System.Windows.Media.Visual GetVisualChild (int index);

abstract member GetVisualChild : int -> System.Windows.Media.Visual
override this.GetVisualChild : int -> System.Windows.Media.Visual

Protected Overridable Function GetVisualChild (index As Integer) As Visual

Parameters

index

Int32

The index of the visual object in the VisualCollection.

Returns

Visual

The child in the VisualCollection at the specified index value.

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

' Provide a required override for the GetVisualChild method.
Protected Overrides Function GetVisualChild(ByVal index As Integer) As Visual
    If index < 0 OrElse index >= _children.Count Then
        Throw New ArgumentOutOfRangeException()
    End If

    Return _children(index)
End Function

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.