Description

Gets or sets a descriptive text for a document link. An empty string indicates that the document 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 creates an internal link to the customer-details destination by using DocumentLink.DescriptiveText.

DocumentTarget target = new("CustomerDetails");
textControl.DocumentTargets.Add(target);
DocumentLink documentLink = new("View customer details", target);
textControl.DocumentLinks.Add(documentLink);

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

Dim target As New DocumentTarget("CustomerDetails")
textControl.DocumentTargets.Add(target)
Dim documentLink As New DocumentLink("View customer details", target)
textControl.DocumentLinks.Add(documentLink)

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