C1.C1Preview.C1LinkTarget.GetDocumentLocation

GetDocumentLocation Method

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).

Declaration

public DocumentLocation GetDocumentLocation(int currentPageIndex, C1PrintDocument document)

Parameters

Type	Name	Description
int	currentPageIndex	0-based index of the page containing the current link target. This is used for relative targets (such as previous page) and may be -1 if there is no current page in the current context, or the link target is absolute.
C1PrintDocument	document	The document containing the current link target.

Returns

Type	Description
DocumentLocation	The DocumentLocation containing the target location.

GetDocumentLocation(int, C1MultiDocument)

Returns the DocumentLocation pointed to by the current link target.

Declaration

public DocumentLocation GetDocumentLocation(int currentPageIndex, C1MultiDocument document)

Parameters

Type	Name	Description
int	currentPageIndex	0-based index of the page containing the current link target. This is used for relative targets (such as previous page) and may be -1 if there is no current page in the current context, or the link target is absolute.
C1MultiDocument	document	The document containing the current link target.

Returns

Type	Description
DocumentLocation	The DocumentLocation containing the target location.