Description

Gets or sets a descriptive text for a form field. An empty string indicates that the form field has no such text. An empty string can also be used to delete a previously set text.

Syntax

public string DescriptiveText { get; set; }

Public Property DescriptiveText As String

Examples

The following example retrieves the form field at the current input position and inspects it by using FormField.DescriptiveText.

CheckFormField field = new(false) { Name = "AcceptTerms" };
textControl.FormFields.Add(field);
FormField formField = textControl.FormFields.GetItem();

formField.DescriptiveText = "Quarterly sales by region";
if (!string.IsNullOrWhiteSpace(formField.DescriptiveText))
{
    Console.WriteLine($"Descriptive Text: {formField.DescriptiveText}");
}

Dim field As New CheckFormField(False) With { .Name = "AcceptTerms" }
textControl.FormFields.Add(field)
Dim formField As FormField = textControl.FormFields.GetItem()

formField.DescriptiveText = "Quarterly sales by region"
If Not String.IsNullOrWhiteSpace(formField.DescriptiveText) Then
    Console.WriteLine($"Descriptive Text: {formField.DescriptiveText}")
End If