Description

Gets a collection of all links in a header or footer which 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 creates a header for the first section and configures its content or layout by using HeaderFooter.DocumentLinks.

HeaderFooterCollection headers = textControl.Sections[1].HeadersAndFooters;
headers.Add(HeaderFooterType.Header);
HeaderFooter headerFooter = headers.GetItem(HeaderFooterType.Header);
headerFooter.Selection.Text = "Quarterly report";

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

Dim headers As HeaderFooterCollection = textControl.Sections(1).HeadersAndFooters
headers.Add(HeaderFooterType.Header)
Dim headerFooter As HeaderFooter = headers.GetItem(HeaderFooterType.Header)
headerFooter.Selection.Text = "Quarterly report"

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

Limitations

Read only.