Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Collapse]Reporting
 [Expand]Product Information
 [Expand]Getting Started
 [Expand]Fundamental Concepts
 [Collapse]Concepts
  [Expand]Report Types
  [Expand]Report Controls
  [Expand]Platform-Specific Reporting
  [Collapse]Creating Reports
   [Expand]Providing Data to Reports
   [Expand]Providing Data To Report Controls
   [Expand]Shaping Data
   [Expand]Using Report Parameters
   [Expand]Appearance Customization
   [Collapse]Navigation and Interaction
     Page Numbering
     Cross-References and Hyperlinks
     Bookmarks and Document Map
     Table of Contents
     Content Editing in Print Preview
     Print Preview Mouse Events
   [Expand]Scripting
  [Expand]Storing Reports
  [Expand]Publishing Reports
  [Expand]End-User Reporting
  [Expand]Application Appearance
  [Expand]Migration to XtraReports
 [Expand]Design-Time Features
 [Expand]Examples
  End-User Capabilities
 [Expand]Localization
 [Expand]Redistribution and Deployment
 [Expand]API Reference
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
[Expand]End-User Documentation

Cross-References and Hyperlinks

This document introduces the main concepts of cross-references and hyperlinks implementation in XtraReports.

Depending on whether the link's target is located within the same document or in another, there are two possible types of links:

Expanded Cross-References

A cross-reference means that a link's target is located within the current document. This allows you to establish easy navigation through a report.

To add a cross-reference to a report, for the required report control, set its XRControl.Target property to _self, to define that the link is targeted to the same document.

Then, set the XRControl.NavigateUrl property to the XRControl.Name property's value of the required target control.

Note that a control behaves as a link if its XRControl.NavigateUrl property is defined, which means that a cursor will automatically be changed to a "hand" in a report's preview, when hovering the control. Also, you can give a usual look to it (e.g. underlined text and blue color), by customizing a control's appropriate appearance properties.

A report's cross-references are preserved when a report is exported to PDF.

Note

Note that if there are multiple instances of an object marked as a link's target, the link will guide only to the first appearance of the object in a report.

A step-by-step tutorial on creating a cross-reference is available at How to: Add a Cross-Reference.

Expanded Hyperlinks

A hyperlink means that a target defined to a link is located outside the report. Note that you are not limited to using only web links, so that it is possible to define any type of source as a link's target.

To make any XRControl serve as a link, simply set its XRControl.NavigateUrl property to the required target document's URL. Note that an URL should be specified with the "http://" prefix to make the hyperlink work properly.

Note that a control behaves as a link if its XRControl.NavigateUrl property is defined, which means that a cursor will automatically be changed to a "hand" in a report's preview, when hovering the control. Also, you can give a usual look to it (e.g. underlined text and blue color), by customizing a control's appropriate appearance properties.

Also, you can specify where the target document should be opened (in the same preview window, in the new blank window, etc.) by customizing the link's XRControl.Target property.

Note

Note that when a report is exported to most of the available formats (notably PDF, HTML, MHT, RTF and Excel), a link's behavior is preserved.

A tutorial on how to create a hyperlink at runtime is available at How to: Add a Hyperlink.

Expanded See Also

How would you rate this topic?​​​​​​​