Skip to content

Latest commit

 

History

History
41 lines (24 loc) · 2.78 KB

frameworkelement_actualheight.md

File metadata and controls

41 lines (24 loc) · 2.78 KB
-api-id -api-type
P:Microsoft.UI.Xaml.FrameworkElement.ActualHeight
winrt property

Microsoft.UI.Xaml.FrameworkElement.ActualHeight

-description

Gets the rendered height of a FrameworkElement. See Remarks.

-property-value

The height, in pixels, of the object. The default is 0. The default might be encountered if the object has not been loaded and hasn't yet been involved in a layout pass that renders the UI.

-remarks

Note

Although it has an ActualHeightProperty backing field, ActualHeight does not raise property change notifications and it should be thought of as a regular CLR property and not a dependency property.

ActualHeight is a calculated property. The calculations are a result of a layout pass, where the object is sized in layout according to the logic of its successive layout parents. For more info see Define layouts with XAML.

ActualHeight can have multiple or incremental reported changes to the value because of operations by the layout system. If you get the value while layout is still iterating, the layout system might still be calculating the required measure of space for child objects, constraints by the parent object, and so on. Because the value is based on an actual rendering pass, it may lag slightly behind the set value of properties like Height, which can be the basis of the input change.

For purposes of ElementName binding, ActualHeight does not post updates when it changes (due to its asynchronous and run-time calculated nature). Do not attempt to use ActualHeight as a binding source for an ElementName binding. If you have a scenario that requires updates based on ActualHeight, use a SizeChanged handler.

-examples

This example shows a common scenario where you use the ActualHeight of one or more elements in UI to set the Height of either one of the involved elements or a different element, so that the same net height is maintained after the action. This is usually done in response to event handlers that are invoked when elements are opened or closed, or the display area changes.

[!code-cppFEActualHeight]

[!code-csharpFEActualHeight]

-see-also

ActualWidth, Height, SizeChanged