Description

Gets or sets a descriptive text for a hypertext link. An empty string indicates that the hypertext link 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 adds and configures a link to the product documentation by using HypertextLink.DescriptiveText.

HypertextLink hypertextLink = new("TX Text Control documentation", "https://docs.textcontrol.com/");
textControl.HypertextLinks.Add(hypertextLink);

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

Dim hypertextLink As New HypertextLink("TX Text Control documentation", "https://docs.textcontrol.com/")
textControl.HypertextLinks.Add(hypertextLink)

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