GridLength GridLength GridLength Struct

Represents a measurement for control logic that explicitly supports Star (*) sizing and Auto sizing.

Syntax

Declaration

public struct GridLengthpublic struct GridLengthPublic Structure GridLength
<object property="doubleValue"/>
- or -
<object property="starSizing"/>
-or-
<object property="Auto"/>

Remarks

Types such as ColumnDefinition and RowDefinition use GridLength values for some of their properties (Width and Height ). These property values are used to support variable distribution of available space in layout containers such as Grid (and also derived types of Grid such as VariableSizedWrapGrid ). A GridLength can describe one of three modes for sizing: a fixed width, a weighted distribution (star sizing), or an "Auto" sizing mode.

GridLength values are typically declared in XAML attribute syntax. In XAML, the weighted distribution is declared using a "" symbol, preceded by a number that declares the weighting factor to use for that GridLength. The weighted distribution option is also known as *star sizing.

The data values held by a GridLength (Value and GridUnitType ) are both read-only. If you want to change the value of a property that takes a GridLength at run time, you'll have to create a new value using one of the constructors and replace the previous value.

Star sizing

Star sizing is a convention whereby a GridLength has a number value that specifies a weighted factor versus other GridLength values. Any GridLength values that use star sizing divide the available space, accounting for the weighting factors, and evaluating after any fixed widths are applied. If none of the star sizings have weighting factors, the height or width is divided equally amongst them. The default weighting factor is 1.

This table provides some examples of star sizing results. For these examples, assume that the parent Grid has a fixed width of 600, and that there are three columns.

Column 0Column 1Column 2Result
100100100,100,400
100100,250,250
1004*100,100,400

In code, a star sizing is equivalent to a GridLength where IsStar is true, GridUnitType is GridUnitType, and Value is the weighted factor applied.

Noninteger weighting factors are permitted, for example ".5*".

Auto sizing

Auto sizing distributes space evenly based on the size of the content that is within a column or row. The exact logic for auto sizing is implemented by the control or class using the GridLength values. Typically that class is Grid, as it interprets its RowDefinition and ColumnDefinition components.

Notes on XAML syntax

Although you can specify a GridLength as an object element, you cannot specify the individual values such as Value as attributes of that object element. The XAML parser does not support setting XAML attribute values for this structure. Instead, you must specify the values as initialization text within the GridLength. For more info on XAML initialization text, see XAML syntax guide.

Projection and members of GridLength

If you are using a Microsoft .NET language (C# or Microsoft Visual Basic), or in Visual C++ component extensions (C++/CX), then GridLength has non-data members available, and its data members are exposed as read-only properties, not fields.

If you are programming with C++ using the Windows Runtime Template Library (WRL), then only the data member fields exist as members of GridLength, and you cannot use the utility methods or properties listed in the members table. WRL code can access similar utility methods that exist on the GridLengthHelper class, for example FromValueAndType(Double, GridUnitType).

Fields summary

A value of the GridUnitType enumeration that qualifies how Value is interpreted as a measure.

The measure for this GridLength, which is not necessarily a pixel measure.

Fields

  • GridUnitType
    GridUnitType
    GridUnitType
    GridUnitType

    A value of the GridUnitType enumeration that qualifies how Value is interpreted as a measure.

    public field GridUnitType GridUnitTypepublic field GridUnitType GridUnitTypePublic Field GridUnitTypepublic field GridUnitType GridUnitType
  • Value
    Value
    Value
    Value

    The measure for this GridLength, which is not necessarily a pixel measure.

    public field double Valuepublic field double ValuePublic Field Valuepublic field double Value

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.WebHostHiddenAttribute

Details

Assembly

Windows.UI.Xaml.dll