VisualCollection.Add(Visual) Método

Definição

Namespace:

System.Windows.Media

Assembly:

PresentationCore.dll

Acrescenta um Visual ao final da 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

Parâmetros

visual

Visual

O Visual a acrescentar ao VisualCollection.

Retornos

Int32

O índice na coleção em que o visual foi adicionado.

Exceções

ArgumentException

Uma ArgumentException será gerada se o Visual for um elemento raiz.

Exemplos

O exemplo a seguir mostra como criar um VisualCollection e adicionar membros a ele.

// 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

Observação

Para obter o exemplo completo, consulte Teste de clique usando o exemplo DrawingVisuals.

Comentários

Adicionar um Visual cujo valor é null permitido e não gera uma exceção.

O Add método também configura a relação pai-filho entre o visual pai, que é o proprietário do VisualCollectione o filho visual.

Se você precisar de maior controle de baixo nível sobre a implementação de armazenamento subjacente de objetos filho visuais de uma classe personalizada, considere usar os AddVisualChild métodos e RemoveVisualChild . Ao usar esses métodos, você deve definir sua própria implementação de armazenamento e não usar VisualCollection.