TdxCommonFormattedTextProperties.HyperlinkColor Property

Specifies the hyperlink color in formatted messages, labels, and UI element captions.

Declaration

property HyperlinkColor: TColor read; write; default clDefault;

Property Value

Type	Default	Description
TColor	clDefault	The hyperlink color.

Remarks

The hyperlink color depends on the active skin and palette. Use the HyperlinkColor property to assign a different color to all hyperlinks in a formatted message, label, or UI element caption.

Hyperlink Markup Syntax

Use the following BBCode-inspired markup syntax to define a hyperlink in a string assigned to a caption, label, or message:

BBCode

  [URL=https://www.devexpress.com]DevExpress[/URL]

Refer to the following topic for detailed information on all supported text formatting options: BBCode-Inspired Text Formatting Markup.

Hyperlink Activation

A hyperlink click opens the target in a new tab of the default system browser^[1] or opens the default email client^[2].

You can handle the OnHyperlinkClick event to execute custom code in response to a click on a hyperlink or prevent hyperlink activation depending on certain conditions.

Code Example: Add a Hyperlink to a Layout Item Caption

The following code example defines a layout item caption with custom formatting that includes a hyperlink:

Delphi

uses
  dxLayoutControl,    // Declares the TdxLayoutControl class
  dxLayoutContainer;  // Declares the TdxLayoutItem class
// ...

procedure TMyForm.FormCreate(Sender: TObject);
begin
  dxLayoutItem1.CaptionOptions.FormattedText.HyperlinkColor := clWebOrange;
  dxLayoutItem1.CaptionOptions.Text := 'Visit [B]our page[/B]: ' +
    '[URL=https://www.devexpress.com]DevExpress[/URL]';
end;

C++

#include "dxLayoutControl.hpp"    // Declares the TdxLayoutControl class
#include "dxLayoutContainer.hpp"  // Declares the TdxLayoutItem class

// Add the following linker directives to the corresponding CPP source file:
#pragma link "dxLayoutControl"    // Required to use dxLayoutControl.hpp declarations
#pragma link "dxLayoutContainer"  // Required to use dxLayoutContainer.hpp declarations
// ...

void __fastcall TMyForm::FormCreate(TObject *Sender)
{
  dxLayoutItem1->CaptionOptions->FormattedText->HyperlinkColor = clWebOrange;
  dxLayoutItem1->CaptionOptions->Text = "Visit [B]our page[/B]: " +
    "[URL=https://www.devexpress.com]DevExpress[/URL]";
}

Default Value

The HyperlinkColor property’s default value is clDefault.

The default HyperlinkColor value indicates that the hyperlink color depends on the current skin and palette settings.

Footnotes

1. A hyperlink click opens the target in the default browser if the hyperlink target uses the HTTPS or HTTP URI scheme.

2. A hyperlink click opens the default email client and creates a blank email message addressed to the specified email address if the hyperlink target uses the MAILTO URI scheme.