Visual.GetVisualChild Method (Int32)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns the specified Visual in the parent VisualCollection.

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

Protected Overridable Function GetVisualChild (
	index As Integer
) As Visual

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 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

.NET Framework
Available since 3.0
Return to top
Show: