SetLinks Method

Summary

Replaces the links of this page.

Syntax

C++

Java

public void SetLinks( 
   DocumentLink[] links 
)

Public Sub SetLinks( 
   ByVal links() As DocumentLink 
)

public:  
   void SetLinks( 
      array<DocumentLink^>^ links 
   )

public void setLinks(DocumentLink[] links)

Parameters

links

An array containing the new links for this page. A value of null is supported.

Remarks

GetLinks is used to get the links found in this page. All document types support this method however, the links are not read from the original document till DocumentStructure.IsParsed has been called.

SetLinks is used to replace the links of the page. IsLinksModified is used to as flag that indicates that the links of this page has been replaced by the user.

If this document uses the cache system (LEADDocument.HasCache is true), then the links are stored in the cache only when LEADDocument.SaveToCache is called.

The LEADTOOLS Document Viewer uses this method to obtain the links of a page uses an interactive modes to modify the mouse cursor when the user to hover over a link as well as invoking the link target when the user clicks on a link.

Refer to Loading Using LEADTOOLS Document Library for more information.

Example

For an example, refer to GetLinks.

Requirements

Target Platforms