VisualCollection.Add(Visual) Метод

Определение

Пространство имен:

System.Windows.Media

Сборка:

PresentationCore.dll

Добавляет объект Visual в конец VisualCollection.

public:
 int Add(System::Windows::Media::Visual ^ visual);

public int Add (System.Windows.Media.Visual visual);

member this.Add : System.Windows.Media.Visual -> int

Public Function Add (visual As Visual) As Integer

Параметры

visual

Visual

Объект Visual, добавляемый в коллекцию VisualCollection.

Возвращаемое значение

Int32

Индекс в коллекции, по которому был добавлен параметр visual.

Исключения

ArgumentException

Исключение ArgumentException выбрасывается, если Visual является корневым элементом.

Примеры

В следующем примере показано, как создать и VisualCollection добавить в него элементы.

// Create a host visual derived from the FrameworkElement class.
// This class provides layout, event handling, and container support for
// the child visual objects.
public class MyVisualHost : FrameworkElement
{
    // Create a collection of child visual objects.
    private VisualCollection _children;

    public MyVisualHost()
    {
        _children = new VisualCollection(this);
        _children.Add(CreateDrawingVisualRectangle());
        _children.Add(CreateDrawingVisualText());
        _children.Add(CreateDrawingVisualEllipses());

        // Add the event handler for MouseLeftButtonUp.
        this.MouseLeftButtonUp += new System.Windows.Input.MouseButtonEventHandler(MyVisualHost_MouseLeftButtonUp);
    }

' Create a host visual derived from the FrameworkElement class.
' This class provides layout, event handling, and container support for
' the child visual objects.
Public Class MyVisualHost
    Inherits FrameworkElement
    ' Create a collection of child visual objects.
    Private _children As VisualCollection

    Public Sub New()
        _children = New VisualCollection(Me)
        _children.Add(CreateDrawingVisualRectangle())
        _children.Add(CreateDrawingVisualText())
        _children.Add(CreateDrawingVisualEllipses())

        ' Add the event handler for MouseLeftButtonUp.
        AddHandler MouseLeftButtonUp, AddressOf MyVisualHost_MouseLeftButtonUp
    End Sub

Примечание

Полный пример см. в разделе "Тест попадания" с помощью примера DrawingVisuals.

Комментарии

Добавление значения Visual , значение null которого разрешено и не вызывает исключения.

Метод Add также настраивает связь "родитель-потомок" между родительским визуальным элементом, который является владельцем дочернего VisualCollectionэлемента и дочерним visualэлементом.

Если вам нужен более низкий уровень управления базовой реализацией хранилища визуальных дочерних объектов пользовательского класса, рассмотрите возможность использования AddVisualChild методов и RemoveVisualChild методов. При использовании этих методов необходимо определить собственную реализацию хранилища и не использовать VisualCollection.