Class Hyperlink

This class contains a hyperlink settings.

Inheritance
System.Object
Hyperlink
Namespace: FastReport
Assembly: FastReport.Base.dll
public class Hyperlink

Properties

Gets or sets the name of this report's page.

Declaration
public string DetailPageName { get; set; }
Property Value
Type Description
System.String

Use this property if Kind is set to DetailPage.

When you follow the hyperlink, the specified page will be executed. It may contain the detailed report. You also may specify the report's parameter in the ReportParameter property.

Gets or sets an external report file name.

Declaration
public string DetailReportName { get; set; }
Property Value
Type Description
System.String

Use this property if Kind is set to DetailReport.

When you follow the hyperlink, this report will be loaded and run. You also may specify the report's parameter in the ReportParameter property.

Gets or sets the expression which value will be used for navigation.

Declaration
public string Expression { get; set; }
Property Value
Type Description
System.String

Normally you should set the Expression property to any valid expression that will be calculated when this object is about to print. The value of an expression will be used for navigation.

If you want to navigate to some fixed data (URL or page number, for example), use the Value property instead.

Gets or sets the kind of hyperlink.

Declaration
public HyperlinkKind Kind { get; set; }
Property Value
Type Description
HyperlinkKind

Use the Kind property to define hyperlink's behavior. The hyperlink may be used to navigate to the external url, the page number, the bookmark defined by other report object, the external report, the other page of this report, and custom hyperlink.

Gets or sets a value that indicate should be links open in new tab or not.

Declaration
public bool OpenLinkInNewTab { get; set; }
Property Value
Type Description
System.Boolean

It works for HTML-export only!

Gets or sets a parameter's name that will be set to hyperlink's value.

Declaration
public string ReportParameter { get; set; }
Property Value
Type Description
System.String

Use this property if Kind is set to DetailReport or DetailPage.

If you want to pass the hyperlink's value to the report's parameter, specify the parameter name in this property. This parameter will be set to the hyperlink's value before running a report. It may be used to display detailed information about clicked item.

It is also possible to pass multiple values to several parameters. If hyperlink's value contains separators (the separator string can be set in the ValuesSeparator property), it will be splitted to several values. That values will be passed to nested parameters of the ReportParameter (you should create nested parameters by youself). For example, you have the ReportParameter called "SelectedValue" which has two nested parameters: the first one is "Employee" and the second is "Category". The hyperlink's value is "Andrew Fuller;Beverages". It will be splitted to two values: "Andrew Fuller" and "Beverages". The first nested parameter of the ReportParameter that is "Employee" in our case will be set to "Andrew Fuller"; the second nested parameter ("Category") will be set to "Beverages".

Note: when you create a parameter in the detailed report, don't forget to set its DataType property. It is used to convert string values to actual data type.

Gets or sets a value that will be used for navigation.

Declaration
public string Value { get; set; }
Property Value
Type Description
System.String

Use this property to specify the fixed data (such as URL, page number etc). If you want to navigate to some dynamically calculated value, use the Expression property instead.

Gets or sets a string that will be used as a separator to pass several values to the external report parameters.

Declaration
public string ValuesSeparator { get; set; }
Property Value
Type Description
System.String

Methods

Assign(Hyperlink)

Assigns values from another source.

Declaration
public void Assign(Hyperlink source)
Parameters
Type Name Description
Hyperlink source

Source to assign from.