The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

FormField.HelpText Property

Gets or sets the instructional text shown when focusing the checkbox and pressing F1.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

string HelpText { get; set; }
Property HelpText As String
string HelpText { get; set; }
Property HelpText As String

Property Value

Type Description
String

A string value that is the help text.

Property Value

Type Description
String

A string value that is the help text.

Remarks

The help text is displayed when selecting the form field and pressing F1. When the FormField.HelpTextType property is set to FormFieldTextType.Custom, the property value should be equal to one of the AutoText gallery entries. Otherwise, the FormField.HelpText value is not displayed when opening it in another word processing tool.

The AutoText contents are not embedded to the document. When the document with the form field whose HelpText property is set to FormFieldTextType.Auto is opened on another machine, the FormField.HelpText value is set to null.

Use the FormField.StatusText property to specify the help text displayed on a status bar.

Note

RichEditControl cannot display this type of help text.

See Also