EditBase.HelpText Property

Specifies the input prompt text displayed below the edit box.

Namespace: DevExpress.XamarinForms.Editors

Assembly: DevExpress.XamarinForms.Editors.dll

NuGet Package: DevExpress.XamarinForms.Editors

Declaration

public string HelpText { get; set; }

Property Value

Type	Description
String	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

XAML

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