FrameworkElement.Height Property

Reference

Definition

Namespace:: Microsoft.UI.Xaml

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.

Edit

Gets or sets the suggested height of a FrameworkElement.

public:
 property double Height { double get(); void set(double value); };

double Height();

void Height(double value);

public double Height { get; set; }

var double = frameworkElement.height;
frameworkElement.height = double;

Public Property Height As Double

<frameworkElement Height="double"/>
-or-
<frameworkElement Height="Auto"/>

Property Value

Double

double

The height, in pixels, of the object. The default is NaN. Except for the special NaN value, this value must be equal to or greater than 0.

Examples

This example shows a simple property set of a UI element that is created at run time and needs initialization of its content and basic display properties such as Height and Width and Background. (Background is actually a Control property, not defined by FrameworkElement.)

Button button2 = new Button();
button2.Height = 50;
button2.Width = 100;
button2.Background = new SolidColorBrush(Colors.Blue);
button2.Content = "Click Me";

Remarks

Height is one of three writable properties on FrameworkElement that specify height information. The other two are MinHeight and MaxHeight. If there is a conflict between these values, the order of application for actual height determination is that first MinHeight must be honored, then MaxHeight, and finally, if it is within bounds, Height.

Several of the FrameworkElement derived types are also derived from Shape. Not all of the Shape classes use Height or Width to specify their appearance, and instead use specific properties that might define a set of points. In this case a Height or Width is calculated, but is not typically set directly.

Custom classes might have similar considerations where the class might have properties that are more meaningful for specifying dimensions than are Height or Width. Height or Width are both still available as members and are settable.

The object where the Height or Width properties are set is almost always a child object in another parent's child collection, and setting Height or Width to a value is only a suggested value for the layout process. The layout system as well as the particular layout logic of the parent's class will use the value as a nonbinding input during the layout process, and might have to clip, resize the object, resize the container, or some combination of these behaviors that spans multiple participating objects in layout. Margin and padding also influences the available size. For more info, see Alignment, margin, and padding.

The return value of this property is always the same as any value that was set to it. In contrast, the value of the ActualHeight property may vary. The variance can occur either statically, because the layout rejected the suggested size, or momentarily. The layout system itself works asynchronously relative to the property system's set of Height, and the layout system might not have processed that sizing property change yet.

Negative values for Height are not permitted.

Also, do not set Height to a value that is significantly larger than the maximum size of any possible visual display.

"Auto" and NaN

The default value of Height and Width is "Auto", represented by NaN. In XAML markup, you can use the string "Auto" to set the value to NaN.

Note

In C#, you can obtain NaN from Double.NaN.

In C++, you can obtain NaN by using the NAN macro or std::numeric_limits<double>::quiet_NaN().

Do not use the == operator to test for NaN.

In C#, use Double.IsNaN() to test for NaN.

In C++, use isnan() to test for NaN.

Applies to

Share via