C1.C1Preview.C1LinkTarget

C1LinkTarget Class

Describes the target of a C1Hyperlink. This is an abstract base class for the following derived classes: C1LinkTargetDocumentLocation, C1LinkTargetPage, C1LinkTargetAnchor, C1LinkTargetExternalAnchor, C1LinkTargetFile, C1LinkTargetUser.

Inheritance

object

C1LinkTarget

C1LinkTargetAnchor

C1LinkTargetDocumentLocation

C1LinkTargetFile

C1LinkTargetPage

C1LinkTargetUser

Namespace: C1.C1Preview

Assembly: C1.PrintDocument.8.dll

Syntax

[C1ClassSerialization(true)]
public abstract class C1LinkTarget

Constructors

Name	Description
C1LinkTarget()	Initializes a new instance of the C1LinkTarget class.

Properties

Name	Description
PdfURL	Gets the target URL in Adobe PDF format, or an empty string if it does not exist.
URL	Gets the target URL, or an empty string if it does not exist.

Methods

Name	Description
GetDocumentLocation(int, C1MultiDocument)	Returns the DocumentLocation pointed to by the current link target. This method may return null if the position cannot be resolved at this time (e.g. if the document has not generated yet) or the link target points to a position outside the document (e.g a URL or an external document).
GetDocumentLocation(int, C1PrintDocument)	Returns the DocumentLocation pointed to by the current link target. This method may return null if the position cannot be resolved at this time (e.g. if the document has not generated yet) or the link target points to a position outside the document (e.g a URL or an external document).
GetPageNo(C1Page, C1PrintDocument)	Gets the 1-based number of the page pointed to by the current C1LinkTarget. This method may return 0 if the page cannot be resolved at this time (e.g. the document has not generated yet).

Name

Description

GetDocumentLocation(int, C1MultiDocument)

Returns the DocumentLocation pointed to by the current link target.

This method may return null if the position cannot be resolved at this time (e.g. if the document has not generated yet) or the link target points to a position outside the document (e.g a URL or an external document).

GetDocumentLocation(int, C1PrintDocument)

Returns the DocumentLocation pointed to by the current link target.

GetPageNo(C1Page, C1PrintDocument)

Gets the 1-based number of the page pointed to by the current C1LinkTarget. This method may return 0 if the page cannot be resolved at this time (e.g. the document has not generated yet).