Skip to main content
 
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.

Gets the number of visual child elements within this element.

Namespace:   System.Windows
Assembly:  PresentationFramework (in PresentationFramework.dll)

protected override int VisualChildrenCount { get; }
protected:
property int VisualChildrenCount {
	virtual int get() override;
}
override VisualChildrenCount : int with get
Protected Overrides ReadOnly Property VisualChildrenCount As Integer

Property Value

Type:

The number of visual child elements for this element.

The FrameworkElement implementation of always returns either zero or one. Classes that maintain a visual child collection that might exceed one must override both this property and GetVisualChild.

This property is generally used to determine the upper bounds of the current child collection for purposes of implementing the layout overrides ( MeasureOverride, ArrangeOverride).

Notes to Inheritors:

If your class supports more than one visual child in a child element collection, override this property to return the count of elements in that collection. You must do this even if the collection object itself returns a count. Element layout logic at the WPF framework level presumes that all elements will return a valid count through their property.

The following example shows how a custom adorner uses the values declared by a VisualCollection that it maintains for its multiple visual children and reports these values through overrides of 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
.NET Framework
Available since 3.0
Return to top