FrameworkElement.GetVisualChild(Int32) Method

Reference

Definition

Namespace:: System.Windows

Assembly:: PresentationFramework.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overrides GetVisualChild(Int32), and returns a child at the specified index from a collection of child elements.

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

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

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

Protected Overrides Function GetVisualChild (index As Integer) As Visual

Parameters

index: Int32

The zero-based index of the requested child element in the collection.

Returns

Visual

The requested child element. This should not return null; if the provided index is out of range, an exception is thrown.

Examples

The following example shows how a custom adorner uses the values declared by a VisualCollection that it maintains for its multiple visual children. These values are reported through overrides of VisualChildrenCount and GetVisualChild.

// To store and manage the adorner's visual children.
VisualCollection visualChildren;

' To store and manage the adorner's visual children.
Private visualChildren As VisualCollection

// Override the VisualChildrenCount and GetVisualChild properties to interface with 
// the adorner's visual collection.
protected override int VisualChildrenCount { get { return visualChildren.Count; } }
protected override Visual GetVisualChild(int index) { return visualChildren[index]; }

' Override the VisualChildrenCount and GetVisualChild properties to interface with 
' the adorner's visual collection.
Protected Overrides ReadOnly Property VisualChildrenCount() As Integer
    Get
        Return visualChildren.Count
    End Get
End Property
Protected Overrides Function GetVisualChild(ByVal index As Integer) As Visual
    Return visualChildren(index)
End Function

Remarks

In the FrameworkElement implementation, the only valid index is zero. The content model for GetVisualChild supports either zero or one child elements, not a collection.

Notes to Inheritors

This implementation is only valid for elements that do not maintain any more descriptive collection of visual child elements. Any element that does have such a collection must override this method and map the index to an equivalent index in the child element collection that is supported by that element. An index in the range from zero to VisualChildrenCount (minus one) should return a valid element; any other index should throw an out-of-range exception. An example of an element type that does support a child collection and overrides GetVisualChild(Int32) to return more than one possible child is Panel.

The default implementation in FrameworkElement presumes only one visual child. Any value passed for index other than zero causes an exception to be thrown. Several common elements, such as decorators, adorners, or elements with specialized rendering, override the FrameworkElement implementation (of the implementation from intermediate base classes). Some implementations still enforce one visual child whereas others allow a collection.

Applies to

Partajați prin