Usando objetos DrawingVisual

Artigo
01/30/2025

Este tópico fornece uma visão geral de como usar DrawingVisual objetos na camada visual do WPF.

Objeto DrawingVisual

O DrawingVisual é uma classe de desenho leve usada para renderizar formas, imagens ou texto. Essa classe é considerada leve porque não fornece layout ou manipulação de eventos, o que melhora seu desempenho. Por esse motivo, os desenhos são ideais para planos de fundo e clip-art.

Contêiner de host do DrawingVisual

Para usar DrawingVisual objetos, você precisa criar um contêiner de host para os objetos. O objeto de contêiner de host deve derivar da classe FrameworkElement, que fornece o suporte ao layout e ao tratamento de eventos que a classe DrawingVisual carece. O objeto do contêiner de host não exibe nenhuma propriedade visível, já que sua função principal é conter objetos filho. No entanto, a propriedade Visibility do contêiner de host precisa ser definida como Visible; caso contrário, nenhum de seus elementos filho ficará visível.

Ao criar um contêiner anfitrião para objetos visuais, você precisa armazenar as referências dos objetos visuais em um VisualCollection. Use o método Add para adicionar um objeto visual ao contêiner do host. No exemplo a seguir, um objeto de contêiner de host é criado e três objetos visuais são adicionados ao VisualCollection dele.

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

Nota

Para o exemplo de código completo do qual o exemplo de código anterior foi extraído, consulte Exemplo de teste de clique usando DrawingVisuals.

Criando objetos DrawingVisual

Quando você cria um objeto DrawingVisual, ele não tem conteúdo de desenho. Você pode adicionar texto, gráficos ou conteúdo de imagem recuperando o DrawingContext do objeto e desenhando nele. Um DrawingContext é retornado chamando o método RenderOpen de um objeto DrawingVisual.

Para desenhar um retângulo no DrawingContext, use o método DrawRectangle do objeto DrawingContext. Existem métodos semelhantes para desenhar outros tipos de conteúdo. Quando terminar de desenhar conteúdo no DrawingContext, chame o método Close para fechar o DrawingContext e persistir o conteúdo.

No exemplo a seguir, um objeto DrawingVisual é criado e um retângulo é desenhado em seu DrawingContext.

// Create a DrawingVisual that contains a rectangle.
private DrawingVisual CreateDrawingVisualRectangle()
{
    DrawingVisual drawingVisual = new DrawingVisual();

    // Retrieve the DrawingContext in order to create new drawing content.
    DrawingContext drawingContext = drawingVisual.RenderOpen();

    // Create a rectangle and draw it in the DrawingContext.
    Rect rect = new Rect(new System.Windows.Point(160, 100), new System.Windows.Size(320, 80));
    drawingContext.DrawRectangle(System.Windows.Media.Brushes.LightBlue, (System.Windows.Media.Pen)null, rect);

    // Persist the drawing content.
    drawingContext.Close();

    return drawingVisual;
}

' Create a DrawingVisual that contains a rectangle.
Private Function CreateDrawingVisualRectangle() As DrawingVisual
    Dim drawingVisual As New DrawingVisual()

    ' Retrieve the DrawingContext in order to create new drawing content.
    Dim drawingContext As DrawingContext = drawingVisual.RenderOpen()

    ' Create a rectangle and draw it in the DrawingContext.
    Dim rect As New Rect(New Point(160, 100), New Size(320, 80))
    drawingContext.DrawRectangle(Brushes.LightBlue, CType(Nothing, Pen), rect)

    ' Persist the drawing content.
    drawingContext.Close()

    Return drawingVisual
End Function

Criando substituições para membros FrameworkElement

O objeto de contêiner de host é responsável por gerenciar sua coleção de objetos visuais. Isso requer que o contêiner de host implemente substituições de membros para a classe FrameworkElement derivada.

A lista a seguir descreve os dois membros que você deve substituir:

GetVisualChild: retorna um filho no índice especificado da coleção de elementos filho.
VisualChildrenCount: obtém o número de elementos filho visuais dentro deste elemento.

