com.crystaldecisions.sdk.plugin.desktop.common
Interface IReportHyperlink

public interface IReportHyperlink

This interface provides the support necessary to use the report hyperlink object within reports.

Nested Class Summary

static interface

IReportHyperlink.CeHyperlinkType Specifies the hyperlink type, used when retrieving a hyperlink for export.

Method Summary

java.lang.String	getHyperlinkString() Returns the hyperlink string.
int	getHyperlinkType() Returns the hyperlink type.
boolean	isFormula() Returns a boolean indicating whether the hyperlink is a formula.

Method Detail

getHyperlinkString

java.lang.String getHyperlinkString()
                                    throws SDKException

Returns the hyperlink string.

Returns:

A String containing the hyperlink.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getHyperlinkType

int getHyperlinkType()
                     throws SDKException

Returns the hyperlink type.

Returns:

A int containing the hyperlink type. this will be of type CeHyperlinkType

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IReportHyperlink.CeHyperlinkType

isFormula

boolean isFormula()
                  throws SDKException

Returns a boolean indicating whether the hyperlink is a formula.

Returns:

true if this hyperlink is a formula.

Throws:

SDKException - This is thrown if the process is unsuccessful.