UIElement.Arrange(Rect) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Positions child elements and determines a size for a UIElement. Parent elements call this method from their ArrangeCore(Rect) implementation (or a WPF framework-level equivalent) to form a recursive layout update. This method constitutes the second pass of a layout update.
public:
void Arrange(System::Windows::Rect finalRect);public void Arrange (System.Windows.Rect finalRect);member this.Arrange : System.Windows.Rect -> unitPublic Sub Arrange (finalRect As Rect)Parameters
- finalRect
- Rect
The final size that the parent computes for the child element, provided as a Rect instance.
Remarks
For WPF framework-level element deriving scenarios, behavior for Arrange should not (and cannot, unless you shadow) be changed. Instead, you should override the ArrangeOverride implementation in your class. Your ArrangeOverride implementation is called internally by Arrange as part of default WPF framework-level layout operations. Your ArrangeCore implementation should also call ArrangeOverride on each child element, if it has child elements.
For WPF core-level element deriving scenarios, the behavior for Arrange should not (and cannot, unless you shadow) be changed. Instead, you should override ArrangeCore in your class. Your ArrangeCore implementation is called internally by Arrange as part of default WPF framework-level layout operations. However, this assumes you are using WPF framework-level layout and its layout system, which is often not the case if you are specifically deriving elements at the WPF core-level from the UIElement base element class. Your ArrangeCore implementation should also call Arrange on each child element, if it has child elements. Note that the WPF core-level scenario implies that you are not using a FrameworkElement derived class, because FrameworkElement seals ArrangeCore.
Computation of WPF framework-level layout positioning in Windows Presentation Foundation (WPF) consists of a Measure call and an Arrange call. During the Measure call, the layout system determines an element's size requirements using a provided Size (availableSize) argument. During the Arrange call, the layout system finalizes the size and position of an element's bounding box. For more information, see Layout.
availableSize can be any number from zero to infinity. Elements to be laid out return the minimum Size they require through the availableSize parameter.
When a layout is first instantiated, it always receives a Measure call before Arrange. However, after the first layout pass, it may receive an Arrange call without a Measure; this can happen when a property that affects only Arrange is changed (such as alignment), or when the parent receives an Arrange without a Measure. A Measure call will automatically invalidate an Arrange call.
Layout updates generally occur asynchronously (at a time determined by the layout system). An element might not immediately reflect changes to properties that affect element sizing (such as Width).
Note
Layout updates can be forced by using the UpdateLayout method; however, calling this function is not recommended, as it is usually unnecessary and can cause poor performance. In many situations where calling UpdateLayout might be appropriate, the layout system will probably already be processing updates. The layout system can process layout changes in a manner that can optimize all necessary updates as part of a package.
The layout system keeps two separate queues of invalid layouts, one for Measure and one for Arrange. The layout queue is sorted based upon the order of elements in the visual tree. Elements higher in the tree are at the top of the queue, in order to avoid redundant layouts caused by repeated changes in parents. Duplicate entries are automatically removed from the queue, and elements are automatically removed from the queue if they are already valid.
When updating layout, the Measure queue is emptied first, followed by the Arrange queue. An element in the Arrange queue will never be arranged if there is an element in the Measure queue.
