WPF Canvas in VB.NET

In this article, you will learn how to use a WPF Canvas panel using XAML and VB.NET.
  • 5098

A Canvas panel is used to position child elements by using coordinates that are relative to the canvas area. Here are some of the properties of Canvas panels.

  • The default values of Height and Width properties of a Canvas are 0. If you do not set these values, you will not see a canvas unless child elements are automatically resizable.

  • Child elements on a Canvas are never resized.

  • The vertical and horizontal alignments on child elements do not work. Child elements are placed on positions set by the Canvas Left, Top, Right, and Bottom properties.

  • Margin does work partially. If Left property of Canvas is set, Right property does not work. If Top property of Canvas is set, Bottom property does not work.

 The Canvas element in XAML represents a Canvas control.  

 <Canvas/>

 The Canvas control has three properties.  The Left property represents the distance between the left side of a control and its parent container Canvas. The Top property represents the distance between the top of a control and its parent container Canvas.

The code in Listing 1 creates a Canvas and adds three Rectangle controls and position them using Canvas control properties.

 <Canvas Background="LightCyan" >
    <Rectangle
    Canvas.Left="10" Canvas.Top="10"
    Height="200" Width="200"

    Stroke="Black" StrokeThickness="10" Fill="Red" />

     <Rectangle
    Canvas.Left="60" Canvas.Top="60"
    Height="200" Width="200"

    Stroke="Black" StrokeThickness="10" Fill="Blue" />

     <Rectangle
    Canvas.Left="110" Canvas.Top="110"
    Height="200" Width="200"

    Stroke="Black" StrokeThickness="10" Fill="Green" />

</Canvas>

Listing 1

The output looks like Figure 1.

CanvasImg1.gif
 

Figure 1

The Canvas class in WPF represents a Canvas control.  The code listed in Listing creates a Canvas Panel dynamically, add three Rectangle controls to it, and sets their left and top positions using Canvas.SetLeft and Canvas.SetTop methods. The output of Listing generates Figure 1.

 Private Sub CreateDynamicCanvasPanel()
    ' Create a Canvas Panel control
    Dim canvasPanel As New Canvas()
    ' Set Canvas Panel properties
    canvasPanel.Background = New SolidColorBrush(Colors.LightCyan)

    ' Add Child Elements to Canvas
    Dim redRectangle As New Rectangle()
    redRectangle.Width = 200
    redRectangle.Height = 200
    redRectangle.Stroke = New SolidColorBrush(Colors.Black)
    redRectangle.StrokeThickness = 10
    redRectangle.Fill = New SolidColorBrush(Colors.Red)
    ' Set Canvas position
    Canvas.SetLeft(redRectangle, 10)
    Canvas.SetTop(redRectangle, 10)
    ' Add Rectangle to Canvas
    canvasPanel.Children.Add(redRectangle)

    ' Add Child Elements to Canvas
    Dim blueRectangle As New Rectangle()
    blueRectangle.Width = 200
    blueRectangle.Height = 200
    blueRectangle.Stroke = New SolidColorBrush(Colors.Black)
    blueRectangle.StrokeThickness = 10
    blueRectangle.Fill = New SolidColorBrush(Colors.Blue)
    ' Set Canvas position
    Canvas.SetLeft(blueRectangle, 60)
    Canvas.SetTop(blueRectangle, 60)
    ' Add Rectangle to Canvas
    canvasPanel.Children.Add(blueRectangle)

    ' Add Child Elements to Canvas
    Dim greenRectangle As New Rectangle()
    greenRectangle.Width = 200
    greenRectangle.Height = 200
    greenRectangle.Stroke = New SolidColorBrush(Colors.Black)
    greenRectangle.StrokeThickness = 10
    greenRectangle.Fill = New SolidColorBrush(Colors.Green)
    ' Set Canvas position
    Canvas.SetLeft(greenRectangle, 110)
    Canvas.SetTop(greenRectangle, 110)
    ' Add Rectangle to Canvas
    canvasPanel.Children.Add(greenRectangle)

    ' Set Grid Panel as content of the Window
    RootWindow.Content = canvasPanel
End Sub

Listing 1

The z-order of a control determines whether the control is in front of or behind another overlapping control. The default z-order of controls is the order controls are created in. The ZIndex property of Canvas represents the z-order of a control. The maximum value of ZIndex is 32766.

In Figure 1, the z-order of red, blue, and green rectangles is 1, 2, and 3 respectively. Now, the code in Listing 2 changes the z-order of these rectangles using the ZIndex property of the Canvas. 

The code snippet in Listing 2 sets the position of the Canvas control in the left top corner of the page.

<Canvas Background="LightCyan" >
    <Rectangle
    Canvas.Left="10" Canvas.Top="10"
    Height="200" Width="200"

    Stroke="Black" StrokeThickness="10"
        Fill="Red" Canvas.ZIndex="2" />

     <Rectangle
    Canvas.Left="60" Canvas.Top="60"
    Height="200" Width="200"

    Stroke="Black" StrokeThickness="10"
        Fill="Blue" Canvas.ZIndex="1" />

     <Rectangle
    Canvas.Left="110" Canvas.Top="110"
    Height="200" Width="200"

    Stroke="Black" StrokeThickness="10"
        Fill="Green" Canvas.ZIndex="3" />


</Canvas>

Listing 2

The new output looks like Figure 2 where blue rectangle is below red and green is at the top of both of them.

CanvasImg2.gif

Figure 2

Categories

More Articles

© 2019 DotNetHeaven. All rights reserved.