NumberBox.IsWrapEnabled Property

Definition

Namespace:

Microsoft.UI.Xaml.Controls

Gets or sets a value that indicates whether line breaking occurs when header text extends beyond the available width of the control.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

public:
 property bool IsWrapEnabled { bool get(); void set(bool value); };

/// [get: Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallback(enable=true)]
/// [get: Microsoft.UI.Xaml.CustomAttributes.MUXPropertyDefaultValue(value="false")]
/// [set: Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallback(enable=true)]
/// [set: Microsoft.UI.Xaml.CustomAttributes.MUXPropertyDefaultValue(value="false")]
bool IsWrapEnabled();

void IsWrapEnabled(bool value);

public bool IsWrapEnabled { [Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallback(enable=true)] [Microsoft.UI.Xaml.CustomAttributes.MUXPropertyDefaultValue(value="false")] get; [Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallback(enable=true)] [Microsoft.UI.Xaml.CustomAttributes.MUXPropertyDefaultValue(value="false")] set; }

Public Property IsWrapEnabled As Boolean

Property Value

Boolean

bool

true if line breaking occurs when header text extends beyond the available width of the control; otherwise, false. The default is false.

Remarks

This property affects only the Header text; it doesn't cause Description text to wrap.

If you need to wrap Description text, you can use a TextBlock as the Description property value and set it to wrap, like this.

xmlns:muxc="using:Microsoft.UI.Xaml.Controls"

<muxc:NumberBox Header="Header" Width="160">
    <muxc:NumberBox.Description>
        <TextBlock Text="This is a long description for NumberBox."
                   TextWrapping="WrapWholeWords"/>
    </muxc:NumberBox.Description>
</muxc:NumberBox>

See also

• Number box