Back to Devexpress

EditBase.HelpText Property

maui-devexpress-dot-maui-dot-editors-dot-editbase-6b088d1e.md

latest3.7 KB
Original Source

EditBase.HelpText Property

Gets or sets the input prompt text displayed below the edit box. This is a bindable property.

Namespace : DevExpress.Maui.Editors

Assembly : DevExpress.Maui.Editors.dll

NuGet Package : DevExpress.Maui.Editors

Declaration

csharp
public string HelpText { get; set; }

Property Value

TypeDescription
String

The help text.

|

Remarks

You can display the following labels below an editor:

  • HelpText - A brief editor description.
  • ErrorText - A message shown when an error occurs (HasError is true ).

The BottomTextTopIndent property specifies the indent between the editor’s bottom border and the help or error text.

To specify the color and font attributes for the help/error text, use the following properties:

|

Property

|

Description

| | --- | --- | |

HelpTextColor
DisabledHelpTextColor

|

Specify the help text color for different states of an editor.

| |

ErrorColor

|

Specifies the error message text color.

| |

BottomTextFontSize
BottomTextFontFamily
BottomTextFontAttributes

|

Specify font settings.

|

If HelpText is not set, ErrorText appears as an additional line below the edit box and page content shifts down. To prevent this behavior, set the ReserveBottomTextLine property to true.

Example

This example shows how to customize the appearance of an editor’s help/error text:

|

State/Appearance

|

Default

|

Custom

| | --- | --- | --- | |

Default

|

|

| |

Disabled

|

|

| |

Error

|

|

|

xml
<dxe:TextEdit BottomTextFontAttributes="Bold"
              BottomTextFontSize="18"
              BottomTextTopIndent="20"
              HelpText="Bottom text"
              HelpTextColor="Green"
              DisabledHelpTextColor="LightGreen"
              ErrorColor="Brown"
              ErrorText="Error text"/>

See Also

EditBase Class

EditBase Members

DevExpress.Maui.Editors Namespace