No exemplo a seguir, as substituições para os dois membros FrameworkElement são implementadas.


// Provide a required override for the VisualChildrenCount property.
protected override int VisualChildrenCount
{
    get { return _children.Count; }
}

// Provide a required override for the GetVisualChild method.
protected override Visual GetVisualChild(int index)
{
    if (index < 0 || index >= _children.Count)
    {
        throw new ArgumentOutOfRangeException();
    }

    return _children[index];
}


' Provide a required override for the VisualChildrenCount property.
Protected Overrides ReadOnly Property VisualChildrenCount() As Integer
    Get
        Return _children.Count
    End Get
End Property

' Provide a required override for the GetVisualChild method.
Protected Overrides Function GetVisualChild(ByVal index As Integer) As Visual
    If index < 0 OrElse index >= _children.Count Then
        Throw New ArgumentOutOfRangeException()
    End If

    Return _children(index)
End Function

Fornecendo suporte a teste de clique

O objeto de contêiner de host pode fornecer tratamento de evento mesmo que não exiba nenhuma propriedade visível, no entanto, sua propriedade Visibility deve ser definida como Visible. Isso permite que você crie uma rotina de manipulação de evento para o contêiner de host que pode capturar eventos de mouse, como a liberação do botão esquerdo do mouse. A rotina de tratamento de eventos pode então implementar o teste de impacto invocando o método HitTest. O parâmetro HitTestResultCallback do método refere-se a um procedimento definido pelo usuário que você pode utilizar para determinar a ação resultante de um teste de colisão.

No exemplo a seguir, o suporte para teste de clique é implementado para o objeto do contêiner de host e seus filhos.

// Capture the mouse event and hit test the coordinate point value against
// the child visual objects.
void MyVisualHost_MouseLeftButtonUp(object sender, System.Windows.Input.MouseButtonEventArgs e)
{
    // Retrieve the coordinates of the mouse button event.
    System.Windows.Point pt = e.GetPosition((UIElement)sender);

    // Initiate the hit test by setting up a hit test result callback method.
    VisualTreeHelper.HitTest(this, null, new HitTestResultCallback(myCallback), new PointHitTestParameters(pt));
}

// If a child visual object is hit, toggle its opacity to visually indicate a hit.
public HitTestResultBehavior myCallback(HitTestResult result)
{
    if (result.VisualHit.GetType() == typeof(DrawingVisual))
    {
        if (((DrawingVisual)result.VisualHit).Opacity == 1.0)
        {
            ((DrawingVisual)result.VisualHit).Opacity = 0.4;
        }
        else
        {
            ((DrawingVisual)result.VisualHit).Opacity = 1.0;
        }
    }

    // Stop the hit test enumeration of objects in the visual tree.
    return HitTestResultBehavior.Stop;
}

' Capture the mouse event and hit test the coordinate point value against
' the child visual objects.
Private Sub MyVisualHost_MouseLeftButtonUp(ByVal sender As Object, ByVal e As MouseButtonEventArgs)
    ' Retrieve the coordinates of the mouse button event.
    Dim pt As Point = e.GetPosition(CType(sender, UIElement))

    ' Initiate the hit test by setting up a hit test result callback method.
    VisualTreeHelper.HitTest(Me, Nothing, New HitTestResultCallback(AddressOf myCallback), New PointHitTestParameters(pt))
End Sub

' If a child visual object is hit, toggle its opacity to visually indicate a hit.
Public Function myCallback(ByVal result As HitTestResult) As HitTestResultBehavior
    If result.VisualHit.GetType() Is GetType(DrawingVisual) Then
        If (CType(result.VisualHit, DrawingVisual)).Opacity = 1.0 Then
            CType(result.VisualHit, DrawingVisual).Opacity = 0.4
        Else
            CType(result.VisualHit, DrawingVisual).Opacity = 1.0
        End If
    End If

    ' Stop the hit test enumeration of objects in the visual tree.
    Return HitTestResultBehavior.Stop
End Function

Compartilhar via