Package com.inet.report

Interface HyperlinkProperties

All Known Implementing Classes:
AbstractPictureElement, Box, Chart2, CrossTab, DatabasePicture, FieldElement, JavaBean, Picture, Text
public interface HyperlinkProperties
Interface for elements that supports links to external documents.

This class is part of the RDC.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getHyperlinkUrl()
    Returns the target URL of the hyperlink which is associated with this element.
    FormulaField
    getHyperlinkUrlFormula()
    Returns the formula of the property 'hyperlink url'.
    Use this property to specify an url of a web site, an e-mail address or the url of a html-file.
    void
    setHyperlinkUrl(String url)
    Sets the target location of a hyperlink which is associated with this element.
    This modify also the hyperlink type.
    void
    setHyperlinkUrlFormula(FormulaField newFormula)
    Sets the formula for the property 'hyperlink url'.
    Use this property to specify an url of a web site, an e-mail address or the url of a html-file.

  • Method Details

    • getHyperlinkUrlFormula

      FormulaField getHyperlinkUrlFormula()
      Returns the formula of the property 'hyperlink url'.
      Use this property to specify an url of a web site, an e-mail address or the url of a html-file. If formula is not empty a click on the element will open a webbrowser with the content of the web-site or the file, or an e-mail client will open.
      Returns:
      FormulaField The formula of the property 'hyperlink url'.
      Since:
      6.0

    • setHyperlinkUrlFormula

      void setHyperlinkUrlFormula(FormulaField newFormula)
      Sets the formula for the property 'hyperlink url'.
      Use this property to specify an url of a web site, an e-mail address or the url of a html-file. If formula is not empty a click on the element will open a webbrowser with the content of the web-site or the file, or an e-mail client will open.
      Parameters:
      newFormula - The new formula for the property 'hyperlink url'.
      Since:
      6.0

    • setHyperlinkUrl

      void setHyperlinkUrl(String url)
      Sets the target location of a hyperlink which is associated with this element.
      This modify also the hyperlink type.
      Parameters:
      url - A string which starts with one of the following protocol types (followed by the target):
      mailto:
      file:///
      http://
      or an empty string.
      Since:
      6.0

    • getHyperlinkUrl

      String getHyperlinkUrl()
      Returns the target URL of the hyperlink which is associated with this element.
      Returns:
      A string which starts with one of the following protocol types (followed by the target):
      mailto:
      file:///
      http://
      or an empty string.
      Since:
      6.0