OpenPetra
Free Administration Software for Non-Profits
Ict.Common.THyperLinkHandling Class Reference

Class for HyperLink handling. Used by the 'TtxtLinkTextBox' and 'TRtbHyperlinks' Controls. More...

Public Types

enum  THyperLinkType {
  None , Http , Http_With_Value_Replacement , Ftp ,
  Email , Skype
}
 Types of Hyperlinks that TtxtLinkTextBox supports. More...
 

Static Public Member Functions

static THyperLinkType ParseHyperLinkType (string AHyperLinkType)
 Parses a string to a THyperLinkType. More...
 

Static Public Attributes

const string HYPERLINK_PREFIX_EMAILLINK = "||email||"
 Prefix for an Email Link. More...
 
const string HYPERLINK_PREFIX_URLLINK = "||hyperlink||"
 Prefix for a HTTP Link. More...
 
const string HYPERLINK_PREFIX_URLWITHVALUELINK = "||hyperlink_with_value||"
 Prefix for a HTTP Link where a part of that link gets constructed by supplying a value. More...
 
const string HYPERLINK_PREFIX_SECUREDURL = "||securehyperlink||"
 Prefix for a HTTPS Link. More...
 
const string HYPERLINK_PREFIX_FTPLINK = "||FTP||"
 Prefix for a FTP Link. More...
 
const string HYPERLINK_PREFIX_SKYPELINK = "||skype||"
 Prefix for a Skype Link. More...
 
const string HYPERLINK_WITH_VALUE_VALUE_PLACEHOLDER_IDENTIFIER = "{VALUE}"
 Identifier for a Value that will get replaced in a Link that is prefixed with HYPERLINK_PREFIX_URLWITHVALUELINK. More...
 

Detailed Description

Class for HyperLink handling. Used by the 'TtxtLinkTextBox' and 'TRtbHyperlinks' Controls.

Member Enumeration Documentation

◆ THyperLinkType

Types of Hyperlinks that TtxtLinkTextBox supports.

Enumerator
None 

Act as a regular TextBox

Http 

Act as a http:// or https:// hyperlink

Http_With_Value_Replacement 

Act as a http:// or https:// hyperlink where a part of the URL is replaced with a custom value.

Ftp 

Act as a ftp:// hyperlink

Email 

Act as a mailto: hyperlink

Skype 

Get the Skype.exe application to start a call to the supplied Skype ID

Member Function Documentation

◆ ParseHyperLinkType()

static THyperLinkType Ict.Common.THyperLinkHandling.ParseHyperLinkType ( string  AHyperLinkType)
inlinestatic

Parses a string to a THyperLinkType.

Parameters
AHyperLinkTypeString that should get parsed into a THyperLinkType.
Returns

Member Data Documentation

◆ HYPERLINK_PREFIX_EMAILLINK

const string Ict.Common.THyperLinkHandling.HYPERLINK_PREFIX_EMAILLINK = "||email||"
static

Prefix for an Email Link.

◆ HYPERLINK_PREFIX_FTPLINK

const string Ict.Common.THyperLinkHandling.HYPERLINK_PREFIX_FTPLINK = "||FTP||"
static

Prefix for a FTP Link.

◆ HYPERLINK_PREFIX_SECUREDURL

const string Ict.Common.THyperLinkHandling.HYPERLINK_PREFIX_SECUREDURL = "||securehyperlink||"
static

Prefix for a HTTPS Link.

◆ HYPERLINK_PREFIX_SKYPELINK

const string Ict.Common.THyperLinkHandling.HYPERLINK_PREFIX_SKYPELINK = "||skype||"
static

Prefix for a Skype Link.

◆ HYPERLINK_PREFIX_URLLINK

const string Ict.Common.THyperLinkHandling.HYPERLINK_PREFIX_URLLINK = "||hyperlink||"
static

Prefix for a HTTP Link.

◆ HYPERLINK_PREFIX_URLWITHVALUELINK

const string Ict.Common.THyperLinkHandling.HYPERLINK_PREFIX_URLWITHVALUELINK = "||hyperlink_with_value||"
static

Prefix for a HTTP Link where a part of that link gets constructed by supplying a value.

◆ HYPERLINK_WITH_VALUE_VALUE_PLACEHOLDER_IDENTIFIER

const string Ict.Common.THyperLinkHandling.HYPERLINK_WITH_VALUE_VALUE_PLACEHOLDER_IDENTIFIER = "{VALUE}"
static

Identifier for a Value that will get replaced in a Link that is prefixed with HYPERLINK_PREFIX_URLWITHVALUELINK.


The documentation for this class was generated from the following file: