ArrangeOverride Method
Collapse the table of content
Expand the table of content

FrameworkElement.ArrangeOverride Method

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Provides the behavior for the Arrange pass of Windows Phone layout. Classes can override this method to define their own Arrange pass behavior.

Namespace:  System.Windows
Assembly:  System.Windows (in System.Windows.dll)

Protected Overridable Function ArrangeOverride ( _
	finalSize As Size _
) As Size


Type: System.Windows.Size
The final area within the parent that this object should use to arrange itself and its children.

Return Value

Type: System.Windows.Size
The actual size that is used after the element is arranged in layout.

This method has a default implementation that performs built-in layout for most Windows Phone FrameworkElement derived classes.

ArrangeOverride effectively provides additional implementation for Arrange, whenever that method is called either by internal layout logic or your application code. If you are producing a distributable content control, the ArrangeOverride logic defines your control's specific Arrange pass layout logic.

Notes to Inheritors

For Windows Phone, the technique by which elements are sized and positioned in a layout is divided into two steps: a Measure pass, and then an Arrange pass. This technique is explained in more detail in the topic Layout and panels for Windows Phone.

Control authors (or panel authors) who want to customize the Arrange pass of layout processing should override ArrangeOverride. The implementation pattern should call Arrange on each visible child object, and pass the final desired size for each child object as the finalRect parameter. Containers that contain visible child objects should call Arrange on each child object; otherwise, the child object is not rendered.

Several existing non-sealed Windows Phone classes provide override implementations of this method. Prominent ones include: StackPanel.ArrangeOverride and Grid.ArrangeOverride.

Typically, the behavior of ArrangeOverride produces a finalSize that does not violate any user-defined values that are placed on the layout container itself. For example, the finalSize is not typically larger than the container's Height and Width, accounting for Margin or Padding values that affect the content area. Controls that specifically have a scenario for exceeding the container size could return a larger value, but would have to account for the clipping and positioning issues that result from it.

The value that an ArrangeOverride implementation passes to Arrange for each child object is generally the value that is set in DesiredSize by the previous Measure pass on that object. However, this might vary depending on the specific layout functionality enabled by the container.

The following example implements ArrangeOverride to customize the Arrange pass logic for a custom panel implementation. Note in particular these aspects of the code:

  • Iterates over children.

  • For each child, calls Arrange, using a Rect where Height and Width are based on DesiredSize, and X and Y are based on logic that is specific to the panel.

  • Returns its size (in this case, this simple panel returns a fixed size rather than a size calculated on accumulating the arranged Rect value measurements).

'Second arrange all children and return final size of panel 
Protected Overloads Overrides Function ArrangeOverride(ByVal finalSize As Size) As Size
    'Get the collection of children 
    Dim mychildren As UIElementCollection = Children

    'Get total number of children 
    Dim count As Integer = mychildren.Count

    'Arrange children 
    'We're only allowing 9 children in this panel. More children will get a 0x0 layout slot. 
    Dim i As Integer
    For i = 0 To 8

        'Get (left, top) origin point for the element in the 3x3 block 
        Dim cellOrigin As Point = GetOrigin(i, 3, New Size(100, 100))

        'Arrange child 
        'Get desired height and width. This will not be larger than 100x100 as set in MeasureOverride. 
        Dim dw As Double = mychildren(i).DesiredSize.Width
        Dim dh As Double = mychildren(i).DesiredSize.Height

        mychildren(i).Arrange(New Rect(cellOrigin.X, cellOrigin.Y, dw, dh))
    For i = 9 To count - 1

        'Give the remaining children a 0x0 layout slot 
        mychildren(i).Arrange(New Rect(0, 0, 0, 0))

    'Return final size of the panel 
    Return New Size(300, 300)
End Function

'Calculate point origin of the Block you are in 
Protected Function GetOrigin(ByVal blockNum As Integer, ByVal blocksPerRow As Integer, ByVal itemSize As Size) As Point
    'Get row number (zero-based) 
    Dim row As Integer = CInt(Math.Floor(blockNum / blocksPerRow))

    'Get column number (zero-based) 
    Dim column As Integer = blockNum - blocksPerRow * row

    'Calculate origin 
    Dim origin As New Point(itemSize.Width * column, itemSize.Height * row)
    Return origin

End Function

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

© 2018 Microsoft