officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-formfield-53886817.md
Gets or sets the instructional text shown when focusing the checkbox and pressing F1.
Namespace : DevExpress.XtraRichEdit.API.Native
Assembly : DevExpress.RichEdit.v25.2.Core.dll
NuGet Package : DevExpress.RichEdit.Core
string HelpText { get; set; }
Property HelpText As String
| Type | Description |
|---|---|
| String |
A string value that is the help text.
|
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.
The following code snippets (auto-collected from DevExpress Examples) contain references to the HelpText property.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.
winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/FormFields.cs#L23
checkBox.HelpTextType = FormFieldTextType.Custom;
checkBox.HelpText = "help text";
currentPosition.EndUpdateDocument(currentDocument);
wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/FormFieldsActions.cs#L21
checkBox.HelpTextType = FormFieldTextType.Custom;
checkBox.HelpText = "help text";
#endregion #CreateCheckbox
word-document-api-examples/CS/CodeExamples/FormFieldsActions.cs#L29
checkBox.HelpTextType = FormFieldTextType.Custom;
checkBox.HelpText = "help text";
#endregion #InsertCheckbox
winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/FormFields.vb#L21
checkBox.HelpTextType = DevExpress.XtraRichEdit.API.Native.FormFieldTextType.Custom
checkBox.HelpText = "help text"
currentPosition.EndUpdateDocument(currentDocument)
wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/FormFieldsActions.vb#L18
checkBox.HelpTextType = FormFieldTextType.Custom
checkBox.HelpText = "help text"
' #End Region ' #CreateCheckbox
word-document-api-examples/VB/CodeExamples/FormFieldsActions.vb#L26
checkBox.HelpTextType = DevExpress.XtraRichEdit.API.Native.FormFieldTextType.Custom
checkBox.HelpText = "help text"
#End Region ' #InsertCheckbox
See Also