LinkLabel クラス

[アーティクル]
03/28/2008

ハイパーリンクを表示できる Windows ラベルコントロールを表します。

この型のすべてのメンバの一覧については、LinkLabel メンバを参照してください。

System.Object
   System.MarshalByRefObject
      System.ComponentModel.Component
         System.Windows.Forms.Control
            System.Windows.Forms.Label
               System.Windows.Forms.LinkLabel

Public Class LinkLabel
   Inherits Label
   Implements IButtonControl
[C#]
public class LinkLabel : Label, IButtonControl
[C++]
public __gc class LinkLabel : public Label, IButtonControl
[JScript]
public class LinkLabel extends Label implements IButtonControl

スレッドセーフ

この型の public static (Visual Basicでは Shared) のすべてのメンバは、マルチスレッド操作で安全に使用できます。インスタンスのメンバの場合は、スレッドセーフであるとは限りません。

解説

LinkLabel コントロールは、ハイパーリンクを表示できるという点を除き、 Label コントロールと似ています。このコントロールのテキストには、複数のハイパーリンクを指定できます。各ハイパーリンクを使用して、アプリケーション内で異なる操作を実行できます。たとえば、ハイパーリンクを使用して、Microsoft Internet Explorer で Web サイトを表示したり、アプリケーションに関連付けられているログファイルを読み込んだりできます。

LinkLabel コントロールに表示される各ハイパーリンクは、 LinkLabel.Link クラスのインスタンスです。 LinkLabel.Link クラスは、ハイパーリンクの表示に関する情報、状態、および位置を定義します。また、 LinkLabel.Link クラスの LinkData プロパティを使用すると、表示する URL などの情報をハイパーリンクに関連付けることができます。ユーザーがコントロール内のハイパーリンクをクリックすると、 LinkClicked イベントが発生し、クリックされたハイパーリンクを表す LinkLabel.Link オブジェクトが、イベントハンドラにパラメータとして渡される LinkLabelLinkClickedEventArgs オブジェクトの一部として渡されます。このオブジェクトを使用して、ユーザーがクリックしたハイパーリンクに関連付けられている LinkLabel.Link オブジェクトを取得できます。 LinkLabel コントロール内に含まれているすべてのハイパーリンクは、そのコントロールが格納されている LinkLabel.LinkCollection クラスのインスタンスに格納されます。

LinkLabel コントロールにハイパーリンクを追加するには 2 つの方法があります。最も簡単な方法は、 LinkArea オブジェクトを指定し、そのオブジェクトを LinkArea プロパティに割り当てる方法です。この方法では、コントロールのテキスト内に 1 つのハイパーリンクを指定できます。複数のハイパーリンクを追加するには、 Links プロパティを使用して LinkLabel.LinkCollection クラスにアクセスし、そのコレクションの Add メソッドを使用します。

LinkLabel コントロールを作成すると、 LinkLabel コントロールのテキスト全体を含む既定のハイパーリンクが LinkLabel.LinkCollection に追加されます。 LinkArea プロパティで新しいリンク領域を指定して、この既定のリンクをオーバーライドするか、 LinkLabel.LinkCollection の Add メソッドを使用してリンクを指定できます。既定のハイパーリンクは、 LinkLabel.LinkCollection クラスの Remove メソッドを使用して削除することもできます。

LinkLabel は、コントロール内のハイパーリンクの外観を定義するために使用できる多くのプロパティを提供します。 ActiveLinkColor 、 DisabledLinkColor 、 LinkColor 、 VisitedLinkColor の各プロパティは、さまざまな状態のハイパーリンクを表示するときに使用する色を定義します。 LinkBehavior プロパティは、ハイパーリンクに関連付けられている下線の表示方法を定義します。

使用例

[Visual Basic, C#, C++] 複数の LinkArea セクションが定義されている LinkLabel クラスを使用して、フォームにラベルを表示する例を次に示します。 AutoSize 、 LinkBehavior 、 DisabledLinkColor 、 LinkColor 、および VisitedLinkColor などの各プロパティを設定して LinkLabel の外観をカスタマイズする例を次に示します。最初の LinkArea は、 LinkLabel.LinkArea プロパティを使用して指定されます。追加のリンクは、 LinkCollection.Add メソッドを使用して LinkLabel に追加されます。この例では、 LinkClicked イベントを使用して、Web ブラウザを起動してハイパーリンクにアクセスし、その他のリンクを示す MessageBox を表示しています。

 
Imports System
Imports System.Drawing
Imports System.Windows.Forms

Public NotInheritable Class Form1
    Inherits System.Windows.Forms.Form

    Friend WithEvents LinkLabel1 As System.Windows.Forms.LinkLabel

    <System.STAThread()> _
    Public Shared Sub Main()
        System.Windows.Forms.Application.Run(New Form1)
    End Sub 'Main

    Public Sub New()
        MyBase.New()


        Me.LinkLabel1 = New System.Windows.Forms.LinkLabel

        ' Configure the LinkLabel's size and location. Specify that the
        ' size should be automatically determined by the content.
        Me.linkLabel1.Location = New System.Drawing.Point(34, 56) 
        Me.linkLabel1.Size = New System.Drawing.Size(224, 16) 
        Me.linkLabel1.AutoSize = True 

        ' Configure the appearance.
        ' Set the DisabledLinkColor so that a disabled link will show up against the form's background.
        Me.linkLabel1.DisabledLinkColor = System.Drawing.Color.Red 
        Me.linkLabel1.VisitedLinkColor = System.Drawing.Color.Blue 
        Me.linkLabel1.LinkBehavior = System.Windows.Forms.LinkBehavior.HoverUnderline 
        Me.linkLabel1.LinkColor = System.Drawing.Color.Navy 
        
        Me.linkLabel1.TabIndex = 0 
        Me.linkLabel1.TabStop = True 
        
        ' Identify what the first Link is.
        Me.linkLabel1.LinkArea = New System.Windows.Forms.LinkArea(0, 8)

        ' Identify that the first link is visited already.
        Me.linkLabel1.Links(0).Visited = true
        
        ' Set the Text property to a string.
        Me.linkLabel1.Text = "Register Online.  Visit Microsoft.  Visit MSN."

        ' Create new links using the Add method of the LinkCollection class.
        ' Underline the appropriate words in the LinkLabel's Text property.
        ' The words 'Register', 'Microsoft', and 'MSN' will 
        ' all be underlined and behave as hyperlinks.

        ' First check that the Text property is long enough to accommodate
        ' the desired hyperlinked areas.  If it's not, don't add hyperlinks.
        If Me.LinkLabel1.Text.Length >= 45 Then
            Me.LinkLabel1.Links(0).LinkData = "Register"
            Me.LinkLabel1.Links.Add(24, 9, "www.microsoft.com")
            Me.LinkLabel1.Links.Add(42, 3, "www.msn.com")
            ' The second link is disabled and will appear as red.
            Me.linkLabel1.Links(1).Enabled = False
        End If

        ' Set up how the form should be displayed and adds the controls to the form.
        Me.ClientSize = New System.Drawing.Size(292, 266)
        Me.Controls.AddRange(New System.Windows.Forms.Control() {Me.LinkLabel1})
        Me.Text = "Link Label Example"
    End Sub

    Private Sub linkLabel1_LinkClicked(ByVal sender As Object, _
                ByVal e As System.Windows.Forms.LinkLabelLinkClickedEventArgs) Handles LinkLabel1.LinkClicked

        ' Determine which link was clicked within the LinkLabel.
        Me.LinkLabel1.Links(LinkLabel1.Links.IndexOf(e.Link)).Visited = True

        ' Displays the appropriate link based on the value of the LinkData property of the Link object.
        Dim target As String = CType(e.Link.LinkData, String)

        ' If the value looks like a URL, navigate to it.
        ' Otherwise, display it in a message box.
        If (Nothing <> target) And (target.StartsWith("www")) Then
            System.Diagnostics.Process.Start(target)
        Else
            MessageBox.Show(("Item clicked: " + target))
        End If

    End Sub

End Class

[C#] 
using System;
using System.Drawing;
using System.Windows.Forms;

public class Form1 : System.Windows.Forms.Form
{
    private System.Windows.Forms.LinkLabel linkLabel1;
    
    [STAThread]
    static void Main() 
    {
        Application.Run(new Form1());
    }

    public Form1()
    {
        // Create the LinkLabel.
        this.linkLabel1 = new System.Windows.Forms.LinkLabel();

        // Configure the LinkLabel's size and location. Specify that the
        // size should be automatically determined by the content.
        this.linkLabel1.Location = new System.Drawing.Point(34, 56);
        this.linkLabel1.Size = new System.Drawing.Size(224, 16);
        this.linkLabel1.AutoSize = true;

        // Configure the appearance. 
        // Set the DisabledLinkColor so that a disabled link will show up against the form's background.
        this.linkLabel1.DisabledLinkColor = System.Drawing.Color.Red;
        this.linkLabel1.VisitedLinkColor = System.Drawing.Color.Blue;
        this.linkLabel1.LinkBehavior = System.Windows.Forms.LinkBehavior.HoverUnderline;
        this.linkLabel1.LinkColor = System.Drawing.Color.Navy;
        
        this.linkLabel1.TabIndex = 0;
        this.linkLabel1.TabStop = true;
        

        // Add an event handler to do something when the links are clicked.
        this.linkLabel1.LinkClicked += new System.Windows.Forms.LinkLabelLinkClickedEventHandler(this.linkLabel1_LinkClicked);

        // Identify what the first Link is.
        this.linkLabel1.LinkArea = new System.Windows.Forms.LinkArea(0, 8);

        // Identify that the first link is visited already.
        this.linkLabel1.Links[0].Visited = true;
        
        // Set the Text property to a string.
        this.linkLabel1.Text = "Register Online.  Visit Microsoft.  Visit MSN.";

        // Create new links using the Add method of the LinkCollection class.
        // Underline the appropriate words in the LinkLabel's Text property.
        // The words 'Register', 'Microsoft', and 'MSN' will 
        // all be underlined and behave as hyperlinks.

        // First check that the Text property is long enough to accommodate
        // the desired hyperlinked areas.  If it's not, don't add hyperlinks.
        if(this.linkLabel1.Text.Length >= 45)
        {
            this.linkLabel1.Links[0].LinkData = "Register";
            this.linkLabel1.Links.Add(24, 9, "www.microsoft.com");
            this.linkLabel1.Links.Add(42, 3, "www.msn.com");
        //  The second link is disabled and will appear as red.
            this.linkLabel1.Links[1].Enabled = false;
        }
        
        // Set up how the form should be displayed and add the controls to the form.
        this.ClientSize = new System.Drawing.Size(292, 266);
        this.Controls.AddRange(new System.Windows.Forms.Control[] {this.linkLabel1});
        this.Text = "Link Label Example";
    }

    private void linkLabel1_LinkClicked(object sender, System.Windows.Forms.LinkLabelLinkClickedEventArgs e)
    {
        // Determine which link was clicked within the LinkLabel.
        this.linkLabel1.Links[linkLabel1.Links.IndexOf(e.Link)].Visited = true;

        // Display the appropriate link based on the value of the 
        // LinkData property of the Link object.
        string target = e.Link.LinkData as string;

        // If the value looks like a URL, navigate to it.
        // Otherwise, display it in a message box.
        if(null != target && target.StartsWith("www"))
        {
            System.Diagnostics.Process.Start(target);
        }
        else
        {    
            MessageBox.Show("Item clicked: " + target);
        }
    }
}

[C++] 
#using <mscorlib.dll>
#using <System.dll>
#using <System.Windows.Forms.dll>
#using <System.Drawing.dll>

using namespace System;
using namespace System::Drawing;
using namespace System::Windows::Forms;

public __gc class Form1 : public System::Windows::Forms::Form {
private:
   System::Windows::Forms::LinkLabel*  linkLabel1;
public:
   Form1() {
      // Create the LinkLabel.
      this->linkLabel1 = new System::Windows::Forms::LinkLabel();

      // Configure the LinkLabel's size and location. Specify that the
      // size should be automatically determined by the content.
      this->linkLabel1->Location =  System::Drawing::Point(34, 56);
      this->linkLabel1->Size =  System::Drawing::Size(224, 16);
      this->linkLabel1->AutoSize = true;

      // Configure the appearance.
      this->linkLabel1->DisabledLinkColor = System::Drawing::Color::Red;
      this->linkLabel1->VisitedLinkColor = System::Drawing::Color::Blue;
      this->linkLabel1->LinkBehavior = System::Windows::Forms::LinkBehavior::HoverUnderline;
      this->linkLabel1->LinkColor = System::Drawing::Color::Navy;

      this->linkLabel1->TabIndex = 0;
      this->linkLabel1->TabStop = true;


      // Add an event handler to do something when the links are clicked.
      this->linkLabel1->LinkClicked += new System::Windows::Forms::LinkLabelLinkClickedEventHandler(this, &Form1::linkLabel1_LinkClicked);

      // Identify what the first Link is.
      this->linkLabel1->LinkArea =  System::Windows::Forms::LinkArea(0, 8);

      // Identify that the first link is visited already.
      this->linkLabel1->Links->Item[0]->Visited = true;

      // Set the Text property to a String*.
      this->linkLabel1->Text = S"Register Online.  Visit Microsoft.  Visit MSN.";

      // Create new links using the Add method of the LinkCollection class.
      // Underline the appropriate words in the LinkLabel's Text property.
      // The words 'Register', 'Microsoft', and 'MSN' will
      // all be underlined and behave as hyperlinks.

      // First check that the Text property is long enough to accommodate
      // the desired hyperlinked areas.  If it's not, don't add hyperlinks.
      if (this->linkLabel1->Text->Length >= 45) {
         this->linkLabel1->Links->Item[0]->LinkData = S"Register";
         this->linkLabel1->Links->Add(24, 9, S"www.microsoft.com");
         this->linkLabel1->Links->Add(42, 3, S"www.msn.com");
         this->linkLabel1->Links->Item[1]->Enabled = false;
      }

      // Set up how the form should be displayed and add the controls to the form.
      this->ClientSize =  System::Drawing::Size(292, 266);

      System::Windows::Forms::Control* temp0 [] = {this->linkLabel1};

      this->Controls->AddRange(temp0);
      this->Text = S"Link Label Example";
   }

private:
   void linkLabel1_LinkClicked(Object* /*sender*/, System::Windows::Forms::LinkLabelLinkClickedEventArgs* e) {
      // Determine which link was clicked within the LinkLabel.
      this->linkLabel1->Links->Item[linkLabel1->Links->IndexOf(e->Link)]->Visited = true;

      // Display the appropriate link based on the value of the
      // LinkData property of the Link Object*.
      String* target = dynamic_cast<String*>(e->Link->LinkData);

      // If the value looks like a URL, navigate to it.
      // Otherwise, display it in a message box.
      if (0 != target && target->StartsWith(S"www")) {
         System::Diagnostics::Process::Start(target);
      } else {
         MessageBox::Show(S"Item clicked: {0}", target);
      }
   }
};

[STAThread]
int main() {
   Application::Run(new Form1());
}

[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタボタンをクリックします。

必要条件

名前空間: System.Windows.Forms

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ

アセンブリ: System.Windows.Forms (System.Windows.Forms.dll 内)

参照

次の方法で共有

LinkLabel クラス

スレッドセーフ

解説

使用例

必要条件

参照

その他のリソース