Removes the provided object from this element's logical tree. FrameworkElement updates the affected logical tree parent pointers to keep in sync with this deletion.
Assembly: PresentationFramework (in PresentationFramework.dll)
Use this method for the implementation of collections on objects that represent logical children of an element. This might be done in property getters or setters, class handlers of Changed events, constructors, or within the collection types themselves.
For control authors, manipulating the logical tree at this level is not the recommended practice, unless none of the provided base control class' content models are appropriate. Consider subclassing at the level of ContentControl, ItemsControl, and HeaderedItemsControl. These classes provide a content model with particular enforcement of logical children through dedicated APIs, as well as support for other features typically desirable in a WPF control such as styling through templates.
The following example implements a Child property on a custom FrameworkElement that does its own visual layer implementation. The property's setter is designed so that if the value changes, the old value is removed from the logical tree, as well as a class-specific visual collection. The values are cached, and then the new value is added to both the standard WPF framework level logical tree and the custom visual collection.
<System.ComponentModel.DefaultValue(GetType(Object), Nothing)> Public Overridable Property Child() As UIElement Get Return _child End Get Set(ByVal value As UIElement) If _child IsNot value Then 'need to remove old element from logical tree If _child IsNot Nothing Then OnDetachChild(_child) RemoveLogicalChild(_child) End If _vc.Clear() If value IsNot Nothing Then 'add to visual _vc.Add(value) 'add to logical AddLogicalChild(value) End If 'always add the overlay child back into the visual tree if its set If _overlayVisual IsNot Nothing Then _vc.Add(_overlayVisual) End If 'cache the new child _child = value 'notify derived types of the new child If value IsNot Nothing Then OnAttachChild(_child) End If InvalidateMeasure() End If End Set End Property