TX Text Control .NET for Windows Forms

DocumentLinks Property

Property

Namespace: TXTextControl

Package: TXTextControl.TextControl.WinForms.SDK as TXTextControl.Windows.Forms.dll from the private NuGet feed or Text Control Offline Packages

Description

Gets a collection of all document links contained in the text part with the input focus. This can be the main text, a text frame or a header or footer. Document links point to targets in the same document. The property value is an object of the type DocumentLinkCollection.

Syntax

public DocumentLinkCollection DocumentLinks { get; }

Public ReadOnly Property DocumentLinks As DocumentLinkCollection

Examples

The following example iterates through the document links collection and processes each document link.

foreach (DocumentLink documentLink in textControl.DocumentLinks)
{
    documentLink.DescriptiveText = "Quarterly results";
}

For Each documentLink As DocumentLink In textControl.DocumentLinks
    documentLink.DescriptiveText = "Quarterly results"
Next

Limitations

Runtime only.

Read only.

See Also

Text Fields and Hypertext Links - Hypertext Links.