VisualCollection.Insert(Int32, Visual) Method

Definition

Namespace:

System.Windows.Media

Assembly:

PresentationCore.dll

Inserts an element into the VisualCollection at the specified index.

public:
 void Insert(int index, System::Windows::Media::Visual ^ visual);

public void Insert (int index, System.Windows.Media.Visual visual);

member this.Insert : int * System.Windows.Media.Visual -> unit

Public Sub Insert (index As Integer, visual As Visual)

Parameters

index

Int32

The zero-based index at which the value should be inserted.

visual

Visual

The Visual to insert into the VisualCollection.

Exceptions

ArgumentOutOfRangeException

index is less than zero or greater than Count.

Remarks

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.