FrameworkElement.ArrangeOverride Method

May 11, 2014

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 virtual Size ArrangeOverride(
	Size finalSize
)

Parameters

finalSize
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 override Size ArrangeOverride(Size finalSize)
{
    // Get the collection of children
    UIElementCollection mychildren = Children;

    // Get total number of children
    int count = mychildren.Count;

    // Arrange children
    // We're only allowing 9 children in this panel.  More children will get a 0x0 layout slot.
    int i;
    for (i = 0; i < 9; i++)
    {

        // Get (left, top) origin point for the element in the 3x3 block
        Point cellOrigin = 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.
        double dw = mychildren[i].DesiredSize.Width;
        double dh = mychildren[i].DesiredSize.Height;

        mychildren[i].Arrange(new Rect(cellOrigin.X, cellOrigin.Y, dw, dh));

    }

    // Give the remaining children a 0x0 layout slot
    for (i = 9; i < count; i++)
    {
        mychildren[i].Arrange(new Rect(0, 0, 0, 0));
    }


    // Return final size of the panel
    return new Size(300, 300);
}

// Calculate point origin of the Block you are in
protected Point GetOrigin(int blockNum, int blocksPerRow, Size itemSize)
{
    // Get row number (zero-based)
    int row = (int)Math.Floor(blockNum / blocksPerRow);

    // Get column number (zero-based)
    int column = blockNum - blocksPerRow * row;

    // Calculate origin
    Point origin = new Point(itemSize.Width * column, itemSize.Height * row);
    return origin;

}


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2014 Microsoft