FormField.HelpTextType Property

Gets or sets the type of 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

Declaration

• C#
• VB.NET

FormFieldTextType HelpTextType { get; set; }

Property HelpTextType As FormFieldTextType

Property Value

One of the FormFieldTextType enumeration values indicating the help text type.

|

Available values:

One of the AutoText gallery’s entries.

| | Custom |

Custom help text.

|

Remarks

The help text is defined by the FormField.HelpText property. When the HelpTextType property is set to FormFieldTextType.Auto, the help text should be equal to one of the AutoText gallery entries. Otherwise, the FormField.HelpText value is set to null 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 HelpTextType property is set to FormFieldTextType.Auto is opened on another machine, the FormField.HelpText value is set to null as well.

Use the FormField.StatusText to specify the help text shown in the status bar.

Note

RichEditControl cannot display this type of help text.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the HelpTextType 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.

• C#
• VB.NET

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/FormFields.cs#L22

checkBox.SizeMode = CheckBoxSizeMode.Auto;
checkBox.HelpTextType = FormFieldTextType.Custom;
checkBox.HelpText = "help text";

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/FormFieldsActions.cs#L20

checkBox.SizeMode = CheckBoxSizeMode.Auto;
checkBox.HelpTextType = FormFieldTextType.Custom;
checkBox.HelpText = "help text";

word-document-api-examples/CS/CodeExamples/FormFieldsActions.cs#L28

checkBox.SizeMode = CheckBoxSizeMode.Auto;
checkBox.HelpTextType = FormFieldTextType.Custom;
checkBox.HelpText = "help text";

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/FormFields.vb#L20

checkBox.SizeMode = DevExpress.XtraRichEdit.API.Native.CheckBoxSizeMode.Auto
checkBox.HelpTextType = DevExpress.XtraRichEdit.API.Native.FormFieldTextType.Custom
checkBox.HelpText = "help text"

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/FormFieldsActions.vb#L17

checkBox.SizeMode = CheckBoxSizeMode.Auto
checkBox.HelpTextType = FormFieldTextType.Custom
checkBox.HelpText = "help text"

word-document-api-examples/VB/CodeExamples/FormFieldsActions.vb#L25

checkBox.SizeMode = DevExpress.XtraRichEdit.API.Native.CheckBoxSizeMode.Auto
checkBox.HelpTextType = DevExpress.XtraRichEdit.API.Native.FormFieldTextType.Custom
checkBox.HelpText = "help text"

See Also

FormField Interface

FormField Members

DevExpress.XtraRichEdit.API.Native Namespace