This documentation is archived and is not being maintained.

VisualCollection.Insert Method

Inserts an element into the VisualCollection at the specified index.

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

public void Insert(
	int index,
	Visual visual
)

Parameters

index
Type: System.Int32
The zero-based index at which the value should be inserted.
visual
Type: System.Windows.Media.Visual
The Visual to insert into the VisualCollection.

ExceptionCondition
ArgumentOutOfRangeException

index is less than zero or greater than Count.

If Count already equals Capacity, the capacity of the VisualCollection is increased before the new Visual is inserted. If index is equal to Count, visual is added to the end of VisualCollection. Any existing visual objects that are equal to or greater than index are shifted to accommodate the new Visual, and their index values are updated.

The Insert method also sets up the parent-child relationship between the parent visual, which is the owner of the VisualCollection, and the child visual.

If you need greater low-level control over the underlying storage implementation of visual child objects, consider using the AddVisualChild and RemoveVisualChild methods. When you use these methods, you define your own storage implementation, and do not use VisualCollection.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: