/*                     ++++++++++++++++
                       +                                +
                       +       HYPERLINKS      +
                       +                                +
                       ++++++++++++++++

*/


// ======================================================================
// LINK DESCRIPTION
// Returns the description portion of a hyperlink text field
// The link must be in the format DESCRIPTION#URL
// ======================================================================
Function LinkDescription(Hyperlink as String) as String
     Return(Split(Hyperlink, "#"))
End Function // LinkDescription



// ======================================================================
// LINK URL
// Returns the full URL of a hyperlink text field
// The link must be in the format DESCRIPTION#URL
// ======================================================================
Function LinkURL(Hyperlink as String) as String
     var vJunk as String
     vJunk = Split(Hyperlink, "#")
     Return(Hyperlink)
End Function // LinkURL



// ======================================================================
// LINK PAGE URL
// Returns the full URL of a hyperlink text field without any anchor
// The link must be in the format DESCRIPTION#URL
// ======================================================================
Function LinkPageURL(Hyperlink as String) as String
     var vRetVal as String
     vRetVal = Split(Hyperlink, "#")      // Strip the Description
     vRetVal = Split(Hyperlink, "#")      // Take the URL up to the anchor
     Return(vRetVal)
End Function // LinkPageURL


// ======================================================================
// LINK ANCHOR
// Returns the anchor portion of a hyperlink text field
// The link must be in the format DESCRIPTION#URL
// ======================================================================
Function LinkAnchor(Hyperlink as String) as String
     var vJunk as String
     vJunk = Split(Hyperlink, "#")      // Leaves Hyperlink as full URL
     vJunk = Split(Hyperlink, "#")      // Leaves Hyperlink as the anchor portion or empty
     Return(Hyperlink)
End Function // LinkAnchor



// ======================================================================
// LINK DATA
// Returns parts of hyperlink text field
// The link must be in the format DESCRIPTION#URL
// Data returned is set by DataToReturn
//      0 = Return field contents (Description#full URL)
//      1 = Return description
//      2 = Return full URL (including any anchor
//      3 = Return full page URL without anchor
//      4 = Return anchor only      (useful when HTML has relative URLs)
// ======================================================================
Function LinkData(Hyperlink as String, DataToReturn as Int) as String
     var RetVal as String = ""

     If (DataToReturn < 0) or (DataToReturn) > 4 then RetVal = "PARAMETER OUT OF RANGE! MUST BE BETWEEN 0 AND 4"
     Else If DataToReturn = 0 then RetVal = Hyperlink                              // Return full field contents
     Else If DataToReturn = 1 then RetVal = LinkDescription(Hyperlink)      // Description only
     Else If DataToReturn = 2 then RetVal = LinkURL(Hyperlink)                  // Full URL
     Else If DataToReturn = 3 then RetVal = LinkPageURL(Hyperlink)            // Page URL without anchor
     Else RetVal = LinkAnchor(Hyperlink)                  // DataToReturn = 4            // Anchor only

     Return(RetVal)
End Function // LinkData